@ar.io/sdk


This is the home of the ar.io SDK. This SDK provides functionality for interacting with the ar.io ecosystem of services (e.g. gateways and observers) and protocols (e.g. ArNS and AO). It is available for both NodeJS and Web environments.

Table of Contents

- Table of Contents
- Installation
- Quick Start
- Usage
- ARIO Contract
- ANT Contracts
- Token Conversion
- Logging
- Pagination
- Resources
- Developers

Installation

Requires node>=v18.0.0

``shell
npm install @ar.io/sdk
`

or

`shell
yarn add @ar.io/sdk --ignore-engines
`

> [!NOTE]
> The --ignore-engines flag is required when using yarn, as [permaweb/aoconnect] recommends only the use of npm. Alternatively, you can add a .yarnrc.yml file to your project containing ignore-engines true to ignore the engines check.

Quick Start

`typescript
import { ARIO } from "@ar.io/sdk";

const ario = ARIO.mainnet(); // defaults to mainnet
const gateways = await ario.getGateways();
`

Output

`json
{
"items": [
{
"gatewayAddress": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"observerAddress": "IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs",
"operatorStake": 250000000000,
"settings": {
"fqdn": "ar-io.dev",
"label": "ar.io Test",
"note": "Test Gateway operated by PDS for the ar.io ecosystem.",
"port": 443,
"properties": "raJgvbFU-YAnku-WsupIdbTsqqGLQiYpGzoqk9SCVgY",
"protocol": "https"
},
"startTimestamp": 1720720621424,
"stats": {
"failedConsecutiveEpochs": 0,
"passedEpochCount": 30,
"submittedEpochCount": 30,
"totalEpochCount": 31,
"totalEpochsPrescribedCount": 31
},
"status": "joined",
"vaults": {},
"weights": {
"compositeWeight": 0.97688888893556,
"gatewayPerformanceRatio": 1,
"tenureWeight": 0.19444444444444,
"observerRewardRatioWeight": 1,
"normalizedCompositeWeight": 0.19247316211083,
"stakeWeight": 5.02400000024
}
}
],
"hasMore": true,
"nextCursor": "-4xgjroXENKYhTWqrBo57HQwvDL51mMdfsdsxJy6Y2Z_sA",
"totalItems": 316,
"sortBy": "startTimestamp",
"sortOrder": "desc"
}
`

Usage

The SDK is provided in both CommonJS and ESM formats and is compatible with bundlers such as Webpack, Rollup, and ESbuild. Utilize the appropriately named exports provided by this SDK's [package.json] based on your project's configuration. Refer to the [examples] directory to see how to use the SDK in various environments.

$3

> [!WARNING]
> Polyfills are not provided by default for bundled web projects (Vite, ESBuild, Webpack, Rollup, etc.) . Depending on your apps bundler configuration and plugins, you will need to provide polyfills for various imports including crypto, process and buffer. Refer to [examples/webpack] and [examples/vite] for examples. For other project configurations, refer to your bundler's documentation for more information on how to provide the necessary polyfills.

#### Bundlers (Webpack, Rollup, ESbuild, etc.)

`javascript
import { ARIO } from "@ar.io/sdk/web";

// set up client
const ario = ARIO.mainnet();
// fetch gateways
const gateways = await ario.getGateways();
`

#### Browser

`html

`

$3

#### ESM (NodeNext)

`javascript
import { ARIO } from "@ar.io/sdk/node";

// set up client
const ario = ARIO.mainnet();
// fetch gateways
const gateways = await ario.getGateways();
`

#### CJS

`javascript
import { ARIO } from "@ar.io/sdk";

// set up client
const ario = ARIO.mainnet();
// fetch gateways
const gateways = await ario.getGateways();
`

$3

The SDK provides TypeScript types. When you import the SDK in a TypeScript project types are exported from ./lib/types/[node/web]/index.d.ts and should be automatically recognized by package managers, offering benefits such as type-checking and autocompletion.

> [!NOTE]
> Typescript version 5.3 or higher is recommended.

ARIO Contract

$3

#### init({ signer })

Factory function to that creates a read-only or writeable client. By providing a signer additional write APIs that require signing, like joinNetwork and delegateStake are available. By default, a read-only client is returned and no write APIs are available.

`typescript
// read-only client
const ario = ARIO.init();

// read-write client for browser environments
const ario = ARIO.init({
signer: new ArConnectSigner(window.arweaveWallet, Arweave.init({})),
});

// read-write client for node environments
const ario = ARIO.init({ signer: new ArweaveSigner(JWK) });
`

#### getInfo()

Retrieves the information of the ARIO process.

`typescript
const ario = ARIO.mainnet();
const info = await ario.getInfo();
`

Output

`json
{
"Name": "ARIO",
"Ticker": "ARIO",
"Owner": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"Denomination": 6,
"Handlers": ["_eval", "_default_"], // full list of handlers, useful for debugging
"LastCreatedEpochIndex": 31, // epoch index of the last tick
"LastDistributedEpochIndex": 31 // epoch index of the last distribution
}
`

#### getTokenSupply()

Retrieves the total supply of tokens, returned in mARIO. The total supply includes the following:

- total - the total supply of all tokens
- circulating - the total supply minus locked, withdrawn, delegated, and staked
- locked - tokens that are locked in the protocol (a.k.a. vaulted)
- withdrawn - tokens that have been withdrawn from the protocol by operators and delegators
- delegated - tokens that have been delegated to gateways
- staked - tokens that are staked in the protocol by gateway operators
- protocolBalance - tokens that are held in the protocol's treasury. This is included in the circulating supply.

`typescript
const ario = ARIO.mainnet();
const supply = await ario.getTokenSupply();
`

Output

`json
{
"total": 1000000000000000000,
"circulating": 998094653842520,
"locked": 0,
"withdrawn": 560563387278,
"delegated": 1750000000,
"staked": 1343032770199,
"protocolBalance": 46317263683761
}
`

#### getBalance({ address })

Retrieves the balance of the specified wallet address.

`typescript
const ario = ARIO.mainnet();
// the balance will be returned in mARIO as a value
const balance = await ario
.getBalance({
address: "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
})
.then((balance: number) => new mARIOToken(balance).toARIO()); // convert it to ARIO for readability
`

Output

`json
100000
`

#### getBalances({ cursor, limit, sortBy, sortOrder })

Retrieves the balances of the ARIO process in mARIO, paginated and sorted by the specified criteria. The cursor used for pagination is the last wallet address from the previous request.

`typescript
const ario = ARIO.mainnet();
const balances = await ario.getBalances({
cursor: "-4xgjroXENKYhTWqrBo57HQwvDL51mMdfsdsxJy6Y2Z_sA",
limit: 100,
sortBy: "balance",
sortOrder: "desc",
});
`

Output

`json
{
"items": [
{
"address": "-4xgjroXENKYhTWqrBo57HQwvDL51mMvSxJy6Y2Z_sA",
"balance": 1000000
},
{
"address": "-7vXsQZQDk8TMDlpiSLy3CnLi5PDPlAaN2DaynORpck",
"balance": 1000000
}
// ...98 other balances
],
"hasMore": true,
"nextCursor": "-7vXsQZQDk8TMDlpiSLy3CnLi5PDPlAaN2DaynORpck",
"totalItems": 1789,
"sortBy": "balance",
"sortOrder": "desc"
}
`

#### transfer({ target, qty })

Transfers mARIO to the designated target recipient address. Requires signer to be provided on ARIO.init to sign the transaction.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({
signer: new ArweaveSigner(jwk),
});
const { id: txId } = await ario.transfer(
{
target: "-5dV7nk7waR8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5",
qty: new ARIOToken(1000).toMARIO(),
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

$3

The SDK provides the following process IDs for the mainnet and testnet environments:

- ARIO_MAINNET_PROCESS_ID - Mainnet ARIO process ID (production)
- ARIO_TESTNET_PROCESS_ID - Testnet ARIO process ID (testing and development)
- ARIO_DEVNET_PROCESS_ID - Devnet ARIO process ID (development)

As of v3.8.1 the SDK defaults all API interactions to mainnet. To use the testnet or devnet provide the appropriate ARIO_TESTNET_PROCESS_ID or ARIO_DEVNET_PROCESS_ID when initializing the client.

#### Mainnet

As of v3.8.1 the SDK defaults all API interactions to mainnet. To use the testnet or devnet provide the appropriate ARIO_TESTNET_PROCESS_ID or ARIO_DEVNET_PROCESS_ID when initializing the client.

`typescript
import { ARIO } from "@ar.io/sdk";

