@ar.io/sdk 4.0.0-solana.29 → 4.0.0-solana.30

package/README.md

@@ -3,9 +3,10 @@
 [![codecov](https://codecov.io/gh/ar-io/ar-io-sdk/graph/badge.svg?token=7dXKcT7dJy)](https://codecov.io/gh/ar-io/ar-io-sdk)
 
 The Solana-native SDK for the AR.IO network. Provides typed
-client classes (`ARIO`, `ANT`, `ANTRegistry`), Codama-generated
-instruction builders, Borsh deserializers, PDA helpers, and event
-decoders for the AR.IO protocol on Solana.
+client classes (`ARIO`, `ANT`, `ANTRegistry`), PDA helpers,
+deserializers, and escrow primitives for the AR.IO protocol on Solana.
+Codama-generated instruction builders and account decoders are
+supplied by [`@ar.io/solana-contracts`](https://www.npmjs.com/package/@ar.io/solana-contracts).
 
 ## Table of Contents
 
@@ -150,12 +151,9 @@ in various environments.
 ### Subpath exports
 
 - `@ar.io/sdk` — main entry. `ARIO`, `ANT`, `ANTRegistry`, Solana
-  client classes, PDA helpers, deserializers, event decoders, escrow
-  primitives.
+  client classes, PDA helpers, deserializers, escrow primitives.
 - `@ar.io/sdk/solana` — alias of the main entry (kept for one release
   while consumers migrate from the previous subpath layout).
-- `@ar.io/sdk/solana/generated` — Codama-emitted typed instruction
-  builders / account decoders for low-level transaction construction.
 
 ### Web
 
@@ -3246,14 +3244,14 @@ const result = await withRetry(() => rpc.getAccountInfo(addr).send(), {
 
 ### Generated instruction builders
 
-For custom transaction building, import Codama-emitted typed clients
-directly:
+For custom transaction building, import Codama-generated typed clients
+from [`@ar.io/solana-contracts`](https://www.npmjs.com/package/@ar.io/solana-contracts):
 
 ```ts
 import {
   getBuyNameInstructionAsync,
   ARIO_ARNS_PROGRAM_ADDRESS,
-} from '@ar.io/sdk/solana/generated';
+} from '@ar.io/solana-contracts/arns';
 ```
 
 ### Networks

package/lib/esm/cli/commands/escrowCommands.js

@@ -6,6 +6,12 @@
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 /**
  * CLI commands for `ario-ant-escrow` — trustless multi-protocol ANT custody.

package/lib/esm/solana/ant-readable.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Solana implementation of ANT (Arweave Name Token) read interface.
  *
@@ -9,20 +24,13 @@
  */
 import { address, fetchEncodedAccount, } from '@solana/kit';
 import bs58 from 'bs58';
-import { withRetry } from './retry.js';
-// AntRecordMetadata discriminator — regenerate via `yarn codegen` after IDL rebase
-// to expose ANT_RECORD_METADATA_DISCRIMINATOR. Until then, compute inline.
 import { createHash as __createHash } from 'crypto';
-import { ANT_RECORD_DISCRIMINATOR } from '@ar.io/solana-contracts/ant';
+import { ANT_RECORD_DISCRIMINATOR, ANT_RECORD_METADATA_DISCRIMINATOR, decodeAntConfig, decodeAntControllers, getAntRecordDecoder, getAntRecordMetadataDecoder, } from '@ar.io/solana-contracts/ant';
 import { Logger } from '../common/logger.js';
 import { SolanaANTRegistryReadable } from './ant-registry-readable.js';
 import { ANT_CONFIG_VERSION, ARIO_ANT_PROGRAM_ID } from './constants.js';
-import { deserializeAntConfig, deserializeAntControllers, deserializeAntRecord, deserializeAntRecordMetadata, } from './deserialize.js';
-const ANT_RECORD_METADATA_DISCRIMINATOR = new Uint8Array(__createHash('sha256')
-    .update('account:AntRecordMetadata')
-    .digest()
-    .subarray(0, 8));
 import { getAntConfigPDA, getAntControllersPDA, getAntRecordMetadataPDA, getAntRecordPDA, } from './pda.js';
+import { withRetry } from './retry.js';
 /**
  * Solana-backed read-only client for a single ANT (Arweave Name Token).
  *
@@ -116,7 +124,17 @@ export class SolanaANTReadable {
         if (!account.exists) {
             throw new Error(`ANT config not found for ${this.processId}`);
         }
-        return deserializeAntConfig(Buffer.from(account.data));
+        const decoded = decodeAntConfig(account).data;
+        return {
+            mint: decoded.mint,
+            name: decoded.name,
+            ticker: decoded.ticker,
+            logo: decoded.logo,
+            description: decoded.description,
+            keywords: decoded.keywords,
+            owner: decoded.lastKnownOwner,
+            version: decoded.version.major,
+        };
     }
     async fetchControllers() {
         const [pda] = await getAntControllersPDA(this.mint, this.antProgram);
@@ -124,7 +142,11 @@ export class SolanaANTReadable {
         if (!account.exists) {
             return { mint: this.processId, controllers: [] };
         }
-        return deserializeAntControllers(Buffer.from(account.data));
+        const decoded = decodeAntControllers(account).data;
+        return {
+            mint: decoded.mint,
+            controllers: decoded.controllers.map((c) => c),
+        };
     }
     async getOwner(_opts) {
         const config = await this.fetchConfig();
@@ -170,20 +192,34 @@ export class SolanaANTReadable {
         ]);
         if (!recordAccount.exists)
             return undefined;
-        const record = deserializeAntRecord(Buffer.from(recordAccount.data));
+        const recordDecoder = getAntRecordDecoder();
+        const metaDecoder = getAntRecordMetadataDecoder();
+        const record = recordDecoder.decode(new Uint8Array(recordAccount.data));
         const meta = metaAccount.exists
-            ? deserializeAntRecordMetadata(Buffer.from(metaAccount.data))
-            : {};
+            ? metaDecoder.decode(new Uint8Array(metaAccount.data))
+            : undefined;
         return {
-            transactionId: record.transactionId,
+            transactionId: record.target,
             targetProtocol: record.targetProtocol,
             ttlSeconds: record.ttlSeconds,
-            priority: record.priority,
-            owner: record.owner,
-            displayName: meta.displayName,
-            logo: meta.logo,
-            description: meta.description,
-            keywords: meta.keywords,
+            priority: record.priority?.__option === 'Some'
+                ? record.priority.value
+                : undefined,
+            owner: record.owner?.__option === 'Some'
+                ? record.owner.value
+                : undefined,
+            displayName: meta?.displayName?.__option === 'Some'
+                ? meta.displayName.value
+                : undefined,
+            logo: meta?.recordLogo?.__option === 'Some'
+                ? meta.recordLogo.value
+                : undefined,
+            description: meta?.recordDescription?.__option === 'Some'
+                ? meta.recordDescription.value
+                : undefined,
+            keywords: meta?.recordKeywords?.__option === 'Some'
+                ? meta.recordKeywords.value
+                : undefined,
         };
     }
     async getRecords(_opts) {
@@ -220,6 +256,8 @@ export class SolanaANTReadable {
             })
                 .send()),
         ]));
+        const recordDecoder = getAntRecordDecoder();
+        const metaDecoder = getAntRecordMetadataDecoder();
         // Index metadata by undername hash for O(1) lookup.
         // AntRecordMetadata has undername_hash at offset 40 (8 disc + 32 mint).
         const metaByHash = new Map();
@@ -227,7 +265,7 @@ export class SolanaANTReadable {
             try {
                 const buf = Buffer.from(account.data[0], 'base64');
                 const hash = buf.subarray(40, 72).toString('hex');
-                metaByHash.set(hash, deserializeAntRecordMetadata(buf));
+                metaByHash.set(hash, metaDecoder.decode(new Uint8Array(buf)));
             }
             catch {
                 // Skip malformed
@@ -238,21 +276,33 @@ export class SolanaANTReadable {
         for (const { account } of recordAccounts) {
             try {
                 const buf = Buffer.from(account.data[0], 'base64');
-                const record = deserializeAntRecord(buf);
+                const record = recordDecoder.decode(new Uint8Array(buf));
                 const hash = __createHash('sha256')
                     .update(record.undername.toLowerCase())
                     .digest('hex');
-                const meta = metaByHash.get(hash) ?? {};
+                const meta = metaByHash.get(hash);
                 result[record.undername] = {
-                    transactionId: record.transactionId,
+                    transactionId: record.target,
                     targetProtocol: record.targetProtocol,
                     ttlSeconds: record.ttlSeconds,
-                    priority: record.priority,
-                    owner: record.owner,
-                    displayName: meta.displayName,
-                    logo: meta.logo,
-                    description: meta.description,
-                    keywords: meta.keywords,
+                    priority: record.priority?.__option === 'Some'
+                        ? record.priority.value
+                        : undefined,
+                    owner: record.owner?.__option === 'Some'
+                        ? record.owner.value
+                        : undefined,
+                    displayName: meta?.displayName?.__option === 'Some'
+                        ? meta.displayName.value
+                        : undefined,
+                    logo: meta?.recordLogo?.__option === 'Some'
+                        ? meta.recordLogo.value
+                        : undefined,
+                    description: meta?.recordDescription?.__option === 'Some'
+                        ? meta.recordDescription.value
+                        : undefined,
+                    keywords: meta?.recordKeywords?.__option === 'Some'
+                        ? meta.recordKeywords.value
+                        : undefined,
                     index: index++,
                 };
             }

package/lib/esm/solana/ant-registry-readable.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *

package/lib/esm/solana/ant-registry-writeable.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Solana implementation of the ANT Registry write interface.
  *

package/lib/esm/solana/ant-writeable.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Solana implementation of ANT (Arweave Name Token) write interface.
  *

package/lib/esm/solana/ata.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Associated Token Account derivation, kit-native.
  * Mirrors the classic SPL `getAssociatedTokenAddress` function but returns

package/lib/esm/solana/canonical-message.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Canonical claim-message helper for `ario-ant-escrow`.
  *

package/lib/esm/solana/clusters.js

@@ -1,14 +1,34 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Cluster-specific deployment constants for AR.IO programs.
  *
- * Mainnet IDs are baked into the IDL at codegen time and surfaced via the
- * placeholder constants in `./constants.ts` (e.g. `ARIO_CORE_PROGRAM_ID`).
- * This module exposes the same values for *other* clusters where the
- * programs are deployed at non-default addresses — primarily devnet.
+ * The program-ID constants in `./constants.ts` (e.g. `ARIO_CORE_PROGRAM_ID`)
+ * are codama *placeholders* (`ARioCoreProgramXXX…`), not real on-chain
+ * addresses — consumers must pass real IDs via `ARIO.init({ programIds })`.
+ * This module exposes the deployed sets per cluster: `MAINNET_PROGRAM_IDS`
+ * and `DEVNET_PROGRAM_IDS`.
  *
- * Source of truth: `/devnet-config.json` at the repo root. Keep these
- * exports in sync when devnet is redeployed; the bundled drift test
- * (`clusters.test.ts`) will fail CI on mismatch.
+ * Only root facts live here: program IDs, the RPC URL, and the ARIO mint.
+ * Everything else is derived rather than stored — config/settings PDAs come
+ * from the codama `find*Pda` helpers in `@ar.io/solana-contracts` (seeded by
+ * the program IDs below), and genesis-time token accounts (treasury / stake)
+ * are read on-chain from the ArioConfig / GarSettings accounts at runtime
+ * (see `io-writeable.ts` `getGarConfig`). Nothing to keep in sync, nothing to
+ * drift.
  *
  * Usage:
  * ```ts
@@ -29,6 +49,14 @@
  * ```
  */
 import { address } from '@solana/kit';
+/**
+ * Default JSON-RPC URL for Solana mainnet-beta.
+ *
+ * The public endpoint rate-limits aggressively — for production use a premium
+ * RPC (QuickNode / Helius / Triton). Derive the WS URL with
+ * `MAINNET_RPC_URL.replace(/^https/, 'wss')`.
+ */
+export const MAINNET_RPC_URL = 'https://api.mainnet-beta.solana.com';
 /**
  * Default JSON-RPC URL for the Solana devnet cluster.
  *
@@ -37,6 +65,35 @@ import { address } from '@solana/kit';
  * `DEVNET_RPC_URL.replace(/^https/, 'wss')`.
  */
 export const DEVNET_RPC_URL = 'https://api.devnet.solana.com';
+/**
+ * AR.IO program IDs deployed on Solana mainnet-beta.
+ *
+ * Shape matches the `programIds` argument of
+ * `ARIO.init({ backend: 'solana', programIds, ... })`.
+ */
+export const MAINNET_PROGRAM_IDS = {
+    core: address('73YoECm6NKXpVRoe5f1Q9BcP5DJGPFUjnFy6AxBE5Nvh'),
+    gar: address('89fNiiwgpFSPHKuqfNUkgYTYjtAJAhyqHjXmgXeppGpf'),
+    arns: address('2yCUx5edFvUrkibYaUa2ZXWyx9kuJkS8CwyzsgHPWdZZ'),
+    ant: address('2MWexMHfMhGJwMHv9Qm9YAVCqjUFUJwDJAysW4oCUGk5'),
+    antEscrow: address('5HZhe9UqKL5zAsdz81nuuaxV41h8bFhudzxxBigAQndM'),
+};
+/**
+ * Mainnet attestor pubkey — the key that signs cross-protocol attestations
+ * (e.g. escrow recipient proofs). Deployment metadata; not consumed by the
+ * SDK, exposed here for reference/verification by downstream tooling.
+ */
+export const MAINNET_ATTESTOR_PUBKEY = address('7XtUnotZAeYZNzVSYV5nb7S9YH9qHXyVFM6NeNMu6efE');
+/**
+ * Mainnet upgrade/admin authority pubkey — holds the upgrade authority for
+ * the programs above. Deployment metadata; not consumed by the SDK, exposed
+ * here for reference.
+ */
+export const MAINNET_AUTHORITY_PUBKEY = address('45ZuEb1Jk7pbjshD1BVasBekAXhimdWuJjyswQzMyTB1');
+// TODO(mainnet): placeholder — this reuses the devnet mint and is WRONG for
+// mainnet. Replace with the real mainnet ARIO mint once it is known.
+/** ARIO SPL Token mint on Solana mainnet-beta. */
+export const MAINNET_ARIO_MINT = address('6vTw5CysRXQ4ybbHkDUiisHWVsBeMtUzYvJqs2iqHyaN');
 /**
  * AR.IO program IDs deployed on Solana devnet (staging).
  *
@@ -44,15 +101,11 @@ export const DEVNET_RPC_URL = 'https://api.devnet.solana.com';
  * `ARIO.init({ backend: 'solana', programIds, ... })`.
  */
 export const DEVNET_PROGRAM_IDS = {
-    core: address('5iU1xZ4ocy7e96kcoEipvnxs8anSoq6JGznq6iS4svKn'),
-    gar: address('KpZMWCMeTiyH3dW3ZH9go4TwAg5vxgUXHuFVY8JbLFS'),
-    arns: address('2YjqZEYTTKLD3qg4NvYwpo2wVcDQCj2p4iD2WTYymfEC'),
-    ant: address('9SuQQKKW1mEvdRhXrdpHR5PqBMurY3wh7vbEkxzEsngu'),
-    antEscrow: address('GP5A7idQQmbGeuUcihAsgkV2Kc4LSpqoKyLMWBK46sCg'),
+    core: address('8Njx9wPkXiNzDCgjwVsJFRjpAEV34gGW3n8DzX3V23m1'),
+    gar: address('7WsDTrtZBsfKtnP33XkjuqXCY69JE7n4QVYpynqJCFxz'),
+    arns: address('6EZNezcg4rc5hnh8HG34vGquT3WpW5xXypzPb24uyEpp'),
+    ant: address('DbHbRwUD1oAn1mrDSqtWtvwGcNrmhWdD2g8L4xmeQ7NX'),
+    antEscrow: address('bttco5oAnBwCucG63iKokBJCZmNr493f3Ewe9LM3oTx'),
 };
-/** ARIO SPL Token mint on devnet. */
-export const DEVNET_ARIO_MINT = address('BZ3nczDe8To3c39eN7Beq9FW34BveUcEs9sDNkbGxn4U');
-/** Protocol treasury token account on devnet (owner = ArioConfig PDA). */
-export const DEVNET_TREASURY_TOKEN_ACCOUNT = address('WLh1PNwSg5QstPeATJxD21cb6wvYkj4ibQetkz5RTn3');
-/** Protocol stake token account on devnet (owner = GatewaySettings PDA). */
-export const DEVNET_STAKE_TOKEN_ACCOUNT = address('6vV7qQTf8Bv6SVagLKMSj3dnK7Vv9uaiujpMsHTJ2onF');
+/** ARIO SPL Token mint on devnet (Staging v2). */
+export const DEVNET_ARIO_MINT = address('6vTw5CysRXQ4ybbHkDUiisHWVsBeMtUzYvJqs2iqHyaN');

package/lib/esm/solana/constants.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Solana program IDs and PDA seed constants for AR.IO programs.
  *

package/lib/esm/solana/delegation-math.js

@@ -1,3 +1,18 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * Delegation balance math.
  *