-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
56764e1
commit 2d64f5f
Showing
38 changed files
with
2,237 additions
and
7 deletions.
There are no files selected for viewing
8 changes: 5 additions & 3 deletions
8
...rand/rpc-algorand-broadcastTransaction.md → ...hers/rpc-algorand/broadcastTransaction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
v1.0/RPC Nodes/others/rpc-algorand/getAccountApplicationInfo.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: "getAccountApplicationInfo" | ||
| slug: "rpc-algorand-getAccountApplicationInfo" | ||
| excerpt: "Algorand RPC" | ||
| category: 65c5e93c623cad004b45d505 | ||
| hidden: false | ||
| metadata: | ||
| description: "Algorand RPC" | ||
| image: [] | ||
| keywords: "algorand, rpc" | ||
| robots: "index" | ||
| createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" | ||
| updatedAt: "Tue Apr 02 2024 08:40:59 GMT+0000 (Coordinated Universal Time)" | ||
| --- | ||
| [block:html]{"html":"<div style=\"padding: 10px 20px; border-radius: 5px; background-color: #e6e2ff; margin: 0 0 30px 0;\">\n <h5>Archive Method</h5>\n <p>Only on the full archive nodes. Complex queries might take longer and incur additional cost</p>\n</div>"}[/block] | ||
|
|
||
| ### How to use it | ||
|
|
||
| ```typescript | ||
| // Import required libraries and modules from Tatum SDK | ||
| import { TatumSDK, AlgorandAlgod, Network } from '@tatumio/tatum'; | ||
|
|
||
| // Initialize the Tatum SDK for Algorand | ||
| const tatum = await TatumSDK.init<AlgorandAlgod>({ network: Network.ALGORAND_ALGOD }); | ||
|
|
||
| // Define the input parameters in a single object | ||
| const params = { | ||
| address: 'ALGORAND_PUBLIC_KEY', // Specify the Algorand account public key. | ||
| applicationId: 12345, // Specify the application identifier. | ||
| format: 'json' // Optional: Configures whether the response object is JSON or MessagePack encoded (enum: json, msgpack). | ||
| }; | ||
|
|
||
| // Retrieve account application information for the Algorand account | ||
| const accountApplicationInfo = await tatum.rpc.getAccountApplicationInfo(params); | ||
|
|
||
| // Log the account application information | ||
| console.log('Algorand Account Application Information:', accountApplicationInfo); | ||
|
|
||
| // Always destroy the Tatum SDK instance when done to stop any background processes | ||
| await tatum.destroy(); | ||
| ``` | ||
|
|
||
| ### Overview | ||
|
|
||
| The `getAccountApplicationInfo` method allows you to retrieve the account's application local state and global state for a specific Algorand account and application ID. | ||
|
|
||
| ### Example Use Cases | ||
|
|
||
| 1. **Retrieve Application State**: Developers can use this method to retrieve the application state (local and global) for a specific Algorand account. | ||
|
|
||
| ### Request Parameters | ||
|
|
||
| The `getAccountApplicationInfo` method requires the following parameters: | ||
|
|
||
| - `address` (string, required): An Algorand account public key. | ||
| - `applicationId` (number, required): An application identifier. | ||
| - `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded. | ||
|
|
||
| ### Return Object | ||
|
|
||
| The method returns an object representing the account's application local state and global state (if exists) for the specified Algorand account and application ID. | ||
|
|
||
| Please note that the structure of the returned object may change in different Algorand RPC versions. |
67 changes: 67 additions & 0 deletions
67
v1.0/RPC Nodes/others/rpc-algorand/getAccountApplications.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: "getAccountApplications" | ||
| slug: "rpc-algorand-getAccountApplications" | ||
| excerpt: "Algorand RPC" | ||
| category: 65c5e93c623cad004b45d505 | ||
| hidden: false | ||
| metadata: | ||
| description: "Algorand RPC" | ||
| image: [] | ||
| keywords: "algorand, rpc" | ||
| robots: "index" | ||
| createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" | ||
| updatedAt: "Tue Apr 02 2024 08:40:59 GMT+0000 (Coordinated Universal Time)" | ||
| --- | ||
| [block:html]{"html":"<div style=\"padding: 10px 20px; border-radius: 5px; background-color: #e6e2ff; margin: 0 0 30px 0;\">\n <h5>Archive Method</h5>\n <p>Only on the full archive nodes. Complex queries might take longer and incur additional cost</p>\n</div>"}[/block] | ||
|
|
||
| ### How to use it | ||
|
|
||
| ```typescript | ||
| // Import required libraries and modules from Tatum SDK | ||
| import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum'; | ||
|
|
||
| // Initialize the Tatum SDK for Algorand | ||
| const tatum = await TatumSDK.init<AlgorandIndexer>({ network: Network.ALGORAND_INDEXER }); | ||
|
|
||
| // Define the input parameters in a single object | ||
| const params = { | ||
| accountId: 'ALGORAND_ACCOUNT_ID', // Specify the Algorand account ID for which you want to retrieve created applications. | ||
| applicationId: 123, // Optional: Specify the application ID (number) for filtering. | ||
| includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states (boolean). | ||
| limit: 100, // Optional: Maximum number of results to return (number). | ||
| next: 'NEXT_PAGE_TOKEN' // Optional: The next page of results. Use the next token provided by the previous results (string). | ||
| }; | ||
|
|
||
| // Retrieve created application parameters for the Algorand account | ||
| const createdApplications = await tatum.rpc.getAccountApplications(params); | ||
|
|
||
| // Log the created application parameters | ||
| console.log('Algorand Account Created Applications:', createdApplications); | ||
|
|
||
| // Always destroy the Tatum SDK instance when done to stop any background processes | ||
| await tatum.destroy(); | ||
| ``` | ||
|
|
||
| ### Overview | ||
|
|
||
| The `getAccountApplications` method allows you to retrieve the created application parameters of a specific Algorand account. | ||
|
|
||
| ### Example Use Cases | ||
|
|
||
| 1. **Application Parameters**: Developers can use this method to retrieve the parameters of applications created by an Algorand account, including information about specific applications and their details. | ||
|
|
||
| ### Request Parameters | ||
|
|
||
| The `getAccountApplications` method requires the following parameters: | ||
|
|
||
| - `accountId` (string, required): Specify the Algorand account ID for which you want to retrieve created application parameters. | ||
| - `applicationId` (number, optional): Specify the application ID for filtering the results. | ||
| - `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states. | ||
| - `limit` (number, optional): Maximum number of results to return. | ||
| - `next` (string, optional): The next page of results. Use the next token provided by the previous results. | ||
|
|
||
| ### Return Object | ||
|
|
||
| The method returns an object representing the created application parameters of the specified Algorand account, including information about specific applications and their details. | ||
|
|
||
| Please note that the structure of the returned object may change in different Algorand RPC versions. |
67 changes: 67 additions & 0 deletions
67
v1.0/RPC Nodes/others/rpc-algorand/getAccountApssLocalState.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: "getAccountApssLocalState" | ||
| slug: "rpc-algorand-getAccountApssLocalState" | ||
| excerpt: "Algorand RPC" | ||
| category: 65c5e93c623cad004b45d505 | ||
| hidden: false | ||
| metadata: | ||
| description: "Algorand RPC" | ||
| image: [] | ||
| keywords: "algorand, rpc" | ||
| robots: "index" | ||
| createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" | ||
| updatedAt: "Tue Apr 02 2024 08:40:59 GMT+0000 (Coordinated Universal Time)" | ||
| --- | ||
| [block:html]{"html":"<div style=\"padding: 10px 20px; border-radius: 5px; background-color: #e6e2ff; margin: 0 0 30px 0;\">\n <h5>Archive Method</h5>\n <p>Only on the full archive nodes. Complex queries might take longer and incur additional cost</p>\n</div>"}[/block] | ||
|
|
||
| ### How to use it | ||
|
|
||
| ```typescript | ||
| // Import required libraries and modules from Tatum SDK | ||
| import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum'; | ||
|
|
||
| // Initialize the Tatum SDK for Algorand | ||
| const tatum = await TatumSDK.init<AlgorandIndexer>({ network: Network.ALGORAND_INDEXER }); | ||
|
|
||
| // Define optional query parameters | ||
| const params = { | ||
| accountId: 'ALGORAND_ACCOUNT_ID', // Replace with the Algorand account ID for which you want to retrieve local application state. | ||
| applicationId: 123, // Optional: Specify the application ID (number) for filtering. | ||
| includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states (boolean). | ||
| limit: 100, // Optional: Maximum number of results to return (number). | ||
| next: 'NEXT_PAGE_TOKEN' // Optional: The next page of results. Use the next token provided by the previous results (string). | ||
| }; | ||
|
|
||
| // Retrieve local application state for the Algorand account | ||
| const appsLocalState = await tatum.rpc.getAccountAppsLocalState(params); | ||
|
|
||
| // Log the local application state information | ||
| console.log('Algorand Account Local Application State:', appsLocalState); | ||
|
|
||
| // Always destroy the Tatum SDK instance when done to stop any background processes | ||
| await tatum.destroy(); | ||
| ``` | ||
|
|
||
| ### Overview | ||
|
|
||
| The `getAccountAppsLocalState` method allows you to retrieve the local application state of a specific Algorand account. | ||
|
|
||
| ### Example Use Cases | ||
|
|
||
| 1. **Application State**: Developers can use this method to retrieve the local application state of an Algorand account, including information about its asset holdings and applications. | ||
|
|
||
| ### Request Parameters | ||
|
|
||
| The `getAccountAppsLocalState` method requires the following parameters: | ||
|
|
||
| - `account-id` (string, required): The Algorand account ID for which you want to retrieve local application state. | ||
| - `application-id` (number, optional): Specify the application ID for filtering the results. | ||
| - `include-all` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states. | ||
| - `limit` (number, optional): Maximum number of results to return. | ||
| - `next` (string, optional): The next page of results. Use the next token provided by the previous results. | ||
|
|
||
| ### Return Object | ||
|
|
||
| The method returns an object representing the local application state of the specified Algorand account, including information about asset holdings and applications. | ||
|
|
||
| Please note that the structure of the returned object may change in different Algorand RPC versions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: "getAccountAssetInfo" | ||
| slug: "rpc-algorand-getAccountAssetInfo" | ||
| excerpt: "Algorand RPC" | ||
| category: 65c5e93c623cad004b45d505 | ||
| hidden: false | ||
| metadata: | ||
| description: "Algorand RPC" | ||
| image: [] | ||
| keywords: "algorand, rpc" | ||
| robots: "index" | ||
| createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" | ||
| updatedAt: "Tue Apr 02 2024 08:40:59 GMT+0000 (Coordinated Universal Time)" | ||
| --- | ||
| [block:html]{"html":"<div style=\"padding: 10px 20px; border-radius: 5px; background-color: #e6e2ff; margin: 0 0 30px 0;\">\n <h5>Archive Method</h5>\n <p>Only on the full archive nodes. Complex queries might take longer and incur additional cost</p>\n</div>"}[/block] | ||
|
|
||
| ### How to use it | ||
|
|
||
| ```typescript | ||
| // Import required libraries and modules from Tatum SDK | ||
| import { TatumSDK, AlgorandAlgod, Network } from '@tatumio/tatum'; | ||
|
|
||
| // Initialize the Tatum SDK for Algorand | ||
| const tatum = await TatumSDK.init<AlgorandAlgod>({ network: Network.ALGORAND_ALGOD }); | ||
|
|
||
| // Define the input parameters in a single object | ||
| const params = { | ||
| address: 'ALGORAND_ACCOUNT_ADDRESS', // Specify the Algorand account address for which you want to retrieve asset information. | ||
| assetId: 123, // Specify the asset ID for which you want to retrieve information. | ||
| format: 'json' // Optional: Configures whether the response object is JSON or MessagePack encoded. Defaults to JSON. | ||
| }; | ||
|
|
||
| // Retrieve asset information for the Algorand account | ||
| const assetInformation = await tatum.rpc.getAccountAssetInformation(params); | ||
|
|
||
| // Log the asset information | ||
| console.log('Algorand Account Asset Information:', assetInformation); | ||
|
|
||
| // Always destroy the Tatum SDK instance when done to stop any background processes | ||
| await tatum.destroy(); | ||
| ``` | ||
|
|
||
| ### Overview | ||
|
|
||
| The `getAccountAssetInformation` method allows you to retrieve asset holding and asset parameters (if applicable) for a specific asset ID and account address. | ||
|
|
||
| ### Example Use Cases | ||
|
|
||
| 1. **Asset Holdings**: Developers can use this method to retrieve the asset holdings of a specific Algorand account, including information about the asset and its parameters. | ||
|
|
||
| ### Request Parameters | ||
|
|
||
| The `getAccountAssetInformation` method requires the following parameters: | ||
|
|
||
| - `address` (string, required): Specify the Algorand account address for which you want to retrieve asset information. | ||
| - `assetId` (number, required): Specify the asset ID for which you want to retrieve information. | ||
| - `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded. Defaults to JSON. | ||
|
|
||
| ### Return Object | ||
|
|
||
| The method returns an object representing the asset holding and asset parameters (if applicable) for the specified asset ID and account address. | ||
|
|
||
| Please note that the structure of the returned object may change in different Algorand RPC versions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: "getAccountAssets" | ||
| slug: "rpc-algorand-getAccountAssets" | ||
| excerpt: "Algorand RPC" | ||
| category: 65c5e93c623cad004b45d505 | ||
| hidden: false | ||
| metadata: | ||
| description: "Algorand RPC" | ||
| image: [] | ||
| keywords: "algorand, rpc" | ||
| robots: "index" | ||
| createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" | ||
| updatedAt: "Tue Apr 02 2024 08:40:59 GMT+0000 (Coordinated Universal Time)" | ||
| --- | ||
| [block:html]{"html":"<div style=\"padding: 10px 20px; border-radius: 5px; background-color: #e6e2ff; margin: 0 0 30px 0;\">\n <h5>Archive Method</h5>\n <p>Only on the full archive nodes. Complex queries might take longer and incur additional cost</p>\n</div>"}[/block] | ||
|
|
||
| ### How to use it | ||
|
|
||
| ```typescript | ||
| // Import required libraries and modules from Tatum SDK | ||
| import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum'; | ||
|
|
||
| // Initialize the Tatum SDK for Algorand | ||
| const tatum = await TatumSDK.init<AlgorandIndexer>({ network: Network.ALGORAND_INDEXER }); | ||
|
|
||
| // Define the input parameters in a single object | ||
| const params = { | ||
| accountId: 'ALGORAND_ACCOUNT_ID', // Specify the Algorand account ID for which you want to retrieve asset holdings. | ||
| assetId: 123, // Optional: Specify the asset ID (number) for filtering. | ||
| includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states (boolean). | ||
| limit: 100, // Optional: Maximum number of results to return (number). | ||
| next: 'NEXT_PAGE_TOKEN' // Optional: The next page of results. Use the next token provided by the previous results (string). | ||
| }; | ||
|
|
||
| // Retrieve asset holdings for the Algorand account | ||
| const accountAssets = await tatum.rpc.getAccountAssets(params); | ||
|
|
||
| // Log the asset holdings information | ||
| console.log('Algorand Account Asset Holdings:', accountAssets); | ||
|
|
||
| // Always destroy the Tatum SDK instance when done to stop any background processes | ||
| await tatum.destroy(); | ||
| ``` | ||
|
|
||
| ### Overview | ||
|
|
||
| The `getAccountAssets` method allows you to retrieve the asset holdings of a specific Algorand account. | ||
|
|
||
| ### Example Use Cases | ||
|
|
||
| 1. **Asset Holdings**: Developers can use this method to retrieve the asset holdings of an Algorand account, including information about specific assets held by the account. | ||
|
|
||
| ### Request Parameters | ||
|
|
||
| The `getAccountAssets` method requires the following parameters: | ||
|
|
||
| - `accountId` (string, required): Specify the Algorand account ID for which you want to retrieve asset holdings. | ||
| - `assetId` (number, optional): Specify the asset ID for filtering the results. | ||
| - `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states. | ||
| - `limit` (number, optional): Maximum number of results to return. | ||
| - `next` (string, optional): The next page of results. Use the next token provided by the previous results. | ||
|
|
||
| ### Return Object | ||
|
|
||
| The method returns an object representing the asset holdings of the specified Algorand account, including information about specific assets and their quantities. | ||
|
|
||
| Please note that the structure of the returned object may change in different Algorand RPC versions. |
Oops, something went wrong.