const ario = ARIO.mainnet(); // or ARIO.init()
`

#### Testnet

`typescript
import { ARIO } from "@ar.io/sdk";

const testnet = ARIO.testnet(); // or ARIO.init({ processId: ARIO_TESTNET_PROCESS_ID })
`

##### Faucet

The SDK provides APIs for claiming tokens via a faucet on the ar.io Testnet process (tARIO) via the [ar-io-testnet-faucet] service. All token requests require a captcha to be solved, and the faucet is rate limited to prevent abuse.

To claim testnet tokens from the testnet token faucet, you can use one of the following methods:

1. Visit faucet.ar.io - the easiest way to quickly get tokens for testing for a single address.

2. Programmatically via the SDK - useful if you need to claim tokens for multiple addresses or dynamically within your application.
- ARIO.testnet().faucet.captchaUrl() - returns the captcha URL for the testnet faucet. Open this URL in a new browser window and listen for the ario-jwt-success event to be emitted.
- ARIO.testnet().faucet.claimWithAuthToken({ authToken, recipient, quantity }) - claims tokens for the specified recipient address using the provided auth token.
- ARIO.testnet().faucet.verifyAuthToken({ authToken }) - verifies if the provided auth token is still valid.

Example client-side code for claiming tokens

`typescript
import { ARIO } from "@ar.io/sdk";

const testnet = ARIO.testnet();
const captchaUrl = await ario.faucet.captchaUrl();

// open the captcha URL in the browser, and listen for the auth token event
const captchaWindow = window.open(
captchaUrl.captchaUrl,
"_blank",
"width=600,height=600",
);
/**
* The captcha URL includes a window.parent.postMessage event that is used to send the auth token to the parent window.
* You can store the auth token in localStorage and use it to claim tokens for the duration of the auth token's expiration (default 1 hour).
*/
window.parent.addEventListener("message", async (event) => {
if (event.data.type === "ario-jwt-success") {
localStorage.setItem("ario-jwt", event.data.token);
localStorage.setItem("ario-jwt-expires-at", event.data.expiresAt);
// close our captcha window
captchaWindow?.close();
// claim the tokens using the JWT token
const res = await testnet.faucet
.claimWithAuthToken({
authToken: event.data.token,
recipient: await window.arweaveWallet.getActiveAddress(),
quantity: new ARIOToken(100).toMARIO().valueOf(), // 100 ARIO
})
.then((res) => {
alert(
"Successfully claimed 100 ARIO tokens! Transaction ID: " + res.id,
);
})
.catch((err) => {
alert(Failed to claim tokens: ${err});
});
}
});

/**
* Once you have a valid JWT, you can check if it is still valid and use it for subsequent requests without having to open the captcha again.
*/
if (
localStorage.getItem("ario-jwt-expires-at") &&
Date.now() < parseInt(localStorage.getItem("ario-jwt-expires-at") ?? "0")
) {
const res = await testnet.faucet.claimWithAuthToken({
authToken: localStorage.getItem("ario-jwt") ?? "",
recipient: await window.arweaveWallet.getActiveAddress(),
quantity: new ARIOToken(100).toMARIO().valueOf(), // 100 ARIO
});
}
`

$3

#### getVault({ address, vaultId })

Retrieves the locked-balance user vault of the ARIO process by the specified wallet address and vault ID.

`typescript
const ario = ARIO.mainnet();
const vault = await ario.getVault({
address: "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
vaultId: "vaultIdOne",
});
`

Output

`json
{
"balance": 1000000,
"startTimestamp": 123,
"endTimestamp": 4567
}
`

#### getVaults({ cursor, limit, sortBy, sortOrder })

Retrieves all locked-balance user vaults of the ARIO process, paginated and sorted by the specified criteria. The cursor used for pagination is the last wallet address from the previous request.

`typescript
const ario = ARIO.mainnet();
const vaults = await ario.getVaults({
cursor: "0",
limit: 100,
sortBy: "balance",
sortOrder: "desc",
});
`

Output

`json
{
"items": [
{
"address": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"vaultId": "vaultIdOne",
"balance": 1000000,
"startTimestamp": 123,
"endTimestamp": 4567
},
{
"address": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"vaultId": "vaultIdTwo",
"balance": 1000000,
"startTimestamp": 123,
"endTimestamp": 4567
}
// ...98 other addresses with vaults
],
"hasMore": true,
"nextCursor": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"totalItems": 1789,
"sortBy": "balance",
"sortOrder": "desc"
}
`

#### vaultedTransfer({ recipient, quantity, lockLengthMs, revokable })

Transfers mARIO to the designated recipient address and locks the balance for the specified lockLengthMs milliseconds. The revokable flag determines if the vaulted transfer can be revoked by the sender.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.vaultedTransfer(
{
recipient: "-5dV7nk7waR8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5",
quantity: new ARIOToken(1000).toMARIO(),
lockLengthMs: 1000 60 60 24 365, // 1 year
revokable: true,
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### revokeVault({ recipient, vaultId })

Revokes a vaulted transfer by the recipient address and vault ID. Only the sender of the vaulted transfer can revoke it.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.revokeVault({
recipient: "-5dV7nk7waR8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5",
vaultId: "IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs",
});
`

#### createVault({ lockLengthMs, quantity })

Creates a vault for the specified quantity of mARIO from the signer's balance and locks it for the specified lockLengthMs milliseconds.

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });

const { id: txId } = await ario.createVault({
lockLengthMs: 1000 60 60 24 365, // 1 year
quantity: new ARIOToken(1000).toMARIO(),
});
`

#### extendVault({ vaultId, extendLengthMs })

Extends the lock length of a signer's vault by the specified extendLengthMs milliseconds.

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });

const { id: txId } = await ario.extendVault({
vaultId: "vaultIdOne",
extendLengthMs: 1000 60 60 24 365, // 1 year
});
`

#### increaseVault({ vaultId, quantity })

Increases the balance of a signer's vault by the specified quantity of mARIO.

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.increaseVault({
vaultId: "vaultIdOne",
quantity: new ARIOToken(1000).toMARIO(),
});
`

$3

#### getGateway({ address })

Retrieves a gateway's info by its staking wallet address.

`typescript
const ario = ARIO.mainnet();
const gateway = await ario.getGateway({
address: "-7vXsQZQDk8TMDlpiSLy3CnLi5PDPlAaN2DaynORpck",
});
`

Output

`json
{
"observerAddress": "IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs",
"operatorStake": 250000000000,
"settings": {
"fqdn": "ar-io.dev",
"label": "ar.io Test",
"note": "Test Gateway operated by PDS for the ar.io ecosystem.",
"port": 443,
"properties": "raJgvbFU-YAnku-WsupIdbTsqqGLQiYpGzoqk9SCVgY",
"protocol": "https"
},
"startTimestamp": 1720720620813,
"stats": {
"failedConsecutiveEpochs": 0,
"passedEpochCount": 30,
"submittedEpochCount": 30,
"totalEpochCount": 31,
"totalEpochsPrescribedCount": 31
},
"status": "joined",
"vaults": {},
"weights": {
"compositeWeight": 0.97688888893556,
"gatewayPerformanceRatio": 1,
"tenureWeight": 0.19444444444444,
"observerRewardRatioWeight": 1,
"normalizedCompositeWeight": 0.19247316211083,
"stakeWeight": 5.02400000024
}
}
`

#### getGateways({ cursor, limit, sortBy, sortOrder })

Retrieves registered gateways of the ARIO process, using pagination and sorting by the specified criteria. The cursor used for pagination is the last gateway address from the previous request.

`typescript
const ario = ARIO.mainnet();
const gateways = await ario.getGateways({
limit: 100,
sortOrder: "desc",
sortBy: "operatorStake",
});
`

Available sortBy options are any of the keys on the gateway object, e.g. operatorStake, start, status, settings.fqdn, settings.label, settings.note, settings.port, settings.protocol, stats.failedConsecutiveEpochs, stats.passedConsecutiveEpochs, etc.

Output

`json
{
"items": [
{
"gatewayAddress": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"observerAddress": "IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs",
"operatorStake": 250000000000,
"settings": {
"fqdn": "ar-io.dev",
"label": "ar.io Test",
"note": "Test Gateway operated by PDS for the ar.io ecosystem.",
"port": 443,
"properties": "raJgvbFU-YAnku-WsupIdbTsqqGLQiYpGzoqk9SCVgY",
"protocol": "https"
},
"startTimestamp": 1720720620813,
"stats": {
"failedConsecutiveEpochs": 0,
"passedEpochCount": 30,
"submittedEpochCount": 30,
"totalEpochCount": 31,
"totalEpochsPrescribedCount": 31
},
"status": "joined",
"vaults": {},
"weights": {
"compositeWeight": 0.97688888893556,
"gatewayPerformanceRatio": 1,
"tenureWeight": 0.19444444444444,
"observerRewardRatioWeight": 1,
"normalizedCompositeWeight": 0.19247316211083,
"stakeWeight": 5.02400000024
}
}
],
"hasMore": true,
"nextCursor": "-4xgjroXENKYhTWqrBo57HQwvDL51mMdfsdsxJy6Y2Z_sA",
"totalItems": 316,
"sortBy": "operatorStake",
"sortOrder": "desc"
}
`

#### getGatewayDelegates({ address, cursor, limit, sortBy, sortOrder })

Retrieves all delegates for a specific gateway, paginated and sorted by the specified criteria. The cursor used for pagination is the last delegate address from the previous request.

`typescript
const ario = ARIO.mainnet();
const delegates = await ario.getGatewayDelegates({
address: "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
limit: 3,
sortBy: "startTimestamp",
sortOrder: "desc",
});
`

Output

`json
{
"nextCursor": "ScEtph9-vfY7lgqlUWwUwOmm99ySeZGQhOX0MFAyFEs",
"limit": 3,
"sortBy": "startTimestamp",
"totalItems": 32,
"sortOrder": "desc",
"hasMore": true,
"items": [
{
"delegatedStake": 600000000,
"address": "qD5VLaMYyIHlT6vH59TgYIs6g3EFlVjlPqljo6kqVxk",
"startTimestamp": 1732716956301
},
{
"delegatedStake": 508999038,
"address": "KG8TlcWk-8pvroCjiLD2J5zkG9rqC6yYaBuZNqHEyY4",
"startTimestamp": 1731828123742
},
{
"delegatedStake": 510926479,
"address": "ScEtph9-vfY7lgqlUWwUwOmm99ySeZGQhOX0MFAyFEs",
"startTimestamp": 1731689356040
}
]
}
`

#### joinNetwork(params)

Joins a gateway to the ar.io network via its associated wallet.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.joinNetwork(
{
qty: new ARIOToken(10_000).toMARIO(), // minimum operator stake allowed
autoStake: true, // auto-stake operator rewards to the gateway
allowDelegatedStaking: true, // allows delegated staking
minDelegatedStake: new ARIOToken(100).toMARIO(), // minimum delegated stake allowed
delegateRewardShareRatio: 10, // percentage of rewards to share with delegates (e.g. 10%)
label: "john smith", // min 1, max 64 characters
note: "The example gateway", // max 256 characters
properties: "FH1aVetOoulPGqgYukj0VE0wIhDy90WiQoV3U2PeY44", // Arweave transaction ID containing additional properties of the Gateway
observerWallet: "0VE0wIhDy90WiQoV3U2PeY44FH1aVetOoulPGqgYukj", // wallet address of the observer, must match OBSERVER_WALLET on the observer
fqdn: "example.com", // fully qualified domain name - note: you must own the domain and set the OBSERVER_WALLET on your gateway to match observerWallet
port: 443, // port number
protocol: "https", // only 'https' is supported
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### leaveNetwork()

Sets the gateway as leaving on the ar.io network. Requires signer to be provided on ARIO.init to sign the transaction. The gateways operator and delegate stakes are vaulted and will be returned after leave periods. The gateway will be removed from the network after the leave period.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });

const { id: txId } = await ario.leaveNetwork(
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### updateGatewaySettings({ ...settings })

Writes new gateway settings to the callers gateway configuration.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.updateGatewaySettings(
{
// any other settings you want to update
minDelegatedStake: new ARIOToken(100).toMARIO(),
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### increaseDelegateStake({ target, qty })

Increases the callers stake on the target gateway.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.increaseDelegateStake(
{
target: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
qty: new ARIOToken(100).toMARIO(),
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### decreaseDelegateStake({ target, qty, instant })

Decreases the callers stake on the target gateway. Can instantly decrease stake by setting instant to true.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.decreaseDelegateStake(
{
target: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
qty: new ARIOToken(100).toMARIO(),
},
{
tags: [{ name: "App-Name", value: "My-Awesome-App" }],
},
);
`

Pay the early withdrawal fee and withdraw instantly.

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.decreaseDelegateStake({
target: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
qty: new ARIOToken(100).toMARIO(),
instant: true, // Immediately withdraw this stake and pay the instant withdrawal fee
});
`

#### getDelegations({ address, cursor, limit, sortBy, sortOrder })

Retrieves all active and vaulted stakes across all gateways for a specific address, paginated and sorted by the specified criteria. The cursor used for pagination is the last delegationId (concatenated gateway and startTimestamp of the delgation) from the previous request.

`typescript
const ario = ARIO.mainnet();
const vaults = await ario.getDelegations({
address: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
cursor: "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ_123456789",
limit: 2,
sortBy: "startTimestamp",
sortOrder: "asc",
});
`

Output

`json
{
"sortOrder": "asc",
"hasMore": true,
"totalItems": 95,
"limit": 2,
"sortBy": "startTimestamp",
"items": [
{
"type": "stake",
"startTimestamp": 1727815440632,
"gatewayAddress": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"delegationId": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ_1727815440632",
"balance": 1383212512
},
{
"type": "vault",
"startTimestamp": 1730996691117,
"gatewayAddress": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
"delegationId": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ_1730996691117",
"vaultId": "_sGDS7X1hyLCVpfe40GWioH9BSOb7f0XWbhHBa1q4-g",
"balance": 50000000,
"endTimestamp": 1733588691117
}
],
"nextCursor": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ_1730996691117"
}
`

#### instantWithdrawal({ gatewayAddress, vaultId })

Instantly withdraws an existing vault on a gateway. If no gatewayAddress is provided, the signer's address will be used.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
// removes a delegated vault from a gateway
const { id: txId } = await ario.instantWithdrawal(
{
// gateway address where delegate vault exists
gatewayAddress: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
// delegated vault id to cancel
vaultId: "fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3",
},
// optional additional tags
{
tags: [{ name: "App-Name", value: "My-Awesome-App" }],
},
);
// removes an operator vault from a gateway
const { id: txId } = await ario.instantWithdrawal({
vaultId: "fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3",
});
`

#### cancelWithdrawal({ gatewayAddress, vaultId })

Cancels an existing vault on a gateway. The vaulted stake will be returned to the callers stake. If no gatewayAddress is provided, the signer's address will be used.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
// cancels a delegated vault from a gateway
const { id: txId } = await ario.cancelWithdrawal(
{
// gateway address where vault exists
gatewayAddress: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
// vault id to cancel
vaultId: "fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3",
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
// cancels an operator vault from a gateway
const { id: txId } = await ario.cancelWithdrawal({
// operator vault id to cancel
vaultId: "fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3",
});
`

#### getAllowedDelegates({ address, cursor, limit, sortBy, sortOrder })

Retrieves all allowed delegates for a specific address. The cursor used for pagination is the last address from the previous request.

`typescript
const ario = ARIO.mainnet();
const allowedDelegates = await ario.getAllowedDelegates({
address: "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ",
});
`

Output

`json
{
"sortOrder": "desc",
"hasMore": false,
"totalItems": 4,
"limit": 100,
"items": [
"PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM",
"N4h8M9A9hasa3tF47qQyNvcKjm4APBKuFs7vqUVm-SI",
"JcC4ZLUY76vmWha5y6RwKsFqYTrMZhbockl8iM9p5lQ",
"31LPFYoow2G7j-eSSsrIh8OlNaARZ84-80J-8ba68d8"
]
}
`

#### getGatewayVaults({ address, cursor, limit, sortBy, sortOrder })

Retrieves all vaults across all gateways for a specific address, paginated and sorted by the specified criteria. The cursor used for pagination is the last vaultId from the previous request.

`typescript
const ario = ARIO.mainnet();
const vaults = await ario.getGatewayVaults({
address: '"PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM',
});
`

Output

`json
{
"sortOrder": "desc",
"hasMore": false,
"totalItems": 1,
"limit": 100,
"sortBy": "endTimestamp",
"items": [
{
"cursorId": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM_1728067635857",
"startTimestamp": 1728067635857,
"balance": 50000000000,
"vaultId": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM",
"endTimestamp": 1735843635857
}
]
}
`

#### getAllGatewayVaults({ cursor, limit, sortBy, sortOrder })

Retrieves all vaults across all gateways, paginated and sorted by the specified criteria. The cursor used for pagination is the last vaultId from the previous request.

`typescript
const ario = ARIO.mainnet();
const vaults = await ario.getAllGatewayVaults({
limit: 1,
sortBy: "endTimestamp",
sortOrder: "desc",
});
`

Output

`json
{
"sortOrder": "desc",
"hasMore": true,
"totalItems": 95,
"limit": 1,
"sortBy": "endTimestamp",
"items": [
{
"cursorId": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM_E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc",
"gatewayAddress": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM",
"startTimestamp": 1728067635857,
"balance": 50000000000,
"vaultId": "E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc",
"endTimestamp": 1735843635857
}
],
"nextCursor": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM_E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc"
}
`

#### increaseOperatorStake({ qty })

Increases the callers operator stake. Must be executed with a wallet registered as a gateway operator.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.increaseOperatorStake(
{
qty: new ARIOToken(100).toMARIO(),
},
{
tags: [{ name: "App-Name", value: "My-Awesome-App" }],
},
);
`

#### decreaseOperatorStake({ qty })

Decreases the callers operator stake. Must be executed with a wallet registered as a gateway operator. Requires signer to be provided on ARIO.init to sign the transaction.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.decreaseOperatorStake(
{
qty: new ARIOToken(100).toMARIO(),
},
{
tags: [{ name: "App-Name", value: "My-Awesome-App" }],
},
);
`

#### redelegateStake({ target, source, stakeQty, vaultId })

Redelegates the stake of a specific address to a new gateway. Vault ID may be optionally included in order to redelegate from an existing withdrawal vault. The redelegation fee is calculated based on the fee rate and the stake amount. Users are allowed one free redelegation every seven epochs. Each additional redelegation beyond the free redelegation will increase the fee by 10%, capping at a 60% redelegation fee.

e.g: If 1000 mARIO is redelegated and the fee rate is 10%, the fee will be 100 mARIO. Resulting in 900 mARIO being redelegated to the new gateway and 100 mARIO being deducted back to the protocol balance.

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });

const { id: txId } = await ario.redelegateStake({
target: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
source: "HwFceQaMQnOBgKDpnFqCqgwKwEU5LBme1oXRuQOWSRA",
stakeQty: new ARIOToken(1000).toMARIO(),
vaultId: "fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3",
});
`

#### getRedelegationFee({ address })

Retrieves the fee rate as percentage required to redelegate the stake of a specific address. Fee rate ranges from 0% to 60% based on the number of redelegations since the last fee reset.

`typescript
const ario = ARIO.mainnet();

const fee = await ario.getRedelegationFee({
address: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
});
`

Output

`json
{
"redelegationFeeRate": 10,
"feeResetTimestamp": 1730996691117
}
`

#### getAllDelegates({ cursor, limit, sortBy, sortOrder })

Retrieves all delegates across all gateways, paginated and sorted by the specified criteria. The cursor used for pagination is a cursorId derived from delegate address and the gatewayAddress from the previous request. e.g address_gatewayAddress.

`typescript
const ario = ARIO.mainnet();
const delegates = await ario.getAllDelegates({
limit: 2,
sortBy: "startTimestamp",
sortOrder: "desc",
});
`

Output

`json
{
"sortOrder": "desc",
"hasMore": true,
"totalItems": 95,
"limit": 2,
"sortBy": "startTimestamp",
"items": [
{
"startTimestamp": 1734709397622,
"cursorId": "9jfM0uzGNc9Mkhjo1ixGoqM7ygSem9wx_EokiVgi0Bs_E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc",
"gatewayAddress": "E-QVU3dta36Wia2uQw6tQLjQk7Qw5uN0Z6fUzsoqzUc",
"address": "9jfM0uzGNc9Mkhjo1ixGoqM7ygSem9wx_EokiVgi0Bs",
"delegatedStake": 2521349108,
"vaultedStake": 0
},
{
"startTimestamp": 1734593229454,
"cursorId": "LtV0aSqgK3YI7c5FmfvZd-wG95TJ9sezj_a4syaLMS8_M0WP8KSzCvKpzC-HPF1WcddLgGaL9J4DGi76iMnhrN4",
"gatewayAddress": "M0WP8KSzCvKpzC-HPF1WcddLgGaL9J4DGi76iMnhrN4",
"address": "LtV0aSqgK3YI7c5FmfvZd-wG95TJ9sezj_a4syaLMS8",
"delegatedStake": 1685148110,
"vaultedStake": 10000000
}
],
"nextCursor": "PZ5vIhHf8VY969TxBPQN-rYY9CNFP9ggNsMBqlWUzWM_QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ"
}
`

$3

#### resolveArNSName({ name })

Resolves an ArNS name to the underlying data id stored on the names corresponding ANT id.

##### Resolving a base name

`typescript
const ario = ARIO.mainnet();
const record = await ario.resolveArNSName({ name: "ardrive" });
`

Output

`json
{
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"txId": "kvhEUsIY5bXe0Wu2-YUFz20O078uYFzmQIO-7brv8qw",
"type": "lease",
"recordIndex": 0,
"undernameLimit": 100,
"owner": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
"name": "ardrive"
}
`

##### Resolving an undername

`typescript
const ario = ARIO.mainnet();
const record = await ario.resolveArNSName({ name: "logo_ardrive" });
`

Output

`json
{
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"txId": "kvhEUsIY5bXe0Wu2-YUFz20O078uYFzmQIO-7brv8qw",
"type": "lease",
"recordIndex": 1,
"undernameLimit": 100,
"owner": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
"name": "ardrive"
}
`

#### buyRecord({ name, type, years, processId })

Purchases a new ArNS record with the specified name, type, processId, and duration.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

Arguments:

- name - _required_: the name of the ArNS record to purchase
- type - _required_: the type of ArNS record to purchase
- processId - _optional_: the process id of an existing ANT process. If not provided, a new ANT process using the provided signer will be spawned, and the ArNS record will be assigned to that process.
- years - _optional_: the duration of the ArNS record in years. If not provided and type is lease, the record will be leased for 1 year. If not provided and type is permabuy, the record will be permanently registered.
- referrer - _optional_: track purchase referrals for analytics (e.g. my-app.com)

`typescript
const ario = ARIO.mainnet({ signer });
const record = await ario.buyRecord(
{
name: "ardrive",
type: "lease",
years: 1,
processId: "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", // optional: assign to existing ANT process
referrer: "my-app.com", // optional: track purchase referrals for analytics
},
{
// optional tags
tags: [{ name: "App-Name", value: "ArNS-App" }],
onSigningProgress: (step, event) => {
console.log(Signing progress: ${step});
if (step === "spawning-ant") {
console.log("Spawning ant:", event);
}
if (step === "registering-ant") {
console.log("Registering ant:", event);
}
if (step === "verifying-state") {
console.log("Verifying state:", event);
}
if (step === "buying-name") {
console.log("Buying name:", event);
}
},
},
);
`

#### upgradeRecord({ name })

Upgrades an existing leased ArNS record to a permanent ownership. The record must be currently owned by the caller and be of type "lease".

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer });
const record = await ario.upgradeRecord(
{
name: "ardrive",
referrer: "my-app.com", // optional: track purchase referrals for analytics
},
{
// optional tags
tags: [{ name: "App-Name", value: "ArNS-App" }],
},
);
`

#### getArNSRecord({ name })

Retrieves the record info of the specified ArNS name.

`typescript
const ario = ARIO.mainnet();
const record = await ario.getArNSRecord({ name: "ardrive" });
`

Output

`json
{
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"endTimestamp": 1752256702026,
"startTimestamp": 1720720819969,
"type": "lease",
"undernameLimit": 100
}
`

#### getArNSRecords({ cursor, limit, sortBy, sortOrder })

Retrieves all registered ArNS records of the ARIO process, paginated and sorted by the specified criteria. The cursor used for pagination is the last ArNS name from the previous request.

`typescript
const ario = ARIO.mainnet();
// get the newest 100 names
const records = await ario.getArNSRecords({
limit: 100,
sortBy: "startTimestamp",
sortOrder: "desc",
});
`

Available sortBy options are any of the keys on the record object, e.g. name, processId, endTimestamp, startTimestamp, type, undernames.

Output

`json
{
"items": [
{
"name": "ao",
"processId": "eNey-H9RB9uCdoJUvPULb35qhZVXZcEXv8xds4aHhkQ",
"purchasePrice": 75541282285,
"startTimestamp": 1720720621424,
"endTimestamp": 1752256702026,
"type": "permabuy",
"undernameLimit": 10
},
{
"name": "ardrive",
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"endTimestamp": 1720720819969,
"startTimestamp": 1720720620813,
"purchasePrice": 75541282285,
"type": "lease",
"undernameLimit": 100
},
{
"name": "arweave",
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"endTimestamp": 1720720819969,
"startTimestamp": 1720720620800,
"purchasePrice": 75541282285,
"type": "lease",
"undernameLimit": 100
},
{
"name": "ar-io",
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"endTimestamp": 1720720819969,
"startTimestamp": 1720720619000,
"purchasePrice": 75541282285,
"type": "lease",
"undernameLimit": 100
},
{
"name": "fwd",
"processId": "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
"endTimestamp": 1720720819969,
"startTimestamp": 1720720220811,
"purchasePrice": 75541282285,
"type": "lease",
"undernameLimit": 100
}
// ...95 other records
],
"hasMore": true,
"nextCursor": "fwdresearch",
"totalItems": 21740,
"sortBy": "startTimestamp",
"sortOrder": "desc"
}
`

#### getArNSRecordsForAddress({ address, antRegistryProcessId, cursor, limit, sortBy, sortOrder })

Retrieves all registered ArNS records of the specified address according to the ANTRegistry access control list, paginated and sorted by the specified criteria. The cursor used for pagination is the last ArNS name from the previous request.

`typescript
const ario = ARIO.mainnet();
const records = await ario.getArNSRecordsForAddress({
address: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
limit: 100,
sortBy: "startTimestamp",
sortOrder: "desc",
});
`

Available sortBy options are any of the keys on the record object, e.g. name, processId, endTimestamp, startTimestamp, type, undernames.

Output

`json
{
"limit": 1,
"totalItems": 31,
"hasMore": true,
"nextCursor": "ardrive",
"items": [
{
"startTimestamp": 1740009600000,
"name": "ardrive",
"endTimestamp": 1777328018367,
"type": "permabuy",
"purchasePrice": 0,
"undernameLimit": 100,
"processId": "hpF0HdijWlBLFePjWX6u_-Lg3Z2E_PrP_AoaXDVs0bA"
}
],
"sortOrder": "desc",
"sortBy": "startTimestamp"
}
`

#### increaseUndernameLimit({ name, qty })

Increases the undername support of a domain up to a maximum of 10k. Domains, by default, support up to 10 undernames.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.increaseUndernameLimit(
{
name: "ar-io",
qty: 420,
referrer: "my-app.com", // optional: track purchase referrals for analytics
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### extendLease({ name, years })

Extends the lease of a registered ArNS domain, with an extension of 1-5 years depending on grace period status. Permanently registered domains cannot be extended.

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.extendLease(
{
name: "ar-io",
years: 1,
referrer: "my-app.com", // optional: track purchase referrals for analytics
},
// optional additional tags
{ tags: [{ name: "App-Name", value: "My-Awesome-App" }] },
);
`

#### getTokenCost({ intent, ...args })

Calculates the price in mARIO to perform the interaction in question, eg a 'Buy-Name' interaction, where args are the specific params for that interaction.

`typescript
const price = await ario
.getTokenCost({
intent: "Buy-Name",
name: "ar-io",
type: "permabuy",
})
.then((p) => new mARIOToken(p).toARIO()); // convert to ARIO for readability
`

Output

`json
1642.34
`

#### getCostDetails({ intent, fromAddress, fundFrom, ...args})

Calculates the expanded cost details for the interaction in question, e.g a 'Buy-Name' interaction, where args are the specific params for that interaction. The fromAddress is the address that would be charged for the interaction, and fundFrom is where the funds would be taken from, either balance, stakes, or any.

`typescript
const costDetails = await ario.getCostDetails({
intent: "Buy-Name",
fromAddress: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
fundFrom: "stakes",
name: "ar-io",
type: "permabuy",
});
`

Output

`json
{
"tokenCost": 2384252273,
"fundingPlan": {
"address": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
"balance": 0,
"stakes": {
"Rc80LG6h27Y3p9TN6J5hwDeG5M51cu671YwZpU9uAVE": {
"vaults": [],
"delegatedStake": 2384252273
}
},
"shortfall": 0
},
"discounts": []
}
`

#### getDemandFactor()

Retrieves the current demand factor of the network. The demand factor is a multiplier applied to the cost of ArNS interactions based on the current network demand.

`typescript
const ario = ARIO.mainnet();
const demandFactor = await ario.getDemandFactor();
`

Output

`json
1.05256
`

#### getArNSReturnedNames({ cursor, limit, sortBy, sortOrder })

Retrieves all active returned names of the ARIO process, paginated and sorted by the specified criteria. The cursor used for pagination is the last returned name from the previous request.

`typescript
const ario = ARIO.mainnet();
const returnedNames = await ario.getArNSReturnedNames({
limit: 100,
sortBy: "endTimestamp",
sortOrder: "asc", // return the returned names ending soonest first
});
`

Output

`json
{
"items": [
{
"name": "permalink",
"endTimestamp": 1730985241349,
"startTimestamp": 1729775641349,
"baseFee": 250000000,
"demandFactor": 1.05256,
"initiator": "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc",
"settings": {
"durationMs": 1209600000,
"decayRate": 0.000000000016847809193121693,
"scalingExponent": 190,
"startPriceMultiplier": 50
}
}
],
"hasMore": false,
"totalItems": 1,
"sortBy": "endTimestamp",
"sortOrder": "asc"
}
`

#### getArNSReturnedName({ name })

Retrieves the returned name data for the specified returned name.

`typescript
const ario = ARIO.mainnet();
const returnedName = await ario.getArNSReturnedName({ name: "permalink" });
`

Output

`json
{
"name": "permalink",
"endTimestamp": 1730985241349,
"startTimestamp": 1729775641349,
"baseFee": 250000000,
"demandFactor": 1.05256,
"initiator": "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc",
"settings": {
"durationMs": 1209600000,
"decayRate": 0.000000000016847809193121693,
"scalingExponent": 190,
"startPriceMultiplier": 50
}
}
`

$3

#### getCurrentEpoch()

Returns the current epoch data.

`typescript
const ario = ARIO.mainnet();
const epoch = await ario.getCurrentEpoch();
`

Output

`json
{
"epochIndex": 0,
"startTimestamp": 1720720621424,
"endTimestamp": 1752256702026,
"startHeight": 1350700,
"distributionTimestamp": 1711122739,
"observations": {
"failureSummaries": {
"-Tk2DDk8k4zkwtppp_XFKKI5oUgh6IEHygAoN7mD-w8": [
"Ie2wEEUDKoU26c7IuckHNn3vMFdNQnMvfPBrFzAb3NA"
]
},
"reports": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": "B6UUjKWjjEWDBvDSMXWNmymfwvgR9EN27z5FTkEVlX4"
}
},
"prescribedNames": ["ardrive", "ar-io", "arweave", "fwd", "ao"],
"prescribedObservers": [
{
"gatewayAddress": "2Fk8lCmDegPg6jjprl57-UCpKmNgYiKwyhkU4vMNDnE",
"observerAddress": "2Fk8lCmDegPg6jjprl57-UCpKmNgYiKwyhkU4vMNDnE",
"stake": 10000000000,
"start": 1292450,
"stakeWeight": 1,
"tenureWeight": 0.4494598765432099,
"gatewayPerformanceRatio": 1,
"observerRewardRatioWeight": 1,
"compositeWeight": 0.4494598765432099,
"normalizedCompositeWeight": 0.002057032496835938
}
],
"distributions": {
"distributedTimestamp": 1711122739,
"totalEligibleRewards": 100000000,
"rewards": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": 100000000
}
}
}
`

#### getEpoch({ epochIndex })

Returns the epoch data for the specified block height. If no epoch index is provided, the current epoch is used.

`typescript
const ario = ARIO.mainnet();
const epoch = await ario.getEpoch({ epochIndex: 0 });
`

Output

`json
{
"epochIndex": 0,
"startTimestamp": 1720720620813,
"endTimestamp": 1752256702026,
"startHeight": 1350700,
"distributionTimestamp": 1752256702026,
"observations": {
"failureSummaries": {
"-Tk2DDk8k4zkwtppp_XFKKI5oUgh6IEHygAoN7mD-w8": [
"Ie2wEEUDKoU26c7IuckHNn3vMFdNQnMvfPBrFzAb3NA"
]
},
"reports": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": "B6UUjKWjjEWDBvDSMXWNmymfwvgR9EN27z5FTkEVlX4"
}
},
"prescribedNames": ["ardrive", "ar-io", "arweave", "fwd", "ao"],
"prescribedObservers": [
{
"gatewayAddress": "2Fk8lCmDegPg6jjprl57-UCpKmNgYiKwyhkU4vMNDnE",
"observerAddress": "2Fk8lCmDegPg6jjprl57-UCpKmNgYiKwyhkU4vMNDnE",
"stake": 10000000000, // value in mARIO
"startTimestamp": 1720720620813,
"stakeWeight": 1,
"tenureWeight": 0.4494598765432099,
"gatewayPerformanceRatio": 1,
"observerRewardRatioWeight": 1,
"compositeWeight": 0.4494598765432099,
"normalizedCompositeWeight": 0.002057032496835938
}
],
"distributions": {
"totalEligibleGateways": 1,
"totalEligibleRewards": 100000000,
"totalEligibleObserverReward": 100000000,
"totalEligibleGatewayReward": 100000000,
"totalDistributedRewards": 100000000,
"distributedTimestamp": 1720720621424,
"rewards": {
"distributed": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": 100000000
}
}
}
}
`

#### getEligibleEpochRewards({ epochIndex }, { cursor, limit, sortBy, sortOrder })

Returns the eligible epoch rewards for the specified block height. If no epoch index is provided, the current epoch is used.

``typescript
const ario = ARIO.mainnet();
const rewards = await ario.getEligibleEpochRewards({ epochIndex: 0 });
`

Output

`json
{
"sortOrder": "desc",
"hasMore": true,
"totalItems": 37,
"limit": 1,
"sortBy": "cursorId",
"items": [
{
"cursorId": "xN_aVln30LmoCffwmk5_kRkcyQZyZWy1o_TNtM_CTm0_xN_aVln30LmoCffwmk5_kRkcyQZyZWy1o_TNtM_CTm0",
"recipient": "xN_aVln30LmoCffwmk5_kRkcyQZyZWy1o_TNtM_CTm0",
"gatewayAddress": "xN_aVln30LmoCffwmk5_kRkcyQZyZWy1o_TNtM_CTm0",
"eligibleReward": 2627618704,
"type": "operatorReward"
}
],
"nextCursor": "xN_aVln30LmoCffwmk5_kRkcyQZyZWy1o_TNtM_CTm0_xN_aVln30LmoCffwmk5_kRkcyQZyZWy1o_TNtM_CTm0"
}
`


#### getObservations({ epochIndex })

Returns the epoch-indexed observation list. If no epoch index is provided, the current epoch is used.

`typescript
const ario = ARIO.mainnet();
const observations = await ario.getObservations();
`

Output

`json
{
"0": {
"failureSummaries": {
"-Tk2DDk8k4zkwtppp_XFKKI5oUgh6IEHygAoN7mD-w8": [
"Ie2wEEUDKoU26c7IuckHNn3vMFdNQnMvfPBrFzAb3NA",
"Ie2wEEUDKoU26c7IuckHNn3vMFdNQnMvfPBrFzAb3NA"
]
},
"reports": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": "B6UUjKWjjEWDBvDSMXWNmymfwvgR9EN27z5FTkEVlX4",
"Ie2wEEUDKoU26c7IuckHNn3vMFdNQnMvfPBrFzAb3NA": "7tKsiQ2fxv0D8ZVN_QEv29fZ8hwFIgHoEDrpeEG0DIs",
"osZP4D9cqeDvbVFBaEfjIxwc1QLIvRxUBRAxDIX9je8": "aatgznEvC_UPcxp1v0uw_RqydhIfKm4wtt1KCpONBB0",
"qZ90I67XG68BYIAFVNfm9PUdM7v1XtFTn7u-EOZFAtk": "Bd8SmFK9-ktJRmwIungS8ur6JM-JtpxrvMtjt5JkB1M"
}
}
}
`

#### getDistributions({ epochIndex })

Returns the current rewards distribution information. If no epoch index is provided, the current epoch is used.

`typescript
const ario = ARIO.mainnet();
const distributions = await ario.getDistributions({ epochIndex: 0 });
`

Output

`json
{
"totalEligibleGateways": 1,
"totalEligibleRewards": 100000000,
"totalEligibleObserverReward": 100000000,
"totalEligibleGatewayReward": 100000000,
"totalDistributedRewards": 100000000,
"distributedTimestamp": 1720720621424,
"rewards": {
"eligible": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": {
"operatorReward": 100000000,
"delegateRewards": {}
}
},
"distributed": {
"IPdwa3Mb_9pDD8c2IaJx6aad51Ss-_TfStVwBuhtXMs": 100000000
}
}
}
`

#### saveObservations({ reportTxId, failedGateways })

Saves the observations of the current epoch. Requires signer to be provided on ARIO.init to sign the transaction.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.saveObservations(
{
reportTxId: "fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3",
failedGateways: ["t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3"],
},
{
tags: [{ name: "App-Name", value: "My-Awesome-App" }],
},
);
`

#### getPrescribedObservers({ epochIndex })

Retrieves the prescribed observers of the ARIO process. To fetch prescribed observers for a previous epoch set the epochIndex to the desired epoch index.

`typescript
const ario = ARIO.mainnet();
const observers = await ario.getPrescribedObservers({ epochIndex: 0 });
`

Output

`json
[
{
"gatewayAddress": "BpQlyhREz4lNGS-y3rSS1WxADfxPpAuing9Lgfdrj2U",
"observerAddress": "2Fk8lCmDegPg6jjprl57-UCpKmNgYiKwyhkU4vMNDnE",
"stake": 10000000000, // value in mARIO
"start": 1296976,
"stakeWeight": 1,
"tenureWeight": 0.41453703703703704,
"gatewayPerformanceRatio": 1,
"observerRewardRatioWeight": 1,
"compositeWeight": 0.41453703703703704,
"normalizedCompositeWeight": 0.0018972019546783507
}
]
`

$3

#### getPrimaryNames({ cursor, limit, sortBy, sortOrder })

Retrieves all primary names paginated and sorted by the specified criteria. The cursor used for pagination is the last name from the previous request.

`typescript
const ario = ARIO.mainnet();
const names = await ario.getPrimaryNames({
cursor: "ao", // this is the last name from the previous request
limit: 1,
sortBy: "startTimestamp",
sortOrder: "desc",
});
`

Output

`json
{
"sortOrder": "desc",
"hasMore": true,
"totalItems": 100,
"limit": 1,
"sortBy": "startTimestamp",
"cursor": "arns",
"items": [
{
"owner": "HwFceQaMQnOBgKDpnFqCqgwKwEU5LBme1oXRuQOWSRA",
"startTimestamp": 1719356032297,
"name": "arns"
}
]
}
`

#### getPrimaryName({ name, address })

Retrieves the primary name for a given name or address.

`typescript
const ario = ARIO.mainnet();
const name = await ario.getPrimaryName({
name: "arns",
});
// or
const name = await ario.getPrimaryName({
address: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
});
`

Output

`json
{
"owner": "HwFceQaMQnOBgKDpnFqCqgwKwEU5LBme1oXRuQOWSRA",
"startTimestamp": 1719356032297,
"name": "arns"
}
`

#### setPrimaryName({ name })

Sets an ArNS name already owned by the signer as their primary name. Note: signer must be the owner of the processId that is assigned to the name. If not, the transaction will fail.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const signer = new ArweaveSigner(jwk);
const ario = ARIO.mainnet({ signer });
await ario.setPrimaryName({ name: "my-arns-name" }); // the caller must already have purchased the name my-arns-name and be assigned as the owner of the processId that is assigned to the name
`

#### requestPrimaryName({ name })

Requests a primary name for the signer's address. The request must be approved by the new owner of the requested name via the approvePrimaryNameRequest[#approveprimarynamerequest-name-address-] API.

_Note: Requires signer to be provided on ARIO.init to sign the transaction._

`typescript
const ario = ARIO.mainnet({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await ario.requestPrimaryName({
name: "arns",
});
`

#### getPrimaryNameRequest({ initiator })

Retrieves the primary name request for a a wallet address.

`typescript
const ario = ARIO.mainnet();
const request = await ario.getPrimaryNameRequest({
initiator: "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
});
`

Output

`json
{
"initiator": "t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3",
"name": "arns",
"startTimestamp": 1728067635857,
"endTimestamp": 1735843635857
}
`

$3

The ARIO client class exposes APIs relevant to the ar.io process. It can be configured to use any AO Process ID that adheres to the [ARIO Network Spec]. By default, it will use the current [ARIO Testnet Process]. Refer to [AO Connect] for more information on how to configure an ARIO process to use specific AO infrastructure.

`typescript
import { ARIO , AOProcess } from '@ar.io/sdk';
import { connect } from '@permaweb/aoconnect';

// provide a custom ao infrastructure and process id
const ario = ARIO.mainnet({
process: new AOProcess({
processId: 'ARIO_PROCESS_ID'
ao: connect({
MODE: 'legacy',
MU_URL: 'https://mu-testnet.xyz',
CU_URL: 'https://cu-testnet.xyz',
GRAPHQL_URL: 'https://arweave.net/graphql',
GATEWAY_URL: 'https://arweave.net',
})
})
});
`

ANT Contracts

The ANT client class exposes APIs relevant to compliant Arweave Name Token processes. It can be configured to use any process ID that adheres to the ANT process spec. You must provide either a custom process data provider or a processId to the ANT class constructor to use.

$3

#### init({ processId, signer })

Factory function to that creates a read-only or writeable client. By providing a signer additional write APIs that require signing, like setRecord and transfer are available. By default, a read-only client is returned and no write APIs are available.

`typescript
// in a browser environment with ArConnect
const ant = ANT.init({
signer: new ArConnectSigner(window.arweaveWallet, Arweave.init({})),
processId: "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
});

// in a node environment
const ant = ANT.init({
signer: new ArweaveSigner(JWK),
processId: "bh9l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM",
});
`

$3

#### spawn({ signer, module?, ao?, scheduler?, state?, antRegistryId?, logger?, authority? })

Spawns a new ANT (Arweave Name Token) process. This static function creates a new ANT process on the AO network and returns the process ID.

_Note: Requires signer to be provided to sign the spawn transaction._

`typescript
import { ANT } from "@ar.io/sdk";
import { ArweaveSigner } from "@ar.io/sdk/node";

const processId = await ANT.spawn({
signer: new ArweaveSigner(jwk),
state: {
name: "My ANT",
ticker: "MYANT",
description: "My custom ANT token",
},
});

// Using a custom module ID
const processId = await ANT.spawn({
signer: new ArweaveSigner(jwk),
module: "FKtQtOOtlcWCW2pXrwWFiCSlnuewMZOHCzhulVkyqBE", // Custom module ID
state: {
name: "My Custom Module ANT",
ticker: "CUSTOM",
description: "ANT using a specific module version",
},
});
`

CLI Usage:

`bash


Spawn ANT with default (latest) module

ar.io spawn-ant --wallet-file wallet.json --name "My ANT" --ticker "MYANT"

Spawn ANT with custom module ID

ar.io spawn-ant --wallet-file wallet.json --module FKtQtOOtlcWCW2pXrwWFiCSlnuewMZOHCzhulVkyqBE --name "My Custom ANT" --ticker "CUSTOM"
`

Parameters:

- signer: AoSigner - The signer used to authenticate the spawn transaction
- module?: string - Optional module ID to use; if not provided, gets latest from ANT registry
- ao?: AoClient - Optional AO client instance (defaults to legacy mode connection)
- scheduler?: string - Optional scheduler ID
- state?: SpawnANTState - Optional initial state for the ANT including name, ticker, description, etc.
- antRegistryId?: string - Optional ANT registry ID
- logger?: Logger - Optional logger instance
- authority?: string - Optional authority

Returns: Promise - The process ID of the newly spawned ANT

$3

#### getModuleId({ graphqlUrl?, retries? })

Gets the module ID of the current ANT process by querying its spawn transaction tags. Results are cached after the first successful fetch.

`typescript
const moduleId = await ant.getModuleId();
console.log(ANT was spawned with module: ${moduleId});

// With custom GraphQL URL and retries
const moduleId = await ant.getModuleId({
graphqlUrl: "https://arweave.net/graphql",
retries: 5,
});
`

Output

`json
"FKtQtOOtlcWCW2pXrwWFiCSlnuewMZOHCzhulVkyqBE"
`

#### getVersion({ antRegistryId?, graphqlUrl?, retries? })

Gets the version string of the current ANT by matching its module ID with versions from the ANT registry.

`typescript
const version = await ant.getVersion();
console.log(ANT is running version: ${version});

// With custom ANT registry
const version = await ant.getVersion({
antRegistryId: "custom-ant-registry-id",
});
`

Output

`json
"23"
`

#### isLatestVersion({ antRegistryId?, graphqlUrl?, retries? })

Checks if the current ANT version is the latest according to the ANT registry.

`typescript
const isLatest = await ant.isLatestVersion();
if (!isLatest) {
console.log("ANT can be upgraded to the latest version");
}
`

Output

`json
true
`

#### getANTVersions

Static method that returns the full array of available ANT versions and the latest version from the ANT registry.

`typescript
import { ANT } from "@ar.io/sdk";

// Get all available ANT versions
const antVersions = ANT.versions;
const versions = await antVersions.getANTVersions();
`

Result:

`json
{
[
{
"moduleId": "FKtQtOOtlcWCW2pXrwWFiCSlnuewMZOHCzhulVkyqBE",
"version": "23",
"releaseNotes": "Initial release of the ANT module.",
"releaseDate": 1700000000000
}
// ...other versions
],
}
`

#### getLatestANTVersion()

Static method that returns the latest ANT version from the ANT registry.

`typescript
import { ANT } from "@ar.io/sdk";

// Get the latest ANT version
import { ANT } from "@ar.io/sdk";

// Get all available ANT versions
const antVersions = ANT.versions;
const versions = await antVersions.getANTVersions();
const latestVersion = await antVersions.getLatestANTVersion();
`

Result:

`json
{
"moduleId": "FKtQtOOtlcWCW2pXrwWFiCSlnuewMZOHCzhulVkyqBE",
"version": "23",
"releaseNotes": "Initial release of the ANT module.",
"releaseDate": 1700000000000
}
`

$3

#### getInfo()

Retrieves the information of the ANT process.

`typescript
const info = await ant.getInfo();
`

Output

`json
{
"name": "ArDrive",
"ticker": "ANT-ARDRIVE",
"description": "This is the ANT for the ArDrive decentralized web app.",
"keywords": ["File-sharing", "Publishing", "dApp"],
"owner": "QGWqtJdLLgm2ehFWiiPzMaoFLD50CnGuzZIPEdoDRGQ"
}
`

#### getHandlers()

Retrieves the handlers supported on the ANT

`typescript
const handlers = await ant.getHandlers();
`

Output

`json
[
"_eval",
"_default",
"transfer",
"balance",
"balances",
"totalSupply",
"info",
"addController",
"removeController",
"controllers",
"setRecord",
"removeRecord",
"record",
"records",
"setName",
"setTicker",
"initializeState",
"state"
]
`

#### getState()

Retrieves the state of the ANT process.

`typescript
const state = await ant.getState();
`

Output

``json
{
"TotalSupply": 1,
"Balances": {
"98O1_xqDLrBKRfQPWjF5p7xZ4Jx6GM8P5PeJn26xwUY": 1
},
"Controllers": [],
"Records": {
"v1-0-0_whitepaper": {
"transactionId": "lNjWn3LpyhKC95Kqe-x8X2qgju0j98MhucdDKK85vc4",
"ttlSeconds": 900
},
"@": {
"transactionId": "2rMLb2uHAyEt7jSu6bXtKx8e-jOfIf7E-DOgQnm8EtU",
"ttlSeconds": 3600
},
"alice": {
"transactionId": "kMk95k_3R8x_7d3wB9tEOiL5v6n8QhR_VnFCh3aeE3f",
"ttlSeconds": 900,
"owner": "alice-wallet-address-123...",
"displayName": "Alice's Portfolio",
"logo": "avatar-tx-id-456...",
"description": "Personal portfolio and blog",
"keywords": ["portfolio", "personal"