From 2d64f5f1bd570e072e10d926de258640090f2e75 Mon Sep 17 00:00:00 2001 From: productshiv Date: Fri, 5 Apr 2024 21:32:10 +0530 Subject: [PATCH] Adding Full Algorand --- ...Transaction.md => broadcastTransaction.md} | 8 +- ...c-algorand-getAccount.md => getAccount.md} | 6 +- .../rpc-algorand/getAccountApplicationInfo.md | 63 +++++++++++++ .../rpc-algorand/getAccountApplications.md | 67 ++++++++++++++ .../rpc-algorand/getAccountApssLocalState.md | 67 ++++++++++++++ .../rpc-algorand/getAccountAssetInfo.md | 63 +++++++++++++ .../others/rpc-algorand/getAccountAssets.md | 67 ++++++++++++++ .../rpc-algorand/getAccountCreatedAssets.md | 67 ++++++++++++++ .../others/rpc-algorand/getAccountInfo.md | 64 +++++++++++++ .../rpc-algorand/getAccountTransactions.md | 89 ++++++++++++++++++ .../others/rpc-algorand/getAccounts.md | 59 ++++++++++++ .../others/rpc-algorand/getApplication.md | 61 +++++++++++++ .../others/rpc-algorand/getApplicationBox.md | 61 +++++++++++++ .../rpc-algorand/getApplicationBoxes.md | 63 +++++++++++++ .../rpc-algorand/getApplicationDetails.md | 61 +++++++++++++ .../others/rpc-algorand/getApplicationLogs.md | 71 +++++++++++++++ .../others/rpc-algorand/getApplications.md | 73 +++++++++++++++ .../RPC Nodes/others/rpc-algorand/getAsset.md | 61 +++++++++++++ .../others/rpc-algorand/getAssetBalances.md | 69 ++++++++++++++ .../rpc-algorand/getAssetInformation.md | 59 ++++++++++++ .../rpc-algorand/getAssetTransactions.md | 87 ++++++++++++++++++ .../others/rpc-algorand/getAssets.md | 71 +++++++++++++++ .../RPC Nodes/others/rpc-algorand/getBlock.md | 57 ++++++++++++ .../others/rpc-algorand/getBlockHash.md | 59 ++++++++++++ .../others/rpc-algorand/getGenesis.md | 52 +++++++++++ .../others/rpc-algorand/getHealth.md | 50 ++++++++++ .../rpc-algorand/getLedgerStateDelta.md | 61 +++++++++++++ .../others/rpc-algorand/getLedgerSupply.md | 52 +++++++++++ .../others/rpc-algorand/getNodeStatus.md | 53 +++++++++++ .../rpc-algorand/getNodeStatusAfterRound.md | 59 ++++++++++++ .../rpc-algorand/getPendingTransactions.md | 63 +++++++++++++ .../others/rpc-algorand/getTransaction.md | 53 +++++++++++ .../rpc-algorand/getTransactionParams.md | 59 ++++++++++++ .../rpc-algorand/getTransactionProof.md | 71 +++++++++++++++ .../others/rpc-algorand/getTransactions.md | 91 +++++++++++++++++++ .../others/rpc-algorand/isHealthy.md | 50 ++++++++++ v1.0/RPC Nodes/others/rpc-algorand/isReady.md | 52 +++++++++++ ...eTransaction.md => simulateTransaction.md} | 5 +- 38 files changed, 2237 insertions(+), 7 deletions(-) rename v1.0/RPC Nodes/others/rpc-algorand/{rpc-algorand-broadcastTransaction.md => broadcastTransaction.md} (92%) rename v1.0/RPC Nodes/others/rpc-algorand/{rpc-algorand-getAccount.md => getAccount.md} (96%) create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountApplicationInfo.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountApplications.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountApssLocalState.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountAssetInfo.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountAssets.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountCreatedAssets.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountInfo.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccountTransactions.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAccounts.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getApplication.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getApplicationBox.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getApplicationBoxes.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getApplicationDetails.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getApplicationLogs.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getApplications.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAsset.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAssetBalances.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAssetInformation.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAssetTransactions.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getAssets.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getBlock.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getBlockHash.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getGenesis.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getHealth.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getLedgerStateDelta.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getLedgerSupply.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getNodeStatus.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getNodeStatusAfterRound.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getPendingTransactions.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getTransaction.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getTransactionParams.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getTransactionProof.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/getTransactions.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/isHealthy.md create mode 100644 v1.0/RPC Nodes/others/rpc-algorand/isReady.md rename v1.0/RPC Nodes/others/rpc-algorand/{rpc-algorand-simulateTransaction.md => simulateTransaction.md} (98%) diff --git a/v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-broadcastTransaction.md b/v1.0/RPC Nodes/others/rpc-algorand/broadcastTransaction.md similarity index 92% rename from v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-broadcastTransaction.md rename to v1.0/RPC Nodes/others/rpc-algorand/broadcastTransaction.md index edd618cf..841d9f71 100644 --- a/v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-broadcastTransaction.md +++ b/v1.0/RPC Nodes/others/rpc-algorand/broadcastTransaction.md @@ -1,7 +1,8 @@ --- title: "broadcastTransaction" -slug: "rpc-algorand-broadcasttransaction" +slug: "rpc-algorand-broadcastTransaction" excerpt: "Algorand RPC" +category: 65c5e93c623cad004b45d505 hidden: false metadata: description: "Algorand RPC" @@ -9,9 +10,10 @@ metadata: keywords: "algorand, rpc" robots: "index" createdAt: "Wed Mar 06 2024 10:35:44 GMT+0000 (Coordinated Universal Time)" -updatedAt: "Fri Apr 05 2024 15:40:30 GMT+0000 (Coordinated Universal Time)" +updatedAt: "Tue Apr 02 2024 08:40:59 GMT+0000 (Coordinated Universal Time)" --- -[block:html]{"html":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block]\n +[block:html]{"html":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block] + ### How to use it ```typescript diff --git a/v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-getAccount.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccount.md similarity index 96% rename from v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-getAccount.md rename to v1.0/RPC Nodes/others/rpc-algorand/getAccount.md index e8b7c1f6..f6abdc2e 100644 --- a/v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-getAccount.md +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccount.md @@ -1,7 +1,8 @@ --- title: "getAccount" -slug: "rpc-algorand-getaccount" +slug: "rpc-algorand-getAccount" excerpt: "Algorand RPC" +category: 65c5e93c623cad004b45d505 hidden: false metadata: description: "Algorand RPC" @@ -11,7 +12,8 @@ metadata: 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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block]\n +[block:html]{"html":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block] + ### How to use it ```typescript diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountApplicationInfo.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountApplicationInfo.md new file mode 100644 index 00000000..61aacfad --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountApplicationInfo.md @@ -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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountApplications.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountApplications.md new file mode 100644 index 00000000..8e012fa6 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountApplications.md @@ -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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountApssLocalState.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountApssLocalState.md new file mode 100644 index 00000000..84253a63 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountApssLocalState.md @@ -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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountAssetInfo.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountAssetInfo.md new file mode 100644 index 00000000..953442a3 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountAssetInfo.md @@ -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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountAssets.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountAssets.md new file mode 100644 index 00000000..ce89cabf --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountAssets.md @@ -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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountCreatedAssets.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountCreatedAssets.md new file mode 100644 index 00000000..654fcdf7 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountCreatedAssets.md @@ -0,0 +1,67 @@ +--- +title: "getAccountCreatedAssets" +slug: "rpc-algorand-getAccountCreatedAssets" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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 asset parameters. + 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 created asset parameters for the Algorand account +const createdAssets = await tatum.rpc.getAccountCreatedAssets(params); + +// Log the created asset parameters +console.log('Algorand Account Created Assets:', createdAssets); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountCreatedAssets` method allows you to retrieve the created asset parameters of a specific Algorand account. + +### Example Use Cases + +1. **Asset Parameters**: Developers can use this method to retrieve the parameters of assets created by an Algorand account, including information about specific assets and their details. + +### Request Parameters + +The `getAccountCreatedAssets` method requires the following parameters: + +- `accountId` (string, required): Specify the Algorand account ID for which you want to retrieve created asset parameters. +- `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 created asset parameters of the specified Algorand account, including information about specific assets and their details. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountInfo.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountInfo.md new file mode 100644 index 00000000..d997c012 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountInfo.md @@ -0,0 +1,64 @@ +--- +title: "getAccountInfo" +slug: "rpc-algorand-getAccountInfo" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + address: 'ALGORAND_ADDRESS', // Specify the Algorand public key for which you want to retrieve account information. + format: 'json', // Optional: Configures whether the response object is JSON or MessagePack encoded (enum: json, msgpack). + exclude: 'none' // Optional: When set to 'all' will exclude asset holdings, application local state, created asset parameters, any created application parameters. Defaults to 'none' (enum: all, none). +}; + +// Retrieve account information for the Algorand account +const accountInfo = await tatum.rpc.getAccountInformation(params); + +// Log the account information +console.log('Algorand Account Information:', accountInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountInformation` method allows you to retrieve the status, balance, and spendable amounts of a specific Algorand account. + +### Example Use Cases + +1. **Account Balance**: Developers can use this method to retrieve the balance and spendable amounts of an Algorand account. +2. **Account Status**: Users can check the status of their Algorand account, including the account public key and other related information. + +### Request Parameters + +The `getAccountInformation` method requires the following parameters: + +- `address` (string, required): Specify the Algorand public key for which you want to retrieve account information. +- `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON. +- `exclude` (enum: all, none, optional): When set to 'all', it will exclude asset holdings, application local state, created asset parameters, and any created application parameters. Defaults to 'none'. + +### Return Object + +The method returns an object representing the account information of the specified Algorand account, including the account status, balance, and spendable amounts. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccountTransactions.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccountTransactions.md new file mode 100644 index 00000000..f3725e73 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccountTransactions.md @@ -0,0 +1,89 @@ +--- +title: "getAccountTransactions" +slug: "rpc-algorand-getAccountTransactions" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ 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 transactions. + afterTime: 'RFC3339_DATETIME', // Optional: Include results after the given time (string in RFC 3339 format). + assetId: 123, // Optional: Specify the asset ID (number) for filtering. + beforeTime: 'RFC3339_DATETIME', // Optional: Include results before the given time (string in RFC 3339 format). + currencyGreaterThan: 1000, // Optional: Results should have an amount greater than this value (number). + currencyLessThan: 5000, // Optional: Results should have an amount less than this value (number). + limit: 100, // Optional: Maximum number of results to return (number). + maxRound: 10000, // Optional: Include results at or before the specified max-round (number). + minRound: 9000, // Optional: Include results at or after the specified min-round (number). + next: 'NEXT_PAGE_TOKEN', // Optional: The next page of results. Use the next token provided by the previous results (string). + notePrefix: 'NOTE_PREFIX', // Optional: Specifies a prefix which must be contained in the note field (string). + rekeyTo: true, // Optional: Include results which include the rekey-to field (boolean). + round: 8000, // Optional: Include results for the specified round (number). + sigType: 'sig', // Optional: SigType filters just results using the specified type of signature (enum: sig, msig, lsig). + txType: 'pay', // Optional: Filters results by transaction type (enum: pay, keyreg, acfg, axfer, afrz, appl, stpf). + txId: 'TRANSACTION_ID' // Optional: Lookup the specific transaction by ID (string). +}; + +// Retrieve account transactions for the Algorand account +const accountTransactions = await tatum.rpc.getAccountTransactions(params); + +// Log the account transactions +console.log('Algorand Account Transactions:', accountTransactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccountTransactions` method allows you to retrieve transactions of a specific Algorand account. + +### Example Use Cases + +1. **Transaction History**: Developers can use this method to retrieve the transaction history of an Algorand account, including information about specific transactions and their details. + +### Request Parameters + +The `getAccountTransactions` method requires the following parameters: + +- `accountId` (string, required): Specify the Algorand account ID for which you want to retrieve transactions. +- `afterTime` (string in RFC 3339 format, optional): Include results after the given time. +- `assetId` (number, optional): Specify the asset ID for filtering. +- `beforeTime` (string in RFC 3339 format, optional): Include results before the given time. +- `currencyGreaterThan` (number, optional): Results should have an amount greater than this value. +- `currencyLessThan` (number, optional): Results should have an amount less than this value. +- `limit` (number, optional): Maximum number of results to return. +- `maxRound` (number, optional): Include results at or before the specified max-round. +- `minRound` (number, optional): Include results at or after the specified min-round. +- `next` (string, optional): The next page of results. Use the next token provided by the previous results. +- `notePrefix` (string, optional): Specifies a prefix which must be contained in the note field. +- `rekeyTo` (boolean, optional): Include results which include the rekey-to field. +- `round` (number, optional): Include results for the specified round. +- `sigType` (enum: sig, msig, lsig, optional): Filters just results using the specified type of signature. +- `txType` (enum: pay, keyreg, acfg, axfer, afrz, appl, stpf, optional): Filters results by transaction type. +- `txId` (string, optional): Lookup the specific transaction by ID. + +### Return Object + +The method returns an object representing the transactions of the specified Algorand account, including information about specific transactions and their details. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAccounts.md b/v1.0/RPC Nodes/others/rpc-algorand/getAccounts.md new file mode 100644 index 00000000..9a74ba65 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAccounts.md @@ -0,0 +1,59 @@ +--- +title: "getAccounts" +slug: "rpc-algorand-getAccounts" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block] + +### How to use it + +```typescript +// Import required libraries and modules +import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum'; + +// Initialize the Tatum SDK +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters +const address = { address: 'ALGORAND_ADDRESS' }; // Replace with the Algorand address you want to retrieve account information for. + +// Retrieve account information using the Algorand Indexer +const accountInfo = await tatum.rpc.getAccounts(address); + +// Log the account information +console.log('Algorand Account Information:', accountInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAccounts` method from the Algorand Indexer API allows you to retrieve detailed information about an Algorand account based on its address. + +### Example Use Cases + +1. **Account Balance**: Developers can use this method to check the balance of an Algorand account by providing its address. + +2. **Account Details**: You can retrieve various details of an Algorand account, including its transactions, assets, and more, for further analysis. + +### Request Parameters + +The `getAccounts` method requires the following parameter: + +- `address` (string, required): The Algorand address for which you want to retrieve account information. + +### Return Object + +The method returns an object representing the detailed information of the specified Algorand account, including various parameters. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getApplication.md b/v1.0/RPC Nodes/others/rpc-algorand/getApplication.md new file mode 100644 index 00000000..562e423d --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getApplication.md @@ -0,0 +1,61 @@ +--- +title: "getApplication" +slug: "rpc-algorand-getApplication" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters in a single object +const params = { + applicationId: 123, // Specify the application ID (number) you want to lookup. + includeAll: true // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states (boolean). +}; + +// Lookup the Algorand application +const applicationInfo = await tatum.rpc.getApplication(params); + +// Log the application information +console.log('Algorand Application Information:', applicationInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getApplication` method allows you to lookup an Algorand application. + +### Example Use Cases + +1. **Application Information**: Developers can use this method to retrieve detailed information about a specific Algorand application, including its status and details. + +### Request Parameters + +The `getApplication` method requires the following parameters: + +- `applicationId` (number, required): Specify the application ID you want to lookup. +- `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states. + +### Return Object + +The method returns an object representing the information about the specified Algorand application, including its status and details. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getApplicationBox.md b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationBox.md new file mode 100644 index 00000000..932fd06b --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationBox.md @@ -0,0 +1,61 @@ +--- +title: "getApplicationBox" +slug: "rpc-algorand-getApplicationBox" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters in a single object +const params = { + applicationId: 123, // Specify the application ID (number) for which you want to get the box information. + name: 'int:1234' // Specify the box name in goal-arg form (string). +}; + +// Get the box information for the Algorand application +const boxInfo = await tatum.rpc.getApplicationBox(params); + +// Log the box information +console.log('Algorand Application Box Information:', boxInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getApplicationBox` method allows you to get box information for a given Algorand application. + +### Example Use Cases + +1. **Box Information**: Developers can use this method to retrieve base64 encoded box name and value for a specific box within an Algorand application. + +### Request Parameters + +The `getApplicationBox` method requires the following parameters: + +- `applicationId` (number, required): Specify the application ID for which you want to get the box information. +- `name` (string, required): Specify the box name in goal-arg form, such as 'int:1234', 'b64:A==', 'str:hello', or 'addr:XYZ...'. + +### Return Object + +The method returns an object representing the base64 encoded box name and value for the specified box within the Algorand application. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getApplicationBoxes.md b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationBoxes.md new file mode 100644 index 00000000..d87132f6 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationBoxes.md @@ -0,0 +1,63 @@ +--- +title: "getApplicationBoxes" +slug: "rpc-algorand-getApplicationBoxes" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters in a single object +const params = { + applicationId: 123, // Specify the application ID (number) for which you want to get box names. + limit: 100, // Optional: Maximum number of results to return (number). + next: 'NEXT_TOKEN' // Optional: The next page of results. Use the next token provided by the previous results (string). +}; + +// Get the box names for the Algorand application +const boxNames = await tatum.rpc.getApplicationBoxes(params); + +// Log the box names +console.log('Algorand Application Box Names:', boxNames); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getApplicationBoxes` method allows you to get box names for a given Algorand application. + +### Example Use Cases + +1. **Box Names**: Developers can use this method to retrieve the box names of an Algorand application sorted lexicographically. + +### Request Parameters + +The `getApplicationBoxes` method requires the following parameters: + +- `applicationId` (number, required): Specify the application ID for which you want to get box names. +- `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 array of box names for the specified Algorand application, sorted lexicographically. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getApplicationDetails.md b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationDetails.md new file mode 100644 index 00000000..b2c02e0f --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationDetails.md @@ -0,0 +1,61 @@ +--- +title: "getApplicationDetails" +slug: "rpc-algorand-getApplicationDetails" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters in a single object +const params = { + applicationId: 'APPLICATION_ID', // Application ID to filter the applications (number, optional). + creator: 'CREATOR_ADDRESS', // Filter applications by the creator address (string, optional). + includeAll: true, // Include all items like closed accounts and deleted applications (boolean, optional). + limit: 100, // Maximum number of results to return (number, optional). + next: 'NEXT_PAGE_TOKEN' // The next page of results. Use the next token from previous results (string, optional). +}; + +// Retrieve details of the specified Algorand application +const applicationDetails = await tatum.rpc.getApplicationDetails(params); + +// Log the details of the Algorand application +console.log('Algorand Application Details:', applicationDetails); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getApplicationDetails` method fetches details for Algorand applications, with the ability to filter based on the application ID, creator, and other criteria. + +### Request Parameters + +- `applicationId` (number, optional): Application ID to filter the applications. +- `creator` (string, optional): Filter applications by the creator address. +- `includeAll` (boolean, optional): Include all related items in the results. +- `limit` (number, optional): Maximum number of results to return. +- `next` (string, optional): The next page of results, using the next token from previous results. + +### Return Object + +The method returns detailed information about the specified Algorand applications based on the provided filters. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getApplicationLogs.md b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationLogs.md new file mode 100644 index 00000000..6ffdd343 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getApplicationLogs.md @@ -0,0 +1,71 @@ +--- +title: "getApplicationLogs" +slug: "rpc-algorand-getApplicationLogs" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters in a single object +const params = { + applicationId: 123, // Specify the application ID (number) for which you want to lookup logs. + limit: 100, // Optional: Maximum number of results to return (number). + maxRound: 10000, // Optional: Include results at or before the specified max-round (number). + minRound: 9000, // Optional: Include results at or after the specified min-round (number). + next: 'NEXT_PAGE_TOKEN', // Optional: The next page of results. Use the next token provided by the previous results (string). + senderAddress: 'ALGORAND_SENDER_ADDRESS', // Optional: Only include transactions with this sender address (string). + txId: 'TRANSACTION_ID' // Optional: Lookup the specific transaction by ID (string). +}; + +// Lookup application logs for the Algorand application +const applicationLogs = await tatum.rpc.getApplicationLogs(params); + +// Log the application logs +console.log('Algorand Application Logs:', applicationLogs); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getApplicationLogs` method allows you to lookup logs for an Algorand application. + +### Example Use Cases + +1. **Application Logs**: Developers can use this method to retrieve logs associated with a specific Algorand application. + +### Request Parameters + +The `getApplicationLogs` method requires the following parameters: + +- `applicationId` (number, required): Specify the application ID for which you want to lookup logs. +- `limit` (number, optional): Maximum number of results to return. +- `maxRound` (number, optional): Include results at or before the specified max-round. +- `minRound` (number, optional): Include results at or after the specified min-round. +- `next` (string, optional): The next page of results. Use the next token provided by the previous results. +- `senderAddress` (string, optional): Only include transactions with this sender address. +- `txId` (string, optional): Lookup the specific transaction by ID. + +### Return Object + +The method returns an array of application logs for the specified Algorand application. + +Please note that the structure of the returned object may change in different Algorand RPC versions. diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getApplications.md b/v1.0/RPC Nodes/others/rpc-algorand/getApplications.md new file mode 100644 index 00000000..f863be03 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getApplications.md @@ -0,0 +1,73 @@ +--- +title: "getApplications" +slug: "rpc-algorand-getApplications" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const params = { + applicationId: 123, // Application ID (integer). + creator: 'ALGORAND_ADDRESS', // Filter just applications with the given creator address (string). + includeAll: true, // Include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (boolean). + limit: 10, // Maximum number of results to return (integer). + next: 'NEXT_TOKEN', // The next page of results. Use the next token provided by the previous results (string). +}; + +// Search for applications +const applications = await tatum.indexer.getApplications(params); + +// Log the applications +console.log('Applications:', applications); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getApplications` method allows you to search for applications on the Algorand network using various filtering criteria. You can filter applications by their Application ID, creator address, and more. + +### Request Parameters + +The `getApplications` method requires the following parameters: + +- `applicationId` (integer, optional): Application ID used to filter applications. + +- `creator` (string, optional): Filter applications by the creator's address. + +- `includeAll` (boolean, optional): Whether to include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates. + +- `limit` (integer, optional): Maximum number of results to return. Additional pages may be available even if the limit is not reached. + +- `next` (string, optional): The next page token to use for pagination. Provide this token when making another request to retrieve the next set of results. + +### Return Object + +The method returns a response object containing information about the applications: + +- `applications` (array of objects): An array of application objects that match the search criteria. + +- `current-round` (integer): The round at which the results were computed. + +- `next-token` (string): Used for pagination. When making another request, provide this token with the `next` parameter to retrieve the next set of results. + +Please note that the structure of the returned object may change in different Algorand Indexer API versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAsset.md b/v1.0/RPC Nodes/others/rpc-algorand/getAsset.md new file mode 100644 index 00000000..505b465a --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAsset.md @@ -0,0 +1,61 @@ +--- +title: "getAsset" +slug: "rpc-algorand-getAsset" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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 +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const params = { + assetId: 123, // Specify the asset ID (number) for which you want to lookup asset information. + includeAll: true // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (boolean). +}; + +// Lookup asset information +const assetInfo = await tatum.rpc.getAsset(params); + +// Log the asset information +console.log('Asset Information:', assetInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAsset` method allows you to lookup information for a specific asset. + +### Example Use Cases + +1. **Asset Lookup**: Developers can use this method to retrieve detailed information about a specific asset. + +### Request Parameters + +The `getAsset` method requires the following parameters, all included in the `params` dictionary object: + +- `assetId` (number, required): Specify the asset ID for which you want to lookup asset information. +- `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (boolean). + +### Return Object + +The method returns an object representing the detailed information of the specified asset, including its properties. + +Please note that the structure of the returned object may change in different RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAssetBalances.md b/v1.0/RPC Nodes/others/rpc-algorand/getAssetBalances.md new file mode 100644 index 00000000..2cc86d17 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAssetBalances.md @@ -0,0 +1,69 @@ +--- +title: "getAssetBalances" +slug: "rpc-algorand-getAssetBalances" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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 +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const params = { + assetId: 123, // Specify the asset ID (number) for which you want to lookup balances. + currencyGreaterThan: 100, // Optional: Results should have an amount greater than this value (number). + currencyLessThan: 500, // Optional: Results should have an amount less than this value (number). + includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (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). +}; + +// Lookup the list of accounts holding the specified asset +const assetBalances = await tatum.rpc.getAssetBalances(params); + +// Log the list of accounts and their asset balances +console.log('Asset Balances:', assetBalances); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAssetBalances` method allows you to lookup the list of accounts that hold a specific asset. + +### Example Use Cases + +1. **Asset Balances**: Developers can use this method to retrieve a list of accounts holding a particular asset, with optional filters for currency amounts. + +### Request Parameters + +The `getAssetBalances` method requires the following parameters: + +- `assetId` (number, required): Specify the asset ID for which you want to lookup balances. +- `currencyGreaterThan` (number, optional): Results should have an amount greater than this value (number). +- `currencyLessThan` (number, optional): Results should have an amount less than this value (number). +- `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (boolean). +- `limit` (number, optional): Maximum number of results to return (number). +- `next` (string, optional): The next page of results. Use the next token provided by the previous results (string). + +### Return Object + +The method returns a list of accounts holding the specified asset, along with their asset balances. + +Please note that the structure of the returned object may change in different RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAssetInformation.md b/v1.0/RPC Nodes/others/rpc-algorand/getAssetInformation.md new file mode 100644 index 00000000..8affd58e --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAssetInformation.md @@ -0,0 +1,59 @@ +--- +title: "getAssetInformation" +slug: "rpc-algorand-getAssetInformation" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + assetId: 123, // Specify the asset ID for which you want to retrieve information. +}; + +// Retrieve the asset information for the specified asset ID +const assetInfo = await tatum.rpc.getAssetInformation(params); + +// Log the asset information +console.log('Asset Information:', assetInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAssetInformation` method allows you to retrieve asset information, including creator, name, total supply, and special addresses, for a specific asset ID. + +### Example Use Cases + +1. **Asset Details**: Developers can use this method to retrieve detailed information about a specific asset, including the address of the asset's creator, the name of the asset, the total supply of the asset, and any special addresses associated with the asset. + +### Request Parameters + +The `getAssetInformation` method requires the following parameter: + +- `assetId` (integer, required): An asset identifier representing the asset for which you want to retrieve information. + +### Return Object + +The method returns an object representing the asset information for the specified asset ID. The returned object includes details such as the asset's creator, name, total supply, and special addresses. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAssetTransactions.md b/v1.0/RPC Nodes/others/rpc-algorand/getAssetTransactions.md new file mode 100644 index 00000000..cfed0002 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAssetTransactions.md @@ -0,0 +1,87 @@ +--- +title: "getAssetTransactions" +slug: "rpc-algorand-getAssetTransactions" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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 +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const params = { + assetId: 123, // Specify the asset ID (number) for which you want to lookup transactions. + address: 'ALGORAND_ADDRESS', // Optional: Include transactions with this address in one of the transaction fields (string). + addressRole: 'sender', // Optional: Define what type of address to search for (enum: sender, receiver, freeze-target). + afterTime: '2023-11-06T00:00:00Z', // Optional: Include results after the given time (RFC 3339 formatted string). + beforeTime: '2023-11-07T00:00:00Z', // Optional: Include results before the given time (RFC 3339 formatted string). + currencyGreaterThan: 100, // Optional: Results should have an amount greater than this value (number). + currencyLessThan: 500, // Optional: Results should have an amount less than this value (number). + excludeCloseTo: true, // Optional: Exclude close-to addresses when searching for a specific address (boolean). + limit: 100, // Optional: Maximum number of results to return (number). + maxRound: 1000, // Optional: Include results at or before the specified max-round (number). + minRound: 900, // Optional: Include results at or after the specified min-round (number). + next: 'NEXT_PAGE_TOKEN', // Optional: The next page of results. Use the next token provided by the previous results (string). + notePrefix: 'PREFIX_TEXT', // Optional: Specify a prefix that must be contained in the note field (string). + rekeyTo: true, // Optional: Include results which include the rekey-to field (boolean). + round: 1000, // Optional: Include results for the specified round (number). + sigType: 'sig', // Optional: Filter results using the specified type of signature (enum: sig, msig, lsig). + txType: 'pay', // Optional: Filter results by transaction type (enum: pay, keyreg, acfg, axfer, afrz, appl, stpf). + txId: 'TRANSACTION_ID' // Optional: Lookup the specific transaction by ID (string). +}; + +// Lookup transactions for the specified asset +const assetTransactions = await tatum.rpc.getAssetTransactions(params); + +// Log the list of transactions related to the asset +console.log('Asset Transactions:', assetTransactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAssetTransactions` method allows you to lookup transactions for a specific asset. Transactions are returned in chronological order, from oldest to newest. + +### Request Parameters + +The method requires the following parameters: + +- `assetId` (number, required): Specify the asset ID for which you want to lookup transactions. +- `address` (string, optional): Include transactions with this address in one of the transaction fields. +- `addressRole` (enum, optional): Define what type of address to search for (sender, receiver, freeze-target). +- `afterTime` (string, optional): Include results after the given time (RFC 3339 formatted string). +- `beforeTime` (string, optional): Include results before the given time (RFC 3339 formatted string). +- `currencyGreaterThan` (number, optional): Results should have an amount greater than this value. +- `currencyLessThan` (number, optional): Results should have an amount less than this value. +- `excludeCloseTo` (boolean, optional): Exclude close-to addresses when searching for a specific address. +- `limit` (number, optional): Maximum number of results to return. +- `maxRound` (number, optional): Include results at or before the specified max-round. +- `minRound` (number, optional): Include results at or after the specified min-round. +- `next` (string, optional): The next page of results. Use the next token provided by the previous results. +- `notePrefix` (string, optional): Specify a prefix that must be contained in the note field. +- `rekeyTo` (boolean, optional): Include results which include the rekey-to field. +- `round` (number, optional): Include results for the specified round. +- `sigType` (enum, optional): Filter results using the specified type of signature ( + +### Return Object + +The method returns a list of transactions related to the specified asset. Transactions are returned in chronological order, from oldest to newest. Each transaction in the list includes details such as transaction ID, sender address, receiver address, transaction type, and more. + +Please note that the structure of the returned object may change in different RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getAssets.md b/v1.0/RPC Nodes/others/rpc-algorand/getAssets.md new file mode 100644 index 00000000..5b3e7556 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getAssets.md @@ -0,0 +1,71 @@ +--- +title: "getAssets" +slug: "rpc-algorand-getAssets" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters in a single object +const params = { + assetId: 123, // Optional: Asset ID (number). + creator: 'CREATOR_ADDRESS', // Optional: Filter assets with the given creator address (string). + includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (boolean). + limit: 100, // Optional: Maximum number of results to return (number). + name: 'ASSET_NAME', // Optional: Filter assets with the given name (string). + next: 'NEXT_PAGE_TOKEN', // Optional: The next page of results. Use the next token provided by the previous results (string). + unit: 'ASSET_UNIT' // Optional: Filter assets with the given unit (string). +}; + +// Search for assets using the Algorand Indexer +const assets = await tatum.rpc.getAssets(params); + +// Log the asset information +console.log('Algorand Assets:', assets); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getAssets` method allows you to search for assets in the Algorand blockchain. + +### Example Use Cases + +1. **Asset Search**: Developers can use this method to search for assets with specific criteria, such as asset ID, creator address, name, or unit. + +### Request Parameters + +The `getAssets` method requires the following parameters: + +- `assetId` (number, optional): Asset ID to filter assets by (number). +- `creator` (string, optional): Filter assets with the given creator address (string). +- `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates (boolean). +- `limit` (number, optional): Maximum number of results to return (number). +- `name` (string, optional): Filter assets with the given name (string). +- `next` (string, optional): The next page of results. Use the next token provided by the previous results (string). +- `unit` (string, optional): Filter assets with the given unit (string). + +### Return Object + +The method returns an array of asset information that matches the specified criteria. + +Please note that the structure of the returned object may change in different Algorand RPC versions. diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getBlock.md b/v1.0/RPC Nodes/others/rpc-algorand/getBlock.md new file mode 100644 index 00000000..e0b54fe4 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getBlock.md @@ -0,0 +1,57 @@ +--- +title: "getBlock" +slug: "rpc-algorand-getBlock" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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 +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const params = { + roundNumber: 1000, // Specify the round number (integer) for which you want to lookup the block. + headerOnly: true // Optional: Set to true to retrieve only the block header without transactions (boolean). +}; + +// Lookup the block for the specified round number +const blockInfo = await tatum.rpc.getBlock(params); + +// Log the block information +console.log('Block Information:', blockInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getBlock` method allows you to lookup a block by specifying its round number. You can retrieve both the block header and transactions, or only the block header using the `headerOnly` flag. + +### Request Parameters + +The method requires the following parameters: + +- `roundNumber` (number, required): Specify the round number for which you want to lookup the block. +- `headerOnly` (boolean, optional): Set to true to retrieve only the block header without transactions (boolean). + +### Return Object + +The method returns information about the specified block, which includes details such as the block's round number, timestamp, previous block ID, seed, transactions, and more. If the `headerOnly` flag is set to true, the returned object will contain only the block header information. + +Please note that the structure of the returned object may change in different RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getBlockHash.md b/v1.0/RPC Nodes/others/rpc-algorand/getBlockHash.md new file mode 100644 index 00000000..4b9ab6e0 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getBlockHash.md @@ -0,0 +1,59 @@ +--- +title: "getBlockHash" +slug: "rpc-algorand-getBlockHash" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + round: 12345, // Specify the round from which you want to fetch block hash information (integer). +}; + +// Get the block hash for the specified round +const blockHash = await tatum.rpc.getBlockHash(params); + +// Log the block hash +console.log('Block Hash:', blockHash); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getBlockHash` method allows you to fetch the block hash information for a specific block on the Algorand blockchain. + +### Example Use Cases + +1. **Retrieve Block Hash**: Developers can use this method to fetch the block hash for a specific block on the Algorand blockchain. + +### Request Parameters + +The `getBlockHash` method requires the following parameter: + +- `round` (integer, required): Specify the round from which you want to fetch block hash information. + +### Return Object + +The method returns an object representing the block hash of the specified round on the Algorand blockchain. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getGenesis.md b/v1.0/RPC Nodes/others/rpc-algorand/getGenesis.md new file mode 100644 index 00000000..e8b1eaed --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getGenesis.md @@ -0,0 +1,52 @@ +--- +title: "getGenesis" +slug: "rpc-algorand-getGenesis" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Retrieve the genesis information +const genesisInfo = await tatum.rpc.getGenesis(); + +// Log the genesis information +console.log('Algorand Genesis:', genesisInfo); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getGenesis` method allows you to retrieve the entire genesis file in JSON format. + +### Example Use Cases + +1. **Genesis Information**: Developers can use this method to retrieve the genesis information of the Algorand network, including details about the network configuration. + +### Request Parameters + +The `getGenesis` method does not require any parameters. + +### Return Object + +The method returns a string representing the entire genesis file in JSON format. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getHealth.md b/v1.0/RPC Nodes/others/rpc-algorand/getHealth.md new file mode 100644 index 00000000..1aed9bfa --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getHealth.md @@ -0,0 +1,50 @@ +--- +title: "getHealth" +slug: "rpc-algorand-getHealth" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_INDEXER }); + +// Check the health status of the Algorand node +const healthStatus = await tatum.rpc.health(); + +// Log the health status +console.log('Algorand Node Health Status:', healthStatus); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getHealth` method allows you to check the health status of the Algorand node connected to the Tatum SDK. It provides information about the node's availability and operational status. + +### Example Use Cases: + +1. **Node Monitoring:** Developers and operators can use this method to monitor the health of the Algorand node connected to their application and ensure it is operational. + +2. **Application Resilience:** It can be used to build resilience into your application by checking the health status of the node before making requests to it. + +### Return Object + +The method returns an object representing the health status of the Algorand Indexer node. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getLedgerStateDelta.md b/v1.0/RPC Nodes/others/rpc-algorand/getLedgerStateDelta.md new file mode 100644 index 00000000..e55d0d77 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getLedgerStateDelta.md @@ -0,0 +1,61 @@ +--- +title: "getLedgerStateDelta" +slug: "rpc-algorand-getLedgerStateDelta" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + round: 12345, // Specify the round for which the deltas are desired (number). + format: 'json' // Optional: Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON (enum: json, msgpack). +}; + +// Retrieve ledger deltas for the specified round +const ledgerStateDelta = await tatum.rpc.getLedgerStateDelta(params); + +// Log the ledger deltas +console.log('Ledger State Delta:', ledgerStateDelta); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgerStateDelta` method allows you to retrieve the ledger deltas for a specific round in the Algorand network. + +### Example Use Cases + +1. **Ledger Analysis**: Developers can use this method to retrieve the ledger deltas for a specific round and analyze the changes in the Algorand ledger. + +### Request Parameters + +The `getLedgerStateDelta` method requires the following parameters: + +- `round` (number, required): Specify the round for which the deltas are desired. +- `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded. If not provided, it defaults to JSON. + +### Return Object + +The method returns an object representing the ledger deltas for the specified round in the Algorand network. + +Please note that the structure and contents of the returned object may vary depending on the Algorand network and RPC version. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getLedgerSupply.md b/v1.0/RPC Nodes/others/rpc-algorand/getLedgerSupply.md new file mode 100644 index 00000000..eaf41789 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getLedgerSupply.md @@ -0,0 +1,52 @@ +--- +title: "getLedgerSupply" +slug: "rpc-algorand-getLedgerSupply" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Retrieve the current supply of MicroAlgos reported by the ledger +const supply = await tatum.rpc.getLedgerSupply(); + +// Log the current supply +console.log('Algorand Current Supply:', supply); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getLedgerSupply` method allows you to retrieve the current supply of MicroAlgos reported by the ledger. + +### Example Use Cases + +1. **Supply Information**: Developers can use this method to retrieve the current supply of MicroAlgos in the Algorand system. + +### Request Parameters + +The `getLedgerSupply` method does not require any parameters. + +### Return Object + +The method returns an object representing the current supply of MicroAlgos in the Algorand system. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getNodeStatus.md b/v1.0/RPC Nodes/others/rpc-algorand/getNodeStatus.md new file mode 100644 index 00000000..31539c67 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getNodeStatus.md @@ -0,0 +1,53 @@ +--- +title: "getNodeStatus" +slug: "rpc-algorand-getNodeStatus" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Retrieve the current node status +const nodeStatus = await tatum.rpc.getNodeStatus(); + +// Log the node status +console.log('Algorand Node Status:', nodeStatus); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getNodeStatus` method allows you to retrieve the current status of an Algorand node. + +### Example Use Cases + +1. **Check Node Status**: Developers can use this method to check the status of an Algorand node and get information about the node's catchup progress, last round seen, consensus version details, and more. + +### Request Parameters + +The `getNodeStatus` method does not require any parameters. + +### Return Object + +The method returns an object representing the current status of the Algorand node. The object contains information about the node's catchup progress, last round seen, consensus version details, and more. + +Please note that the structure of the returned object may change in different Algorand RPC versions. +``` diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getNodeStatusAfterRound.md b/v1.0/RPC Nodes/others/rpc-algorand/getNodeStatusAfterRound.md new file mode 100644 index 00000000..3d32ea21 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getNodeStatusAfterRound.md @@ -0,0 +1,59 @@ +--- +title: "getNodeStatusAfterRound" +slug: "rpc-algorand-getNodeStatusAfterRound" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + round: 10000 // Specify the round to wait until returning status. +}; + +// Wait for a block to appear after the specified round and return the node's status at the time +const nodeStatus = await tatum.rpc.getNodeStatusAfterRound(params); + +// Log the node status +console.log('Algorand Node Status:', nodeStatus); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getNodeStatusAfterRound` method allows you to wait for a block to appear after a specified round and returns the node's status at that time. + +### Example Use Cases + +1. **Wait for Block**: Developers can use this method to wait for a specific round and retrieve the node's status when a block appears after that round. + +### Request Parameters + +The `getNodeStatusAfterRound` method requires the following parameter: + +- `round` (integer, required): The round to wait until returning status. + +### Return Object + +The method returns an object representing the node's status at the time a block appears after the specified round. The object includes various properties that provide information about the node's status, such as catchpoints, catchup progress, last round seen, consensus version, and voting information. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getPendingTransactions.md b/v1.0/RPC Nodes/others/rpc-algorand/getPendingTransactions.md new file mode 100644 index 00000000..05904b05 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getPendingTransactions.md @@ -0,0 +1,63 @@ +--- +title: "getPendingTransactions" +slug: "rpc-algorand-getPendingTransactions" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + max: 10, // Optional: Truncated number of transactions to display. If max=0, returns all pending txns (number). + format: 'json', // Optional: Configures whether the response object is JSON or MessagePack encoded (enum: json, msgpack). +}; + +// Retrieve the list of pending transactions +const pendingTransactions = await tatum.rpc.getPendingTransactions(params); + +// Log the pending transactions +console.log('Pending Transactions:', pendingTransactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getPendingTransactions` method allows you to retrieve the list of unconfirmed transactions currently in the transaction pool. + +### Example Use Cases + +1. **Monitor Pending Transactions**: Developers can use this method to monitor and retrieve information about pending transactions in the transaction pool. + +### Request Parameters + +The `getPendingTransactions` method requires the following parameters: + +- `max` (number, optional): Truncated number of transactions to display. If max = 0, returns all pending transactions. +- `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON. + +### Return Object + +The method returns a potentially truncated list of transactions currently in the node's transaction pool. This includes an array of signed transaction objects as they were submitted, along with the total number of transactions in the pool. + +You can compute whether or not the list is truncated if the number of elements in the `top-transactions` array is fewer than `total-transactions`. + +Please note that the structure of the returned object may vary depending on the Algorand RPC version. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getTransaction.md b/v1.0/RPC Nodes/others/rpc-algorand/getTransaction.md new file mode 100644 index 00000000..6b1ddb54 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getTransaction.md @@ -0,0 +1,53 @@ +--- +title: "getTransaction" +slug: "rpc-algorand-getTransaction" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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 +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const txId = { txId : 'TRANSACTION_ID'}; // Specify the transaction ID you want to lookup (string). + +// Lookup a single transaction by its ID +const transaction = await tatum.rpc.getTransactionById(txId); + +// Log the transaction information +console.log('Transaction Information:', transaction); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransactionById` method allows you to lookup a single transaction by its unique transaction ID. + +### Request Parameters + +The method requires the following parameter: + +- `txId` (string, required): Specify the transaction ID you want to lookup. + +### Return Object + +The method returns information about the specified transaction, including details such as the transaction's ID, sender address, receiver address, transaction type, amount, and more. + +Please note that the structure of the returned object may change in different RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getTransactionParams.md b/v1.0/RPC Nodes/others/rpc-algorand/getTransactionParams.md new file mode 100644 index 00000000..4ccc015a --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getTransactionParams.md @@ -0,0 +1,59 @@ +--- +title: "getTransactionParams" +slug: "rpc-algorand-getTransactionParams" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Retrieve transaction parameters for constructing a new transaction +const transactionParams = await tatum.rpc.getTransactionParams(); + +// Log the transaction parameters +console.log('Transaction Parameters:', transactionParams); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransactionParams` method allows you to retrieve the parameters that help a client construct a new transaction in Algorand. + +### Example Use Cases + +1. **Transaction Construction**: Developers can use this method to get the necessary parameters required for constructing a new transaction in Algorand. + +### Request Parameters + +The `getTransactionParams` method does not require any parameters. + +### Return Object + +The method returns an object representing the parameters that help a client construct a new transaction in Algorand. The returned object includes the following properties: + +- `consensus-version` (string): Indicates the consensus protocol version as of LastRound. +- `fee` (integer): The suggested transaction fee. The fee is in units of micro-Algos per byte. The fee may fall to zero but transactions must still have a fee of at least MinTxnFee for the current network protocol. +- `genesis-hash` (string): The hash of the genesis block. +- `genesis-id` (string): An ID listed in the genesis block. +- `last-round` (integer): Indicates the last round seen. +- `min-fee` (integer): The minimum transaction fee (not per byte) required for the transaction to validate for the current network protocol. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getTransactionProof.md b/v1.0/RPC Nodes/others/rpc-algorand/getTransactionProof.md new file mode 100644 index 00000000..145d2373 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getTransactionProof.md @@ -0,0 +1,71 @@ +--- +title: "getTransactionProof" +slug: "rpc-algorand-getTransactionProof" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Define the input parameters in a single object +const params = { + round: ROUND_NUMBER, // Specify the round in which the transaction appears. + txid: 'TRANSACTION_ID', // Specify the transaction ID for which to generate a proof. + format: 'json', // Optional: Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON. + hashtype: 'sha512_256' // Optional: The type of hash function used to create the proof, must be one of: sha512_256 or sha256. +}; + +// Generate a proof for a transaction in a block +const transactionProof = await tatum.rpc.getTransactionProof(params); + +// Log the transaction proof +console.log('Transaction Proof:', transactionProof); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransactionProof` method allows you to get a proof for a transaction in a block. + +### Example Use Cases + +1. **Transaction Verification**: Developers can use this method to get a proof for a transaction in a block in order to verify the authenticity and integrity of the transaction. + +### Request Parameters + +The `getTransactionProof` method requires the following parameters: + +- `round` (integer, required): Specify the round in which the transaction appears. +- `txid` (string, required): Specify the transaction ID for which to generate a proof. +- `hashtype` (enum: sha512_256, sha256, optional): The type of hash function used to create the proof, must be one of: sha512_256 or sha256. +- `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded. If not provided, defaults to JSON. + +### Return Object + +The method returns an object representing the proof of the specified transaction in a block. The object includes the following properties: + +- `hashtype` (string): The type of hash function used to create the proof, must be one of: sha512_256 or sha256. +- `idx` (integer): Index of the transaction in the block's payset. +- `proof` (string): Proof of transaction membership. +- `stibhash` (string): Hash of SignedTxnInBlock for verifying the proof. +- `treedepth` (integer): Represents the depth of the tree that is being proven, i.e. the number of edges from a leaf to the root. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/getTransactions.md b/v1.0/RPC Nodes/others/rpc-algorand/getTransactions.md new file mode 100644 index 00000000..c7742bfa --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/getTransactions.md @@ -0,0 +1,91 @@ +--- +title: "getTransactions" +slug: "rpc-algorand-getTransactions" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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 +const tatum = await TatumSDK.init({ network: Network.ALGORAND_INDEXER }); + +// Define the input parameters as a dictionary object +const params = { + address: 'ALGORAND_ADDRESS', // Optional: Only include transactions with this address in one of the transaction fields (string). + addressRole: 'sender', // Optional: Combine with the address parameter to define what type of address to search for (enum: sender, receiver, freeze-target). + afterTime: '2023-11-06T00:00:00Z', // Optional: Include results after the given time (RFC 3339 formatted string). + applicationId: 123, // Optional: Application ID (integer). + assetId: 456, // Optional: Asset ID (integer). + beforeTime: '2023-11-07T00:00:00Z', // Optional: Include results before the given time (RFC 3339 formatted string). + currencyGreaterThan: 100, // Optional: Results should have an amount greater than this value (number). + currencyLessThan: 500, // Optional: Results should have an amount less than this value (number). + excludeCloseTo: true, // Optional: Combine with address and address-role parameters to define what type of address to search for (boolean). + limit: 100, // Optional: Maximum number of results to return (number). + maxRound: 1000, // Optional: Include results at or before the specified max-round (number). + minRound: 900, // Optional: Include results at or after the specified min-round (number). + next: 'NEXT_PAGE_TOKEN', // Optional: The next page of results. Use the next token provided by the previous results (string). + notePrefix: 'PREFIX_TEXT', // Optional: Specify a prefix that must be contained in the note field (string). + rekeyTo: true, // Optional: Include results which include the rekey-to field (boolean). + round: 1000, // Optional: Include results for the specified round (number). + sigType: 'sig', // Optional: Filter results using the specified type of signature (enum: sig, msig, lsig). + txType: 'pay', // Optional: Filter results by transaction type (enum: pay, keyreg, acfg, axfer, afrz, appl, stpf). + txId: 'TRANSACTION_ID' // Optional: Lookup the specific transaction by ID (string). +}; + +// Search for transactions based on the specified parameters +const transactions = await tatum.rpc.getTransactions(params); + +// Log the list of transactions that match the criteria +console.log('Transactions:', transactions); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `getTransactions` method allows you to search for transactions based on various criteria. Transactions can be filtered by address, address role, time, application ID, asset ID, currency amount, and more. By default, transactions are returned in chronological order from oldest to newest, but you can reverse the order using the `address` parameter. + +### Request Parameters + +The method requires the following parameters: + +- `address` (string, optional): Only include transactions with this address in one of the transaction fields. +- `addressRole` (enum, optional): Combine with the address parameter to define what type of address to search for (sender, receiver, freeze-target). +- `afterTime` (string, optional): Include results after the given time (RFC 3339 formatted string). +- `applicationId` (integer, optional): Application ID for filtering transactions. +- `assetId` (integer, optional): Asset ID for filtering transactions. +- `beforeTime` (string, optional): Include results before the given time (RFC 3339 formatted string). +- `currencyGreaterThan` (number, optional): Results should have an amount greater than this value. +- `currencyLessThan` (number, optional): Results should have an amount less than this value. +- `excludeCloseTo` (boolean, optional): Combine with address and address-role parameters to define what type of address to search for. +- `limit` (number, optional): Maximum number of results to return. +- `maxRound` (number, optional): Include results at or before the specified max-round. +- `minRound` (number, optional): Include results at or after the specified min-round. +- `next` (string, optional): The next page of results. Use the next token provided by the previous results. +- `notePrefix` (string, optional): Specifies a prefix that must be contained in the note field. +- `rekeyTo` (boolean, optional): Include results which include the rekey-to field. +- `round` (number, optional): Include results for the specified round. +- `sigType` (enum, optional): Filter results using the specified type of signature (sig, msig, lsig). +- `txType` (enum, optional): Filter results by transaction type (pay, keyreg, acfg, axfer, afrz, appl, stpf). +- `txId` (string, optional): Lookup the specific transaction by ID. + +### Return Object + +The method returns a list of transactions that match the specified criteria. Transactions include details such as transaction ID, sender address, receiver address, transaction type, and more. The order of results can be reversed based on the `address` parameter. + +Please note that the structure of the returned object may change in different RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/isHealthy.md b/v1.0/RPC Nodes/others/rpc-algorand/isHealthy.md new file mode 100644 index 00000000..10784338 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/isHealthy.md @@ -0,0 +1,50 @@ +--- +title: "isHealthy" +slug: "rpc-algorand-isHealthy" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Retrieve health check status for the Algorand node +const isHealthy = await tatum.rpc.isHealthy(); + +// Log the health check status +console.log('Algorand Health Check:', isHealthy); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `isHealthy` method allows you to check the health of the Algorand node. + +### Example Use Cases + +1. **Health Monitoring**: Developers can use this method to regularly monitor the health status of the Algorand node and ensure that it is functioning properly. + +### Request Parameters + +The `isHealthy` method does not require any parameters. + +### Return Object + +The method returns an empty object with a response code indicating the health status of the Algorand node. diff --git a/v1.0/RPC Nodes/others/rpc-algorand/isReady.md b/v1.0/RPC Nodes/others/rpc-algorand/isReady.md new file mode 100644 index 00000000..d5ac72d9 --- /dev/null +++ b/v1.0/RPC Nodes/others/rpc-algorand/isReady.md @@ -0,0 +1,52 @@ +--- +title: "isReady" +slug: "rpc-algorand-isReady" +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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/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({ network: Network.ALGORAND_ALGOD }); + +// Retrieve the health status of the Algorand node +const readyStatus = await tatum.rpc.isReady(); + +// Log the health status +console.log('Algorand Node Ready:', readyStatus); + +// Always destroy the Tatum SDK instance when done to stop any background processes +await tatum.destroy(); +``` + +### Overview + +The `isReady` method allows you to check the health status of the Algorand node and confirm if it is fully caught up. + +### Example Use Cases + +1. **Node Health Check**: Developers can use this method to check if the Algorand node is healthy and fully caught up, ensuring that it is ready to process requests. + +### Request Parameters + +The `isReady` method does not require any parameters. + +### Return Object + +The method returns a response indicating the health status of the Algorand node. + +Please note that the structure of the returned object may change in different Algorand RPC versions. \ No newline at end of file diff --git a/v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-simulateTransaction.md b/v1.0/RPC Nodes/others/rpc-algorand/simulateTransaction.md similarity index 98% rename from v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-simulateTransaction.md rename to v1.0/RPC Nodes/others/rpc-algorand/simulateTransaction.md index e73efb8b..bc2a2757 100644 --- a/v1.0/RPC Nodes/others/rpc-algorand/rpc-algorand-simulateTransaction.md +++ b/v1.0/RPC Nodes/others/rpc-algorand/simulateTransaction.md @@ -1,6 +1,6 @@ --- title: "simulateTransaction" -slug: "rpc-algorand-simulatetransaction" +slug: "rpc-algorand-simulateTransaction" excerpt: "Algorand RPC" category: 65c5e93c623cad004b45d505 hidden: false @@ -12,7 +12,8 @@ metadata: 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":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block]\n +[block:html]{"html":"
\n
Archive Method
\n

Only on the full archive nodes. Complex queries might take longer and incur additional cost

\n
"}[/block] + ### How to use it ```typescript