Rust API client for ark-rest
Combined Ark Service, Indexer, Admin, Signer Manager, and Wallet API
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: 1.0.0
- Package version: 0.7.0
- Generator version: 7.14.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named ark-rest and add the following to Cargo.toml under [dependencies]:
ark-rest = { path = "./ark-rest" }
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ArkServiceApi | ark_service_confirm_registration | POST /v1/batch/ack | |
| ArkServiceApi | ark_service_delete_intent | POST /v1/batch/deleteIntent | |
| ArkServiceApi | ark_service_estimate_intent_fee | POST /v1/batch/estimateFee | |
| ArkServiceApi | ark_service_finalize_tx | POST /v1/tx/finalize | |
| ArkServiceApi | ark_service_get_event_stream | GET /v1/batch/events | |
| ArkServiceApi | ark_service_get_info | GET /v1/info | |
| ArkServiceApi | ark_service_get_pending_tx | POST /v1/tx/pending | |
| ArkServiceApi | ark_service_get_transactions_stream | GET /v1/txs | |
| ArkServiceApi | ark_service_register_intent | POST /v1/batch/registerIntent | |
| ArkServiceApi | ark_service_submit_signed_forfeit_txs | POST /v1/batch/submitForfeitTxs | |
| ArkServiceApi | ark_service_submit_tree_nonces | POST /v1/batch/tree/submitNonces | |
| ArkServiceApi | ark_service_submit_tree_signatures | POST /v1/batch/tree/submitSignatures | |
| ArkServiceApi | ark_service_submit_tx | POST /v1/tx/submit | |
| IndexerServiceApi | indexer_service_get_batch_sweep_transactions | GET /v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/sweepTxs | |
| IndexerServiceApi | indexer_service_get_commitment_tx | GET /v1/indexer/commitmentTx/{txid} | |
| IndexerServiceApi | indexer_service_get_connectors | GET /v1/indexer/commitmentTx/{txid}/connectors | |
| IndexerServiceApi | indexer_service_get_forfeit_txs | GET /v1/indexer/commitmentTx/{txid}/forfeitTxs | |
| IndexerServiceApi | indexer_service_get_subscription | GET /v1/indexer/script/subscription/{subscription_id} | |
| IndexerServiceApi | indexer_service_get_virtual_txs | GET /v1/indexer/virtualTx/{txids} | |
| IndexerServiceApi | indexer_service_get_vtxo_chain | GET /v1/indexer/vtxo/{outpoint.txid}/{outpoint.vout}/chain | |
| IndexerServiceApi | indexer_service_get_vtxo_tree | GET /v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/tree | |
| IndexerServiceApi | indexer_service_get_vtxo_tree_leaves | GET /v1/indexer/batch/{batch_outpoint.txid}/{batch_outpoint.vout}/tree/leaves | |
| IndexerServiceApi | indexer_service_get_vtxos | GET /v1/indexer/vtxos | |
| IndexerServiceApi | indexer_service_subscribe_for_scripts | POST /v1/indexer/script/subscribe | |
| IndexerServiceApi | indexer_service_unsubscribe_for_scripts | POST /v1/indexer/script/unsubscribe | |
| SignerManagerServiceApi | signer_manager_service_load_signer | POST /v1/admin/signer | |
| WalletInitializerServiceApi | wallet_initializer_service_create | POST /v1/admin/wallet/create | |
| WalletInitializerServiceApi | wallet_initializer_service_gen_seed | GET /v1/admin/wallet/seed | |
| WalletInitializerServiceApi | wallet_initializer_service_get_status | GET /v1/admin/wallet/status | |
| WalletInitializerServiceApi | wallet_initializer_service_restore | POST /v1/admin/wallet/restore | |
| WalletInitializerServiceApi | wallet_initializer_service_unlock | POST /v1/admin/wallet/unlock | |
| WalletServiceApi | wallet_service_derive_address | GET /v1/admin/wallet/address | |
| WalletServiceApi | wallet_service_get_balance | GET /v1/admin/wallet/balance | |
| WalletServiceApi | wallet_service_lock | POST /v1/admin/wallet/lock | |
| WalletServiceApi | wallet_service_withdraw | POST /v1/admin/wallet/withdraw |
Documentation For Models
- Any
- Balance
- BatchFailedEvent
- BatchFinalizationEvent
- BatchFinalizedEvent
- BatchStartedEvent
- ConfirmRegistrationRequest
- CreateRequest
- DeleteIntentRequest
- DeprecatedSigner
- DeriveAddressResponse
- ErrorDetails
- EstimateIntentFeeRequest
- EstimateIntentFeeResponse
- FeeInfo
- FinalizeTxRequest
- GenSeedResponse
- GetBalanceResponse
- GetBatchSweepTransactionsRequest
- GetBatchSweepTransactionsResponse
- GetCommitmentTxRequest
- GetCommitmentTxResponse
- GetConnectorsRequest
- GetConnectorsResponse
- GetEventStreamRequest
- GetEventStreamResponse
- GetForfeitTxsRequest
- GetForfeitTxsResponse
- GetInfoResponse
- GetPendingTxRequest
- GetPendingTxResponse
- GetStatusResponse
- GetSubscriptionRequest
- GetSubscriptionResponse
- GetTransactionsStreamResponse
- GetVirtualTxsRequest
- GetVirtualTxsResponse
- GetVtxoChainRequest
- GetVtxoChainResponse
- GetVtxoTreeLeavesRequest
- GetVtxoTreeLeavesResponse
- GetVtxoTreeRequest
- GetVtxoTreeResponse
- GetVtxosRequest
- GetVtxosResponse
- IndexerBatch
- IndexerChain
- IndexerChainedTxType
- IndexerNode
- IndexerOutpoint
- IndexerPageRequest
- IndexerPageResponse
- IndexerSubscriptionEvent
- IndexerTxData
- IndexerTxHistoryRecord
- IndexerTxType
- IndexerVtxo
- Input
- Intent
- IntentFeeInfo
- LoadSignerRequest
- Outpoint
- PendingTx
- RegisterIntentRequest
- RegisterIntentResponse
- RestoreRequest
- ScheduledSession
- Status
- SubmitSignedForfeitTxsRequest
- SubmitTreeNoncesRequest
- SubmitTreeSignaturesRequest
- SubmitTxRequest
- SubmitTxResponse
- SubscribeForScriptsRequest
- SubscribeForScriptsResponse
- Tapscripts
- TreeNoncesAggregatedEvent
- TreeNoncesEvent
- TreeSignatureEvent
- TreeSigningStartedEvent
- TreeTxEvent
- TxData
- TxNotification
- UnlockRequest
- UnsubscribeForScriptsRequest
- Vtxo
- WithdrawRequest
- WithdrawResponse
To get access to the crate's generated documentation, use:
cargo doc --open