feat(webapi): add accounts_dump endpoint

iotaledger · May 27, 2024 · 419e3d7 · 419e3d7
1 parent 07d9b86
commit 419e3d7
Show file tree

Hide file tree

Showing 33 changed files with 630 additions and 1,647 deletions.
diff --git a/clients/apiclient/.openapi-generator/FILES b/clients/apiclient/.openapi-generator/FILES
@@ -12,7 +12,6 @@ api_users.go
 client.go
 configuration.go
 docs/AccountFoundriesResponse.md
-docs/AccountListResponse.md
 docs/AccountNFTsResponse.md
 docs/AccountNonceResponse.md
 docs/AddUserRequest.md
@@ -22,9 +21,7 @@ docs/AssetsResponse.md
 docs/AuthApi.md
 docs/AuthInfoModel.md
 docs/BaseToken.md
-docs/Blob.md
 docs/BlobInfoResponse.md
-docs/BlobListResponse.md
 docs/BlobValueResponse.md
 docs/BlockInfoResponse.md
 docs/BurnRecord.md
@@ -112,7 +109,6 @@ docs/VersionResponse.md
 git_push.sh
 go.sum
 model_account_foundries_response.go
-model_account_list_response.go
 model_account_nfts_response.go
 model_account_nonce_response.go
 model_add_user_request.go
@@ -121,9 +117,7 @@ model_assets_json.go
 model_assets_response.go
 model_auth_info_model.go
 model_base_token.go
-model_blob.go
 model_blob_info_response.go
-model_blob_list_response.go
 model_blob_value_response.go
 model_block_info_response.go
 model_burn_record.go

diff --git a/clients/apiclient/ChainsApi.md b/clients/apiclient/ChainsApi.md
@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**addAccessNode**](ChainsApi.md#addAccessNode) | **PUT** /v1/chains/{chainID}/access-node/{peer} | Configure a trusted node to be an access node.
 [**callView**](ChainsApi.md#callView) | **POST** /v1/chains/{chainID}/callview | Call a view function on a contract by Hname
 [**deactivateChain**](ChainsApi.md#deactivateChain) | **POST** /v1/chains/{chainID}/deactivate | Deactivate a chain
+[**dumpAccounts**](ChainsApi.md#dumpAccounts) | **POST** /v1/chains/{chainID}/dump-accounts | dump accounts information into a humanly-readable format
 [**estimateGasOffledger**](ChainsApi.md#estimateGasOffledger) | **POST** /v1/chains/{chainID}/estimategas-offledger | Estimates gas for a given off-ledger ISC request
 [**estimateGasOnledger**](ChainsApi.md#estimateGasOnledger) | **POST** /v1/chains/{chainID}/estimategas-onledger | Estimates gas for a given on-ledger ISC request
 [**getChainInfo**](ChainsApi.md#getChainInfo) | **GET** /v1/chains/{chainID} | Get information about a specific chain
@@ -262,6 +263,60 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
 
+# **dumpAccounts**
+> void dumpAccounts()
+
+
+### Example
+
+
+```typescript
+import {  } from '';
+import * as fs from 'fs';
+
+const configuration = .createConfiguration();
+const apiInstance = new .ChainsApi(configuration);
+
+let body:.ChainsApiDumpAccountsRequest = {
+  // string | ChainID (Bech32)
+  chainID: "chainID_example",
+};
+
+apiInstance.dumpAccounts(body).then((data:any) => {
+  console.log('API called successfully. Returned data: ' + data);
+}).catch((error:any) => console.error(error));
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **chainID** | [**string**] | ChainID (Bech32) | defaults to undefined
+
+
+### Return type
+
+**void**
+
+### Authorization
+
+[Authorization](README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Accounts dump will be produced |  -  |
+**401** | Unauthorized (Wrong permissions, missing token) |  -  |
+
+[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
+
 # **estimateGasOffledger**
 > ReceiptResponse estimateGasOffledger(request)
 

diff --git a/clients/apiclient/CorecontractsApi.md b/clients/apiclient/CorecontractsApi.md
@@ -8,18 +8,15 @@ Method | HTTP request | Description
 [**accountsGetAccountFoundries**](CorecontractsApi.md#accountsGetAccountFoundries) | **GET** /v1/chains/{chainID}/core/accounts/account/{agentID}/foundries | Get all foundries owned by an account
 [**accountsGetAccountNFTIDs**](CorecontractsApi.md#accountsGetAccountNFTIDs) | **GET** /v1/chains/{chainID}/core/accounts/account/{agentID}/nfts | Get all NFT ids belonging to an account
 [**accountsGetAccountNonce**](CorecontractsApi.md#accountsGetAccountNonce) | **GET** /v1/chains/{chainID}/core/accounts/account/{agentID}/nonce | Get the current nonce of an account
-[**accountsGetAccounts**](CorecontractsApi.md#accountsGetAccounts) | **GET** /v1/chains/{chainID}/core/accounts | Get a list of all accounts
 [**accountsGetFoundryOutput**](CorecontractsApi.md#accountsGetFoundryOutput) | **GET** /v1/chains/{chainID}/core/accounts/foundry_output/{serialNumber} | Get the foundry output
 [**accountsGetNFTData**](CorecontractsApi.md#accountsGetNFTData) | **GET** /v1/chains/{chainID}/core/accounts/nftdata/{nftID} | Get the NFT data by an ID
 [**accountsGetNativeTokenIDRegistry**](CorecontractsApi.md#accountsGetNativeTokenIDRegistry) | **GET** /v1/chains/{chainID}/core/accounts/token_registry | Get a list of all registries
 [**accountsGetTotalAssets**](CorecontractsApi.md#accountsGetTotalAssets) | **GET** /v1/chains/{chainID}/core/accounts/total_assets | Get all stored assets
-[**blobsGetAllBlobs**](CorecontractsApi.md#blobsGetAllBlobs) | **GET** /v1/chains/{chainID}/core/blobs | Get all stored blobs
 [**blobsGetBlobInfo**](CorecontractsApi.md#blobsGetBlobInfo) | **GET** /v1/chains/{chainID}/core/blobs/{blobHash} | Get all fields of a blob
 [**blobsGetBlobValue**](CorecontractsApi.md#blobsGetBlobValue) | **GET** /v1/chains/{chainID}/core/blobs/{blobHash}/data/{fieldKey} | Get the value of the supplied field (key)
 [**blocklogGetBlockInfo**](CorecontractsApi.md#blocklogGetBlockInfo) | **GET** /v1/chains/{chainID}/core/blocklog/blocks/{blockIndex} | Get the block info of a certain block index
 [**blocklogGetControlAddresses**](CorecontractsApi.md#blocklogGetControlAddresses) | **GET** /v1/chains/{chainID}/core/blocklog/controladdresses | Get the control addresses
 [**blocklogGetEventsOfBlock**](CorecontractsApi.md#blocklogGetEventsOfBlock) | **GET** /v1/chains/{chainID}/core/blocklog/events/block/{blockIndex} | Get events of a block
-[**blocklogGetEventsOfContract**](CorecontractsApi.md#blocklogGetEventsOfContract) | **GET** /v1/chains/{chainID}/core/blocklog/events/contract/{contractHname} | Get events of a contract
 [**blocklogGetEventsOfLatestBlock**](CorecontractsApi.md#blocklogGetEventsOfLatestBlock) | **GET** /v1/chains/{chainID}/core/blocklog/events/block/latest | Get events of the latest block
 [**blocklogGetEventsOfRequest**](CorecontractsApi.md#blocklogGetEventsOfRequest) | **GET** /v1/chains/{chainID}/core/blocklog/events/request/{requestID} | Get events of a request
 [**blocklogGetLatestBlockInfo**](CorecontractsApi.md#blocklogGetLatestBlockInfo) | **GET** /v1/chains/{chainID}/core/blocklog/blocks/latest | Get the block info of the latest block
@@ -275,63 +272,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
 
-# **accountsGetAccounts**
-> AccountListResponse accountsGetAccounts()
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .CorecontractsApi(configuration);
-
-let body:.CorecontractsApiAccountsGetAccountsRequest = {
-  // string | ChainID (Bech32)
-  chainID: "chainID_example",
-  // string | Block index or trie root (optional)
-  block: "block_example",
-};
-
-apiInstance.accountsGetAccounts(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **chainID** | [**string**] | ChainID (Bech32) | defaults to undefined
- **block** | [**string**] | Block index or trie root | (optional) defaults to undefined
-
-
-### Return type
-
-**AccountListResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | A list of all accounts |  -  |
-**401** | Unauthorized (Wrong permissions, missing token) |  -  |
-
-[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
-
 # **accountsGetFoundryOutput**
 > FoundryOutputResponse accountsGetFoundryOutput()
 
@@ -566,63 +506,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
 
-# **blobsGetAllBlobs**
-> BlobListResponse blobsGetAllBlobs()
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .CorecontractsApi(configuration);
-
-let body:.CorecontractsApiBlobsGetAllBlobsRequest = {
-  // string | ChainID (Bech32)
-  chainID: "chainID_example",
-  // string | Block index or trie root (optional)
-  block: "block_example",
-};
-
-apiInstance.blobsGetAllBlobs(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **chainID** | [**string**] | ChainID (Bech32) | defaults to undefined
- **block** | [**string**] | Block index or trie root | (optional) defaults to undefined
-
-
-### Return type
-
-**BlobListResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | All stored blobs |  -  |
-**401** | Unauthorized (Wrong permissions, missing token) |  -  |
-
-[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
-
 # **blobsGetBlobInfo**
 > BlobInfoResponse blobsGetBlobInfo()
 
@@ -915,66 +798,6 @@ No authorization required
  - **Accept**: application/json
 
 
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-**200** | The events |  -  |
-**401** | Unauthorized (Wrong permissions, missing token) |  -  |
-
-[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
-
-# **blocklogGetEventsOfContract**
-> EventsResponse blocklogGetEventsOfContract()
-
-
-### Example
-
-
-```typescript
-import {  } from '';
-import * as fs from 'fs';
-
-const configuration = .createConfiguration();
-const apiInstance = new .CorecontractsApi(configuration);
-
-let body:.CorecontractsApiBlocklogGetEventsOfContractRequest = {
-  // string | ChainID (Bech32)
-  chainID: "chainID_example",
-  // string | The contract hname (Hex)
-  contractHname: "contractHname_example",
-  // string | Block index or trie root (optional)
-  block: "block_example",
-};
-
-apiInstance.blocklogGetEventsOfContract(body).then((data:any) => {
-  console.log('API called successfully. Returned data: ' + data);
-}).catch((error:any) => console.error(error));
-```
-
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **chainID** | [**string**] | ChainID (Bech32) | defaults to undefined
- **contractHname** | [**string**] | The contract hname (Hex) | defaults to undefined
- **block** | [**string**] | Block index or trie root | (optional) defaults to undefined
-
-
-### Return type
-
-**EventsResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|