aptos-client-icp 0.0.1

The Aptos Node API is a RESTful API for client applications to interact with the Aptos blockchain.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

# Rust API client for aptos-client on Internet Computer

The Aptos Node API is a RESTful API for client applications to interact with the Aptos blockchain.

For more information, please visit [https://github.com/aptos-labs/aptos-core](https://github.com/aptos-labs/aptos-core)

## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 1.2.0
- Package version: 1.2.0
- Generator version: 7.9.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `aptos-client-icp` and add the following to `Cargo.toml` under `[dependencies]`:

```
aptos-client-icp = { path = "./aptos-client-icp" }
```

## Documentation for API Endpoints

All URIs are relative to */v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{address} | Get account
*AccountsApi* | [**get_account_module**](docs/AccountsApi.md#get_account_module) | **GET** /accounts/{address}/module/{module_name} | Get account module
*AccountsApi* | [**get_account_modules**](docs/AccountsApi.md#get_account_modules) | **GET** /accounts/{address}/modules | Get account modules
*AccountsApi* | [**get_account_resource**](docs/AccountsApi.md#get_account_resource) | **GET** /accounts/{address}/resource/{resource_type} | Get account resource
*AccountsApi* | [**get_account_resources**](docs/AccountsApi.md#get_account_resources) | **GET** /accounts/{address}/resources | Get account resources
*BlocksApi* | [**get_block_by_height**](docs/BlocksApi.md#get_block_by_height) | **GET** /blocks/by_height/{block_height} | Get blocks by height
*BlocksApi* | [**get_block_by_version**](docs/BlocksApi.md#get_block_by_version) | **GET** /blocks/by_version/{version} | Get blocks by version
*EventsApi* | [**get_events_by_creation_number**](docs/EventsApi.md#get_events_by_creation_number) | **GET** /accounts/{address}/events/{creation_number} | Get events by creation number
*EventsApi* | [**get_events_by_event_handle**](docs/EventsApi.md#get_events_by_event_handle) | **GET** /accounts/{address}/events/{event_handle}/{field_name} | Get events by event handle
*GeneralApi* | [**get_ledger_info**](docs/GeneralApi.md#get_ledger_info) | **GET** / | Get ledger info
*GeneralApi* | [**healthy**](docs/GeneralApi.md#healthy) | **GET** /-/healthy | Check basic node health
*GeneralApi* | [**info**](docs/GeneralApi.md#info) | **GET** /info | Show some basic info of the node.
*GeneralApi* | [**spec**](docs/GeneralApi.md#spec) | **GET** /spec | Show OpenAPI explorer
*TablesApi* | [**get_raw_table_item**](docs/TablesApi.md#get_raw_table_item) | **POST** /tables/{table_handle}/raw_item | Get raw table item
*TablesApi* | [**get_table_item**](docs/TablesApi.md#get_table_item) | **POST** /tables/{table_handle}/item | Get table item
*TransactionsApi* | [**encode_submission**](docs/TransactionsApi.md#encode_submission) | **POST** /transactions/encode_submission | Encode submission
*TransactionsApi* | [**estimate_gas_price**](docs/TransactionsApi.md#estimate_gas_price) | **GET** /estimate_gas_price | Estimate gas price
*TransactionsApi* | [**get_account_transactions**](docs/TransactionsApi.md#get_account_transactions) | **GET** /accounts/{address}/transactions | Get account transactions
*TransactionsApi* | [**get_transaction_by_hash**](docs/TransactionsApi.md#get_transaction_by_hash) | **GET** /transactions/by_hash/{txn_hash} | Get transaction by hash
*TransactionsApi* | [**get_transaction_by_version**](docs/TransactionsApi.md#get_transaction_by_version) | **GET** /transactions/by_version/{txn_version} | Get transaction by version
*TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /transactions | Get transactions
*TransactionsApi* | [**simulate_transaction**](docs/TransactionsApi.md#simulate_transaction) | **POST** /transactions/simulate | Simulate transaction
*TransactionsApi* | [**submit_batch_transactions**](docs/TransactionsApi.md#submit_batch_transactions) | **POST** /transactions/batch | Submit batch transactions
*TransactionsApi* | [**submit_transaction**](docs/TransactionsApi.md#submit_transaction) | **POST** /transactions | Submit transaction
*TransactionsApi* | [**wait_transaction_by_hash**](docs/TransactionsApi.md#wait_transaction_by_hash) | **GET** /transactions/wait_by_hash/{txn_hash} | Wait for transaction by hash
*ViewApi* | [**view**](docs/ViewApi.md#view) | **POST** /view | Execute view function of a module


## Documentation For Models

 - [AccountData](docs/AccountData.md)
 - [AccountSignature](docs/AccountSignature.md)
 - [AccountSignatureEd25519Signature](docs/AccountSignatureEd25519Signature.md)
 - [AccountSignatureMultiEd25519Signature](docs/AccountSignatureMultiEd25519Signature.md)
 - [AccountSignatureMultiKeySignature](docs/AccountSignatureMultiKeySignature.md)
 - [AccountSignatureNoAccountSignature](docs/AccountSignatureNoAccountSignature.md)
 - [AccountSignatureSingleKeySignature](docs/AccountSignatureSingleKeySignature.md)
 - [AptosError](docs/AptosError.md)
 - [AptosErrorCode](docs/AptosErrorCode.md)
 - [Block](docs/Block.md)
 - [BlockEndInfo](docs/BlockEndInfo.md)
 - [BlockEpilogueTransaction](docs/BlockEpilogueTransaction.md)
 - [BlockMetadataExtension](docs/BlockMetadataExtension.md)
 - [BlockMetadataExtensionBlockMetadataExtensionEmpty](docs/BlockMetadataExtensionBlockMetadataExtensionEmpty.md)
 - [BlockMetadataExtensionBlockMetadataExtensionRandomness](docs/BlockMetadataExtensionBlockMetadataExtensionRandomness.md)
 - [BlockMetadataExtensionRandomness](docs/BlockMetadataExtensionRandomness.md)
 - [BlockMetadataTransaction](docs/BlockMetadataTransaction.md)
 - [BlockMetadataTransactionBlockMetadataExtension](docs/BlockMetadataTransactionBlockMetadataExtension.md)
 - [DecodedTableData](docs/DecodedTableData.md)
 - [DeleteModule](docs/DeleteModule.md)
 - [DeleteResource](docs/DeleteResource.md)
 - [DeleteTableItem](docs/DeleteTableItem.md)
 - [DeletedTableData](docs/DeletedTableData.md)
 - [DirectWriteSet](docs/DirectWriteSet.md)
 - [DkgResultTransaction](docs/DkgResultTransaction.md)
 - [Ed25519](docs/Ed25519.md)
 - [Ed25519Signature](docs/Ed25519Signature.md)
 - [EncodeSubmissionRequest](docs/EncodeSubmissionRequest.md)
 - [EntryFunctionPayload](docs/EntryFunctionPayload.md)
 - [Event](docs/Event.md)
 - [EventGuid](docs/EventGuid.md)
 - [ExportedAggregateSignature](docs/ExportedAggregateSignature.md)
 - [ExportedDkgTranscript](docs/ExportedDkgTranscript.md)
 - [ExportedProviderJwks](docs/ExportedProviderJwks.md)
 - [ExportedQuorumCertifiedUpdate](docs/ExportedQuorumCertifiedUpdate.md)
 - [FederatedKeyless](docs/FederatedKeyless.md)
 - [FeePayerSignature](docs/FeePayerSignature.md)
 - [FeePayerSignatureFeePayerSigner](docs/FeePayerSignatureFeePayerSigner.md)
 - [GasEstimation](docs/GasEstimation.md)
 - [GenesisPayload](docs/GenesisPayload.md)
 - [GenesisPayloadWriteSetPayload](docs/GenesisPayloadWriteSetPayload.md)
 - [GenesisTransaction](docs/GenesisTransaction.md)
 - [HealthCheckSuccess](docs/HealthCheckSuccess.md)
 - [IndexResponse](docs/IndexResponse.md)
 - [IndexedSignature](docs/IndexedSignature.md)
 - [Jwk](docs/Jwk.md)
 - [JwkUpdateTransaction](docs/JwkUpdateTransaction.md)
 - [Keyless](docs/Keyless.md)
 - [MoveFunction](docs/MoveFunction.md)
 - [MoveFunctionGenericTypeParam](docs/MoveFunctionGenericTypeParam.md)
 - [MoveFunctionVisibility](docs/MoveFunctionVisibility.md)
 - [MoveModule](docs/MoveModule.md)
 - [MoveModuleBytecode](docs/MoveModuleBytecode.md)
 - [MoveResource](docs/MoveResource.md)
 - [MoveScriptBytecode](docs/MoveScriptBytecode.md)
 - [MoveStruct](docs/MoveStruct.md)
 - [MoveStructField](docs/MoveStructField.md)
 - [MoveStructGenericTypeParam](docs/MoveStructGenericTypeParam.md)
 - [MoveValue](docs/MoveValue.md)
 - [MultiAgentSignature](docs/MultiAgentSignature.md)
 - [MultiEd25519Signature](docs/MultiEd25519Signature.md)
 - [MultiKeySignature](docs/MultiKeySignature.md)
 - [MultisigPayload](docs/MultisigPayload.md)
 - [MultisigTransactionPayload](docs/MultisigTransactionPayload.md)
 - [MultisigTransactionPayloadEntryFunctionPayload](docs/MultisigTransactionPayloadEntryFunctionPayload.md)
 - [PendingTransaction](docs/PendingTransaction.md)
 - [PublicKey](docs/PublicKey.md)
 - [PublicKeyEd25519](docs/PublicKeyEd25519.md)
 - [PublicKeyFederatedKeyless](docs/PublicKeyFederatedKeyless.md)
 - [PublicKeyKeyless](docs/PublicKeyKeyless.md)
 - [PublicKeySecp256k1Ecdsa](docs/PublicKeySecp256k1Ecdsa.md)
 - [PublicKeySecp256r1Ecdsa](docs/PublicKeySecp256r1Ecdsa.md)
 - [RawTableItemRequest](docs/RawTableItemRequest.md)
 - [RoleType](docs/RoleType.md)
 - [RsaJwk](docs/RsaJwk.md)
 - [ScriptPayload](docs/ScriptPayload.md)
 - [ScriptWriteSet](docs/ScriptWriteSet.md)
 - [Secp256k1Ecdsa](docs/Secp256k1Ecdsa.md)
 - [Secp256r1Ecdsa](docs/Secp256r1Ecdsa.md)
 - [Signature](docs/Signature.md)
 - [SignatureEd25519](docs/SignatureEd25519.md)
 - [SignatureKeyless](docs/SignatureKeyless.md)
 - [SignatureSecp256k1Ecdsa](docs/SignatureSecp256k1Ecdsa.md)
 - [SignatureWebAuthn](docs/SignatureWebAuthn.md)
 - [SingleKeySignature](docs/SingleKeySignature.md)
 - [StateCheckpointTransaction](docs/StateCheckpointTransaction.md)
 - [SubmitTransactionRequest](docs/SubmitTransactionRequest.md)
 - [TableItemRequest](docs/TableItemRequest.md)
 - [Transaction](docs/Transaction.md)
 - [TransactionBlockEpilogueTransaction](docs/TransactionBlockEpilogueTransaction.md)
 - [TransactionBlockMetadataTransaction](docs/TransactionBlockMetadataTransaction.md)
 - [TransactionGenesisTransaction](docs/TransactionGenesisTransaction.md)
 - [TransactionPayload](docs/TransactionPayload.md)
 - [TransactionPayloadDeprecatedModuleBundlePayload](docs/TransactionPayloadDeprecatedModuleBundlePayload.md)
 - [TransactionPayloadEntryFunctionPayload](docs/TransactionPayloadEntryFunctionPayload.md)
 - [TransactionPayloadMultisigPayload](docs/TransactionPayloadMultisigPayload.md)
 - [TransactionPayloadScriptPayload](docs/TransactionPayloadScriptPayload.md)
 - [TransactionPendingTransaction](docs/TransactionPendingTransaction.md)
 - [TransactionSignature](docs/TransactionSignature.md)
 - [TransactionSignatureAccountSignature](docs/TransactionSignatureAccountSignature.md)
 - [TransactionSignatureEd25519Signature](docs/TransactionSignatureEd25519Signature.md)
 - [TransactionSignatureFeePayerSignature](docs/TransactionSignatureFeePayerSignature.md)
 - [TransactionSignatureMultiAgentSignature](docs/TransactionSignatureMultiAgentSignature.md)
 - [TransactionSignatureMultiEd25519Signature](docs/TransactionSignatureMultiEd25519Signature.md)
 - [TransactionStateCheckpointTransaction](docs/TransactionStateCheckpointTransaction.md)
 - [TransactionUserTransaction](docs/TransactionUserTransaction.md)
 - [TransactionValidatorTransaction](docs/TransactionValidatorTransaction.md)
 - [TransactionsBatchSingleSubmissionFailure](docs/TransactionsBatchSingleSubmissionFailure.md)
 - [TransactionsBatchSubmissionResult](docs/TransactionsBatchSubmissionResult.md)
 - [UnsupportedJwk](docs/UnsupportedJwk.md)
 - [UserTransaction](docs/UserTransaction.md)
 - [ValidatorTransaction](docs/ValidatorTransaction.md)
 - [ValidatorTransactionDkgResultTransaction](docs/ValidatorTransactionDkgResultTransaction.md)
 - [ValidatorTransactionJwkUpdateTransaction](docs/ValidatorTransactionJwkUpdateTransaction.md)
 - [VersionedEvent](docs/VersionedEvent.md)
 - [ViewRequest](docs/ViewRequest.md)
 - [WebAuthn](docs/WebAuthn.md)
 - [WriteModule](docs/WriteModule.md)
 - [WriteResource](docs/WriteResource.md)
 - [WriteSet](docs/WriteSet.md)
 - [WriteSetChange](docs/WriteSetChange.md)
 - [WriteSetChangeDeleteModule](docs/WriteSetChangeDeleteModule.md)
 - [WriteSetChangeDeleteResource](docs/WriteSetChangeDeleteResource.md)
 - [WriteSetChangeDeleteTableItem](docs/WriteSetChangeDeleteTableItem.md)
 - [WriteSetChangeWriteModule](docs/WriteSetChangeWriteModule.md)
 - [WriteSetChangeWriteResource](docs/WriteSetChangeWriteResource.md)
 - [WriteSetChangeWriteTableItem](docs/WriteSetChangeWriteTableItem.md)
 - [WriteSetDirectWriteSet](docs/WriteSetDirectWriteSet.md)
 - [WriteSetPayload](docs/WriteSetPayload.md)
 - [WriteSetScriptWriteSet](docs/WriteSetScriptWriteSet.md)
 - [WriteTableItem](docs/WriteTableItem.md)


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

```
cargo doc --open
```

## Author