Skip to content

talekhinezh/rust-node-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
.idea
.idea
 
 
src
src
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.travis.yml
.travis.yml
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 

Repository files navigation

Rust API client for openapi

This API is exposed by the Babylon Radix node to give clients access to the Radix Engine, Mempool and State in the node.

The default configuration is intended for use by node-runners on a private network, and is not intended to be exposed publicly. Very heavy load may impact the node's function. The node exposes a configuration flag which allows disabling certain endpoints which may be problematic, but monitoring is advised. This configuration parameter is api.core.flags.enable_unbounded_endpoints / RADIXDLT_CORE_API_FLAGS_ENABLE_UNBOUNDED_ENDPOINTS.

This API exposes queries against the node's current state (see /lts/state/ or /state/), and streams of transaction history (under /lts/stream/ or /stream).

If you require queries against snapshots of historical ledger state, you may also wish to consider using the Gateway API.

Integration and forward compatibility guarantees

Integrators (such as exchanges) are recommended to use the /lts/ endpoints - they have been designed to be clear and simple for integrators wishing to create and monitor transactions involving fungible transfers to/from accounts.

All endpoints under /lts/ have high guarantees of forward compatibility in future node versions. We may add new fields, but existing fields will not be changed. Assuming the integrating code uses a permissive JSON parser which ignores unknown fields, any additions will not affect existing code.

Other endpoints may be changed with new node versions carrying protocol-updates, although any breaking changes will be flagged clearly in the corresponding release notes.

All responses may have additional fields added, so clients are advised to use JSON parsers which ignore unknown fields on JSON objects.

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: v1.2.3
  • Package version: v1.2.3
  • Generator version: 7.9.0
  • 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:3333/core

Class Method HTTP request Description
LtsApi lts_state_account_all_fungible_resource_balances_post POST /lts/state/account-all-fungible-resource-balances Get All Account Balances
LtsApi lts_state_account_deposit_behaviour_post POST /lts/state/account-deposit-behaviour Get Account Deposit Behaviour
LtsApi lts_state_account_fungible_resource_balance_post POST /lts/state/account-fungible-resource-balance Get Single Account Balance
LtsApi lts_stream_account_transaction_outcomes_post POST /lts/stream/account-transaction-outcomes Get Account Transaction Outcomes
LtsApi lts_stream_transaction_outcomes_post POST /lts/stream/transaction-outcomes Get Transaction Outcomes
LtsApi lts_transaction_construction_post POST /lts/transaction/construction Get Construction Metadata
LtsApi lts_transaction_status_post POST /lts/transaction/status Get Transaction Status
LtsApi lts_transaction_submit_post POST /lts/transaction/submit Submit Transaction
MempoolApi mempool_list_post POST /mempool/list Get Mempool List
MempoolApi mempool_transaction_post POST /mempool/transaction Get Mempool Transaction
StateApi state_access_controller_post POST /state/access-controller Get Access Controller Details
StateApi state_account_post POST /state/account Get Account Details
StateApi state_component_post POST /state/component Get Component Details
StateApi state_consensus_manager_post POST /state/consensus-manager Get Consensus Manager Details
StateApi state_non_fungible_post POST /state/non-fungible Get Non-Fungible Details
StateApi state_package_post POST /state/package Get Package Details
StateApi state_resource_post POST /state/resource Get Resource Details
StateApi state_validator_post POST /state/validator Get Validator Details
StatusApi status_network_configuration_post POST /status/network-configuration Get Network Configuration
StatusApi status_network_status_post POST /status/network-status Get Network Status
StatusApi status_scenarios_post POST /status/scenarios Get Scenarios' results.
StreamApi stream_proofs_post POST /stream/proofs Stream Proofs
StreamApi stream_transactions_post POST /stream/transactions Get Committed Transactions
TransactionApi transaction_call_preview_post POST /transaction/call-preview Scrypto Call Preview
TransactionApi transaction_parse_post POST /transaction/parse Parse Transaction Payload
TransactionApi transaction_preview_post POST /transaction/preview Transaction Preview
TransactionApi transaction_receipt_post POST /transaction/receipt Get Transaction Receipt
TransactionApi transaction_status_post POST /transaction/status Get Transaction Status
TransactionApi transaction_submit_post POST /transaction/submit Transaction Submit

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages