Rust API client for openapi
API endpoint for algod operations.
For more information, please visit https://www.algorand.com/get-in-touch/contact
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 0.0.1
- Package version: 0.0.1
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CommonApi | get_genesis | GET /genesis | Gets the genesis information. |
| CommonApi | get_ready | GET /ready | Returns OK if healthy and fully caught up. |
| CommonApi | get_version | GET /versions | |
| CommonApi | health_check | GET /health | Returns OK if healthy. |
| CommonApi | metrics | GET /metrics | Return metrics about algod functioning. |
| CommonApi | swagger_json | GET /swagger.json | Gets the current swagger spec. |
| DataApi | get_ledger_state_delta | GET /v2/deltas/{round} | Get a LedgerStateDelta object for a given round |
| DataApi | get_sync_round | GET /v2/ledger/sync | Returns the minimum sync round the ledger is keeping in cache. |
| DataApi | set_sync_round | POST /v2/ledger/sync/{round} | Given a round, tells the ledger to keep that round in its cache. |
| DataApi | unset_sync_round | DELETE /v2/ledger/sync | Removes minimum sync round restriction from the ledger. |
| ExperimentalApi | experimental_check | GET /v2/experimental | Returns OK if experimental API is enabled. |
| ExperimentalApi | get_ledger_state_delta | GET /v2/deltas/{round} | Get a LedgerStateDelta object for a given round |
| NonparticipatingApi | abort_catchup | DELETE /v2/catchup/{catchpoint} | Aborts a catchpoint catchup. |
| NonparticipatingApi | account_application_information | GET /v2/accounts/{address}/applications/{application-id} | Get account information about a given app. |
| NonparticipatingApi | account_asset_information | GET /v2/accounts/{address}/assets/{asset-id} | Get account information about a given asset. |
| NonparticipatingApi | account_information | GET /v2/accounts/{address} | Get account information. |
| NonparticipatingApi | get_application_box_by_name | GET /v2/applications/{application-id}/box | Get box information for a given application. |
| NonparticipatingApi | get_application_boxes | GET /v2/applications/{application-id}/boxes | Get all box names for a given application. |
| NonparticipatingApi | get_application_by_id | GET /v2/applications/{application-id} | Get application information. |
| NonparticipatingApi | get_asset_by_id | GET /v2/assets/{asset-id} | Get asset information. |
| NonparticipatingApi | get_block | GET /v2/blocks/{round} | Get the block for the given round. |
| NonparticipatingApi | get_block_hash | GET /v2/blocks/{round}/hash | Get the block hash for the block on the given round. |
| NonparticipatingApi | get_light_block_header_proof | GET /v2/blocks/{round}/lightheader/proof | Gets a proof for a given light block header inside a state proof commitment |
| NonparticipatingApi | get_state_proof | GET /v2/stateproofs/{round} | Get a state proof that covers a given round |
| NonparticipatingApi | get_status | GET /v2/status | Gets the current node status. |
| NonparticipatingApi | get_supply | GET /v2/ledger/supply | Get the current supply reported by the ledger. |
| NonparticipatingApi | get_transaction_proof | GET /v2/blocks/{round}/transactions/{txid}/proof | Get a proof for a transaction in a block. |
| NonparticipatingApi | shutdown_node | POST /v2/shutdown | |
| NonparticipatingApi | simulate_transaction | POST /v2/transactions/simulate | Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round. |
| NonparticipatingApi | start_catchup | POST /v2/catchup/{catchpoint} | Starts a catchpoint catchup. |
| NonparticipatingApi | teal_compile | POST /v2/teal/compile | Compile TEAL source code to binary, produce its hash |
| NonparticipatingApi | teal_disassemble | POST /v2/teal/disassemble | Disassemble program bytes into the TEAL source code. |
| NonparticipatingApi | teal_dryrun | POST /v2/teal/dryrun | Provide debugging information for a transaction (or group). |
| NonparticipatingApi | transaction_params | GET /v2/transactions/params | Get parameters for constructing a new transaction |
| NonparticipatingApi | wait_for_block | GET /v2/status/wait-for-block-after/{round} | Gets the node status after waiting for a round after the given round. |
| ParticipatingApi | add_participation_key | POST /v2/participation | Add a participation key to the node |
| ParticipatingApi | append_keys | POST /v2/participation/{participation-id} | Append state proof keys to a participation key |
| ParticipatingApi | delete_participation_key_by_id | DELETE /v2/participation/{participation-id} | Delete a given participation key by ID |
| ParticipatingApi | get_participation_key_by_id | GET /v2/participation/{participation-id} | Get participation key info given a participation ID |
| ParticipatingApi | get_participation_keys | GET /v2/participation | Return a list of participation keys |
| ParticipatingApi | get_pending_transactions | GET /v2/transactions/pending | Get a list of unconfirmed transactions currently in the transaction pool. |
| ParticipatingApi | get_pending_transactions_by_address | GET /v2/accounts/{address}/transactions/pending | Get a list of unconfirmed transactions currently in the transaction pool by address. |
| ParticipatingApi | pending_transaction_information | GET /v2/transactions/pending/{txid} | Get a specific pending transaction. |
| ParticipatingApi | raw_transaction | POST /v2/transactions | Broadcasts a raw transaction or transaction group to the network. |
| PrivateApi | abort_catchup | DELETE /v2/catchup/{catchpoint} | Aborts a catchpoint catchup. |
| PrivateApi | add_participation_key | POST /v2/participation | Add a participation key to the node |
| PrivateApi | append_keys | POST /v2/participation/{participation-id} | Append state proof keys to a participation key |
| PrivateApi | delete_participation_key_by_id | DELETE /v2/participation/{participation-id} | Delete a given participation key by ID |
| PrivateApi | get_participation_key_by_id | GET /v2/participation/{participation-id} | Get participation key info given a participation ID |
| PrivateApi | get_participation_keys | GET /v2/participation | Return a list of participation keys |
| PrivateApi | shutdown_node | POST /v2/shutdown | |
| PrivateApi | start_catchup | POST /v2/catchup/{catchpoint} | Starts a catchpoint catchup. |
| PublicApi | account_application_information | GET /v2/accounts/{address}/applications/{application-id} | Get account information about a given app. |
| PublicApi | account_asset_information | GET /v2/accounts/{address}/assets/{asset-id} | Get account information about a given asset. |
| PublicApi | account_information | GET /v2/accounts/{address} | Get account information. |
| PublicApi | experimental_check | GET /v2/experimental | Returns OK if experimental API is enabled. |
| PublicApi | get_application_box_by_name | GET /v2/applications/{application-id}/box | Get box information for a given application. |
| PublicApi | get_application_boxes | GET /v2/applications/{application-id}/boxes | Get all box names for a given application. |
| PublicApi | get_application_by_id | GET /v2/applications/{application-id} | Get application information. |
| PublicApi | get_asset_by_id | GET /v2/assets/{asset-id} | Get asset information. |
| PublicApi | get_block | GET /v2/blocks/{round} | Get the block for the given round. |
| PublicApi | get_block_hash | GET /v2/blocks/{round}/hash | Get the block hash for the block on the given round. |
| PublicApi | get_genesis | GET /genesis | Gets the genesis information. |
| PublicApi | get_ledger_state_delta | GET /v2/deltas/{round} | Get a LedgerStateDelta object for a given round |
| PublicApi | get_light_block_header_proof | GET /v2/blocks/{round}/lightheader/proof | Gets a proof for a given light block header inside a state proof commitment |
| PublicApi | get_pending_transactions | GET /v2/transactions/pending | Get a list of unconfirmed transactions currently in the transaction pool. |
| PublicApi | get_pending_transactions_by_address | GET /v2/accounts/{address}/transactions/pending | Get a list of unconfirmed transactions currently in the transaction pool by address. |
| PublicApi | get_ready | GET /ready | Returns OK if healthy and fully caught up. |
| PublicApi | get_state_proof | GET /v2/stateproofs/{round} | Get a state proof that covers a given round |
| PublicApi | get_status | GET /v2/status | Gets the current node status. |
| PublicApi | get_supply | GET /v2/ledger/supply | Get the current supply reported by the ledger. |
| PublicApi | get_sync_round | GET /v2/ledger/sync | Returns the minimum sync round the ledger is keeping in cache. |
| PublicApi | get_transaction_proof | GET /v2/blocks/{round}/transactions/{txid}/proof | Get a proof for a transaction in a block. |
| PublicApi | get_version | GET /versions | |
| PublicApi | health_check | GET /health | Returns OK if healthy. |
| PublicApi | metrics | GET /metrics | Return metrics about algod functioning. |
| PublicApi | pending_transaction_information | GET /v2/transactions/pending/{txid} | Get a specific pending transaction. |
| PublicApi | raw_transaction | POST /v2/transactions | Broadcasts a raw transaction or transaction group to the network. |
| PublicApi | set_sync_round | POST /v2/ledger/sync/{round} | Given a round, tells the ledger to keep that round in its cache. |
| PublicApi | simulate_transaction | POST /v2/transactions/simulate | Simulates a raw transaction or transaction group as it would be evaluated on the network. The simulation will use blockchain state from the latest committed round. |
| PublicApi | swagger_json | GET /swagger.json | Gets the current swagger spec. |
| PublicApi | teal_compile | POST /v2/teal/compile | Compile TEAL source code to binary, produce its hash |
| PublicApi | teal_disassemble | POST /v2/teal/disassemble | Disassemble program bytes into the TEAL source code. |
| PublicApi | teal_dryrun | POST /v2/teal/dryrun | Provide debugging information for a transaction (or group). |
| PublicApi | transaction_params | GET /v2/transactions/params | Get parameters for constructing a new transaction |
| PublicApi | unset_sync_round | DELETE /v2/ledger/sync | Removes minimum sync round restriction from the ledger. |
| PublicApi | wait_for_block | GET /v2/status/wait-for-block-after/{round} | Gets the node status after waiting for a round after the given round. |
Documentation For Models
The model structs live in the algonaut_model::algod module, not in this
crate (ADR relocate-generated-models): algonaut_algod keeps only the api /
transport code and depends on algonaut_model for the wire models. The
synthesized <op>200Response envelopes are renamed to intentional names there
(e.g. SubmitResponse, BlockHash, CompiledTeal, SuggestedParams).
To get access to the crate's generated documentation, use:
cargo doc --open