Skip to content

Commit

Permalink
Adding Other Chains
Browse files Browse the repository at this point in the history
  • Loading branch information
productshiv committed Apr 6, 2024
1 parent d5ec28c commit d7fc0aa
Show file tree
Hide file tree
Showing 358 changed files with 35,105 additions and 0 deletions.
8 changes: 8 additions & 0 deletions v1.0/RPC Nodes/rpc-others.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Others"
slug: "rpc-others"
excerpt: ""
hidden: false
createdAt: "Wed Mar 06 2024 10:35:03 GMT+0000 (Coordinated Universal Time)"
updatedAt: "Sat Apr 06 2024 12:59:34 GMT+0000 (Coordinated Universal Time)"
---
8 changes: 8 additions & 0 deletions v1.0/RPC Nodes/rpc-others/rpc-algorand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Algorand"
slug: "rpc-algorand"
excerpt: ""
hidden: false
createdAt: "Wed Mar 06 2024 10:35:18 GMT+0000 (Coordinated Universal Time)"
updatedAt: "Sat Apr 06 2024 12:59:38 GMT+0000 (Coordinated Universal Time)"
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "broadcastTransaction"
slug: "rpc-algorand-broadcasttransaction"
excerpt: "Algorand RPC"
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: "Sat Apr 06 2024 13:09:02 GMT+0000 (Coordinated Universal Time)"
---



### How to use it

```typescript
// Import required libraries and modules from Tatum SDK
import { TatumSDK, AlgorandAlgod, Network } from '@tatumio/tatum';

// Initialize the Tatum SDK for Algorand
const tatum = await TatumSDK.init<AlgorandAlgod>({ network: Network.ALGORAND_ALGOD });

// Define the input parameters in a single object
const params = {
broadcastTransaction: 'RAW_TRANSACTION', // Specify the byte encoded signed transaction to broadcast to network.
};

// Broadcast raw transaction to Algorand network
const transactionId = await tatum.rpc.broadcastTransaction(params);

// Log the transaction ID
console.log('Algorand Transaction ID:', transactionId);

// Always destroy the Tatum SDK instance when done to stop any background processes
await tatum.destroy();
```

### Overview

The `broadcastTransaction` method allows you to broadcast a raw transaction or transaction group to the Algorand network.

### Example Use Cases

1. **Transaction Broadcasting**: Developers can use this method to directly broadcast a byte encoded signed transaction to the Algorand network for further processing.

### Request Parameters

The `broadcastTransaction` method requires the following parameters:

- `broadcastTransaction` (string, required): The byte encoded signed transaction to broadcast to the Algorand network.

### Return Object

The method returns an object representing the transaction ID of the submitted transaction on the Algorand network.

Please note that the structure of the returned object may change in different Algorand RPC versions.
61 changes: 61 additions & 0 deletions v1.0/RPC Nodes/rpc-others/rpc-algorand/rpc-algorand-getaccount.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "getAccount"
slug: "rpc-algorand-getaccount"
excerpt: "Algorand RPC"
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: "Sat Apr 06 2024 13:09:05 GMT+0000 (Coordinated Universal Time)"
---



\\n

### How to use it

```typescript
// Import required libraries and modules from Tatum SDK
import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum';

// Initialize the Tatum SDK for Algorand
const tatum = await TatumSDK.init<AlgorandIndexer>({ network: Network.ALGORAND_INDEXER });

// Define the input parameters as an object
const accountAddress = { address: 'ALGORAND_ACCOUNT_ADDRESS' }; // Replace with the Algorand account address you want to retrieve information for.

// Retrieve account information using the Algorand Indexer
const accountInfo = await tatum.rpc.getAccount(accountAddress);

// 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 `getAccount` method allows you to retrieve detailed information about a specific Algorand account based on its account address.

### Example Use Cases

1. **Account Balance**: Developers can use this method to check the balance of a specific Algorand account by providing its address.

2. **Account Details**: Retrieve various details of an Algorand account, including its transactions, assets, and more, for further analysis.

### Request Parameters

The `getAccount` method requires the following parameter:

- `account-address` (string, required): The Algorand account 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.
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: "getAccountApplicationInfo"
slug: "rpc-algorand-getaccountapplicationinfo"
excerpt: "Algorand RPC"
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: "Sat Apr 06 2024 13:09:05 GMT+0000 (Coordinated Universal Time)"
---



### How to use it

```typescript
// Import required libraries and modules from Tatum SDK
import { TatumSDK, AlgorandAlgod, Network } from '@tatumio/tatum';

// Initialize the Tatum SDK for Algorand
const tatum = await TatumSDK.init<AlgorandAlgod>({ network: Network.ALGORAND_ALGOD });

// Define the input parameters in a single object
const params = {
address: 'ALGORAND_PUBLIC_KEY', // Specify the Algorand account public key.
applicationId: 12345, // Specify the application identifier.
format: 'json' // Optional: Configures whether the response object is JSON or MessagePack encoded (enum: json, msgpack).
};

// Retrieve account application information for the Algorand account
const accountApplicationInfo = await tatum.rpc.getAccountApplicationInfo(params);

// Log the account application information
console.log('Algorand Account Application Information:', accountApplicationInfo);

// Always destroy the Tatum SDK instance when done to stop any background processes
await tatum.destroy();
```

### Overview

The `getAccountApplicationInfo` method allows you to retrieve the account's application local state and global state for a specific Algorand account and application ID.

### Example Use Cases

1. **Retrieve Application State**: Developers can use this method to retrieve the application state (local and global) for a specific Algorand account.

### Request Parameters

The `getAccountApplicationInfo` method requires the following parameters:

- `address` (string, required): An Algorand account public key.
- `applicationId` (number, required): An application identifier.
- `format` (enum: json, msgpack, optional): Configures whether the response object is JSON or MessagePack encoded.

### Return Object

The method returns an object representing the account's application local state and global state (if exists) for the specified Algorand account and application ID.

Please note that the structure of the returned object may change in different Algorand RPC versions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "getAccountApplications"
slug: "rpc-algorand-getaccountapplications"
excerpt: "Algorand RPC"
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: "Sat Apr 06 2024 13:09:04 GMT+0000 (Coordinated Universal Time)"
---



### How to use it

```typescript
// Import required libraries and modules from Tatum SDK
import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum';

// Initialize the Tatum SDK for Algorand
const tatum = await TatumSDK.init<AlgorandIndexer>({ network: Network.ALGORAND_INDEXER });

// Define the input parameters in a single object
const params = {
accountId: 'ALGORAND_ACCOUNT_ID', // Specify the Algorand account ID for which you want to retrieve created applications.
applicationId: 123, // Optional: Specify the application ID (number) for filtering.
includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states (boolean).
limit: 100, // Optional: Maximum number of results to return (number).
next: 'NEXT_PAGE_TOKEN' // Optional: The next page of results. Use the next token provided by the previous results (string).
};

// Retrieve created application parameters for the Algorand account
const createdApplications = await tatum.rpc.getAccountApplications(params);

// Log the created application parameters
console.log('Algorand Account Created Applications:', createdApplications);

// Always destroy the Tatum SDK instance when done to stop any background processes
await tatum.destroy();
```

### Overview

The `getAccountApplications` method allows you to retrieve the created application parameters of a specific Algorand account.

### Example Use Cases

1. **Application Parameters**: Developers can use this method to retrieve the parameters of applications created by an Algorand account, including information about specific applications and their details.

### Request Parameters

The `getAccountApplications` method requires the following parameters:

- `accountId` (string, required): Specify the Algorand account ID for which you want to retrieve created application parameters.
- `applicationId` (number, optional): Specify the application ID for filtering the results.
- `includeAll` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states.
- `limit` (number, optional): Maximum number of results to return.
- `next` (string, optional): The next page of results. Use the next token provided by the previous results.

### Return Object

The method returns an object representing the created application parameters of the specified Algorand account, including information about specific applications and their details.

Please note that the structure of the returned object may change in different Algorand RPC versions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "getAccountApssLocalState"
slug: "rpc-algorand-getaccountapsslocalstate"
excerpt: "Algorand RPC"
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: "Sat Apr 06 2024 13:09:03 GMT+0000 (Coordinated Universal Time)"
---



### How to use it

```typescript
// Import required libraries and modules from Tatum SDK
import { TatumSDK, AlgorandIndexer, Network } from '@tatumio/tatum';

// Initialize the Tatum SDK for Algorand
const tatum = await TatumSDK.init<AlgorandIndexer>({ network: Network.ALGORAND_INDEXER });

// Define optional query parameters
const params = {
accountId: 'ALGORAND_ACCOUNT_ID', // Replace with the Algorand account ID for which you want to retrieve local application state.
applicationId: 123, // Optional: Specify the application ID (number) for filtering.
includeAll: true, // Optional: Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states (boolean).
limit: 100, // Optional: Maximum number of results to return (number).
next: 'NEXT_PAGE_TOKEN' // Optional: The next page of results. Use the next token provided by the previous results (string).
};

// Retrieve local application state for the Algorand account
const appsLocalState = await tatum.rpc.getAccountAppsLocalState(params);

// Log the local application state information
console.log('Algorand Account Local Application State:', appsLocalState);

// Always destroy the Tatum SDK instance when done to stop any background processes
await tatum.destroy();
```

### Overview

The `getAccountAppsLocalState` method allows you to retrieve the local application state of a specific Algorand account.

### Example Use Cases

1. **Application State**: Developers can use this method to retrieve the local application state of an Algorand account, including information about its asset holdings and applications.

### Request Parameters

The `getAccountAppsLocalState` method requires the following parameters:

- `account-id` (string, required): The Algorand account ID for which you want to retrieve local application state.
- `application-id` (number, optional): Specify the application ID for filtering the results.
- `include-all` (boolean, optional): Include all items, including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application local states.
- `limit` (number, optional): Maximum number of results to return.
- `next` (string, optional): The next page of results. Use the next token provided by the previous results.

### Return Object

The method returns an object representing the local application state of the specified Algorand account, including information about asset holdings and applications.

Please note that the structure of the returned object may change in different Algorand RPC versions.
Loading

0 comments on commit d7fc0aa

Please sign in to comment.