@ar.io/sdk 2.4.0 → 2.5.0-alpha.10

package/lib/types/common/io.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 import Arweave from 'arweave';
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoAuction, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoArNSNameData, AoAuctionPriceData, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegateWithAddress, AoIORead, AoIOWrite, AoRegistrationFees, AoVaultData, AoWalletVault, EpochInput } from '../types/io.js';
+import { AoArNSNameDataWithName, AoArNSReservedNameData, AoAuction, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
+import { AoArNSNameData, AoArNSReservedNameDataWithName, AoAuctionPriceData, AoDelegation, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegateWithAddress, AoGatewayVault, AoIORead, AoIOWrite, AoRegistrationFees, AoVaultData, AoWalletVault, EpochInput } from '../types/io.js';
 import { mIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class IO {
@@ -56,7 +56,7 @@ export declare class IOReadable implements AoIORead {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
     getArNSRecords(params?: PaginationParams<AoArNSNameDataWithName>): Promise<PaginationResult<AoArNSNameDataWithName>>;
-    getArNSReservedNames(): Promise<Record<string, AoArNSReservedNameData> | Record<string, never>>;
+    getArNSReservedNames(params?: PaginationParams<AoArNSReservedNameDataWithName>): Promise<PaginationResult<AoArNSReservedNameDataWithName>>;
     getArNSReservedName({ name, }: {
         name: string;
     }): Promise<AoArNSReservedNameData | undefined>;
@@ -125,6 +125,24 @@ export declare class IOReadable implements AoIORead {
         timestamp?: number;
         intervalMs?: number;
     }): Promise<AoAuctionPriceData>;
+    getDelegations(params: PaginationParams<AoDelegation> & {
+        address: WalletAddress;
+    }): Promise<PaginationResult<AoDelegation>>;
+    getGatewayVaults(params: PaginationParams<AoGatewayVault> & {
+        address: WalletAddress;
+    }): Promise<PaginationResult<AoGatewayVault>>;
+    getPrimaryNameRequest(params: {
+        initiator: WalletAddress;
+    } | {
+        name: string;
+    }): Promise<AoMessageResult>;
+    getPrimaryNameRequests(params: PaginationParams<AoPrimaryNameRequest>): Promise<PaginationResult<AoPrimaryNameRequest>>;
+    getPrimaryName(params: {
+        address: WalletAddress;
+    } | {
+        name: string;
+    }): Promise<AoPrimaryName>;
+    getPrimaryNames(params: PaginationParams<AoPrimaryName>): Promise<PaginationResult<AoPrimaryName>>;
 }
 export declare class IOWriteable extends IOReadable implements AoIOWrite {
     protected process: AOProcess;
@@ -226,4 +244,7 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         type?: 'lease' | 'permabuy';
         years?: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    requestPrimaryName(params: {
+        name: string;
+    }): Promise<AoMessageResult>;
 }

package/lib/types/constants.d.ts

@@ -25,5 +25,5 @@ export declare const IO_TESTNET_PROCESS_ID = "agYcCFJtrMG6cqMuZfskIkFTGvUPddICmt
 export declare const ANT_REGISTRY_ID = "i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc";
 export declare const MIO_PER_IO = 1000000;
 export declare const AOS_MODULE_ID = "cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk";
-export declare const ANT_LUA_ID = "pOh2yupSaQCrLI_-ah8tVTiusUdVNTxxeWTQQHNdf30";
+export declare const ANT_LUA_ID = "AWO2a2lVfQnjPFThjE4Uuw4ZFAd9EsCHBEgDYkJA-kk";
 export declare const DEFAULT_SCHEDULER_ID = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";

package/lib/types/types/ant.d.ts

@@ -41,7 +41,24 @@ export declare const AntRecordSchema: z.ZodObject<{
     transactionId: string;
     ttlSeconds: number;
 }>;
+export declare const AntEntrySchema: z.ZodIntersection<z.ZodObject<{
+    transactionId: z.ZodEffects<z.ZodString, string, string>;
+    ttlSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    transactionId: string;
+    ttlSeconds: number;
+}, {
+    transactionId: string;
+    ttlSeconds: number;
+}>, z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>>;
 export type AoANTRecord = z.infer<typeof AntRecordSchema>;
+export type AoANTRecordEntry = z.infer<typeof AntEntrySchema>;
 export declare const AntRecordsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     transactionId: z.ZodEffects<z.ZodString, string, string>;
     ttlSeconds: z.ZodNumber;
@@ -52,6 +69,22 @@ export declare const AntRecordsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     transactionId: string;
     ttlSeconds: number;
 }>>;
+export declare const AntEntriesSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{
+    transactionId: z.ZodEffects<z.ZodString, string, string>;
+    ttlSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    transactionId: string;
+    ttlSeconds: number;
+}, {
+    transactionId: string;
+    ttlSeconds: number;
+}>, z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>>, "many">;
 export declare const AntControllersSchema: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
 export declare const AntBalancesSchema: z.ZodRecord<z.ZodEffects<z.ZodString, string, string>, z.ZodNumber>;
 export declare const AntStateSchema: z.ZodObject<{
@@ -76,9 +109,7 @@ export declare const AntStateSchema: z.ZodObject<{
     Logo: z.ZodEffects<z.ZodString, string, string>;
     TotalSupply: z.ZodNumber;
     Initialized: z.ZodBoolean;
-    "Source-Code-TX-ID": z.ZodEffects<z.ZodString, string, string>;
 }, "strip", z.ZodTypeAny, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -95,7 +126,6 @@ export declare const AntStateSchema: z.ZodObject<{
     TotalSupply: number;
     Initialized: boolean;
 }, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -113,12 +143,16 @@ export declare const AntStateSchema: z.ZodObject<{
     Initialized: boolean;
 }>;
 export type AoANTState = z.infer<typeof AntStateSchema>;
-export declare const AntHandlerNames: string[];
+export declare const AntReadHandlers: readonly ["balance", "balances", "totalSupply", "info", "controllers", "record", "records", "state"];
+export type AoANTReadHandler = (typeof AntReadHandlers)[number];
+export declare const AntWriteHandlers: readonly ["evolve", "_eval", "_default", "transfer", "addController", "removeController", "setRecord", "removeRecord", "setName", "setTicker", "setDescription", "setKeywords", "setLogo", "initializeState", "releaseName", "reassignName"];
+export type AoANTWriteHandler = (typeof AntWriteHandlers)[number];
+export declare const AntHandlerNames: ("balance" | "balances" | "totalSupply" | "info" | "controllers" | "record" | "records" | "state" | "evolve" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName")[];
+export type AoANTHandler = AoANTWriteHandler | AoANTReadHandler;
 export declare const AntHandlersSchema: z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>;
 export declare const AntInfoSchema: z.ZodObject<{
     Name: z.ZodString;
     Owner: z.ZodEffects<z.ZodString, string, string>;
-    "Source-Code-TX-ID": z.ZodEffects<z.ZodString, string, string>;
     Ticker: z.ZodString;
     "Total-Supply": z.ZodEffects<z.ZodString, string, string>;
     Description: z.ZodString;
@@ -128,7 +162,6 @@ export declare const AntInfoSchema: z.ZodObject<{
     Handlers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
     HandlerNames: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
 }, "strip", z.ZodTypeAny, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -140,7 +173,6 @@ export declare const AntInfoSchema: z.ZodObject<{
     Handlers?: string[] | undefined;
     HandlerNames?: string[] | undefined;
 }, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -167,7 +199,7 @@ export interface AoANTRead {
     getRecord({ undername }: {
         undername: string;
     }, opts?: AntReadOptions): Promise<AoANTRecord | undefined>;
-    getRecords(opts?: AntReadOptions): Promise<Record<string, AoANTRecord>>;
+    getRecords(opts?: AntReadOptions): Promise<AoANTRecordEntry[]>;
     getOwner(opts?: AntReadOptions): Promise<WalletAddress>;
     getControllers(): Promise<WalletAddress[]>;
     getTicker(opts?: AntReadOptions): Promise<string>;
@@ -176,6 +208,7 @@ export interface AoANTRead {
         address: WalletAddress;
     }, opts?: AntReadOptions): Promise<number>;
     getBalances(opts?: AntReadOptions): Promise<Record<WalletAddress, number>>;
+    getHandlers(): Promise<AoANTHandler[]>;
 }
 export interface AoANTWrite extends AoANTRead {
     transfer({ target }: {
@@ -207,6 +240,9 @@ export interface AoANTWrite extends AoANTRead {
     setName({ name }: {
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    setLogo({ txId }: {
+        txId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
     releaseName({ name, ioProcessId }: {
         name: string;
         ioProcessId: string;
@@ -216,4 +252,13 @@ export interface AoANTWrite extends AoANTRead {
         ioProcessId: string;
         antProcessId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    approvePrimaryNameRequest({ name, address, ioProcessId, }: {
+        name: string;
+        address: WalletAddress;
+        ioProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    removePrimaryNames({ names, ioProcessId }: {
+        names: string[];
+        ioProcessId: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

package/lib/types/types/common.d.ts

@@ -44,6 +44,16 @@ export type WriteParameters<Input> = WithSigner<Required<ReadParameters<Input>>>
 export type AoMessageResult = {
     id: string;
 };
+export type AoPrimaryNameRequest = {
+    name: string;
+    startTimestamp: Timestamp;
+    endTimestamp: Timestamp;
+};
+export type AoPrimaryName = {
+    owner: WalletAddress;
+    name: string;
+    startTimestamp: Timestamp;
+};
 export type AtLeastOne<T, U = {
     [K in keyof T]-?: Record<K, T[K]>;
 }> = Partial<T> & U[keyof U];

package/lib/types/types/io.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { AOProcess } from '../common/index.js';
-import { AoMessageResult, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
+import { AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mIOToken } from './token.js';
 export type PaginationParams<T = Record<string, never>> = {
     cursor?: string;
@@ -46,19 +46,6 @@ export type AoRegistrationFees = Record<number, {
     permabuy: number;
 }>;
 export type AoEpochIndex = number;
-export interface AoIOState {
-    GatewayRegistry: Record<WalletAddress, AoGateway>;
-    Epochs: Record<AoEpochIndex, AoEpochData>;
-    NameRegistry: {
-        records: Record<string, AoArNSNameData>;
-        reserved: Record<string, AoArNSReservedNameData>;
-    };
-    Balances: Record<WalletAddress, number>;
-    Vaults: Record<WalletAddress, AoVaultData>;
-    Ticker: string;
-    Name: string;
-    Logo: string;
-}
 export type AoEpochObservationData = {
     failureSummaries: Record<WalletAddress, WalletAddress[]>;
     reports: Record<WalletAddress, TransactionId>;
@@ -92,6 +79,9 @@ export type AoArNSNameData = AoArNSPermabuyData | AoArNSLeaseData;
 export type AoArNSNameDataWithName = AoArNSNameData & {
     name: string;
 };
+export type AoArNSReservedNameDataWithName = AoArNSReservedNameData & {
+    name: string;
+};
 export type AoArNSBaseNameData = {
     processId: ProcessId;
     startTimestamp: number;
@@ -150,10 +140,8 @@ export type AoWalletVault = AoVaultData & {
 };
 export type AoGateway = {
     settings: AoGatewaySettings;
-    delegates: AoGatewayDelegates;
     stats: AoGatewayStats;
     totalDelegatedStake: number;
-    vaults: Record<WalletAddress, AoVaultData>;
     startTimestamp: Timestamp;
     endTimestamp: Timestamp;
     observerAddress: WalletAddress;
@@ -234,6 +222,28 @@ export type AoAuctionPriceData = {
     prices: Record<string, number>;
     currentPrice: number;
 };
+export type AoDelegationBase = {
+    type: 'stake' | 'vault';
+    gatewayAddress: WalletAddress;
+    delegationId: string;
+};
+export type AoVaultDelegation = AoDelegationBase & AoVaultData & {
+    type: 'vault';
+    vaultId: TransactionId;
+};
+export type AoStakeDelegation = AoDelegationBase & {
+    type: 'stake';
+    startTimestamp: Timestamp;
+    balance: number;
+};
+export type AoDelegation = AoStakeDelegation | AoVaultDelegation;
+export type AoGatewayVault = {
+    cursorId: string;
+    vaultId: TransactionId;
+    balance: number;
+    endTimestamp: Timestamp;
+    startTimestamp: Timestamp;
+};
 export type AoJoinNetworkParams = Pick<AoGateway, 'operatorStake' | 'observerAddress'> & Partial<AoGatewaySettings>;
 export type AoUpdateGatewaySettingsParams = AtLeastOne<AoJoinNetworkParams>;
 export interface AoIORead {
@@ -255,6 +265,12 @@ export interface AoIORead {
     } & PaginationParams<AoGatewayDelegateWithAddress>): Promise<PaginationResult<AoGatewayDelegateWithAddress>>;
     getGatewayDelegateAllowList(params?: PaginationParams<WalletAddress>): Promise<PaginationResult<WalletAddress>>;
     getGateways(params?: PaginationParams<AoGatewayWithAddress>): Promise<PaginationResult<AoGatewayWithAddress>>;
+    getDelegations(params: PaginationParams<AoDelegation> & {
+        address: WalletAddress;
+    }): Promise<PaginationResult<AoDelegation>>;
+    getGatewayVaults(params: PaginationParams<AoGatewayVault> & {
+        address: WalletAddress;
+    }): Promise<PaginationResult<AoGatewayVault>>;
     getBalance(params: {
         address: WalletAddress;
     }): Promise<number>;
@@ -263,7 +279,7 @@ export interface AoIORead {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
     getArNSRecords(params?: PaginationParams<AoArNSNameDataWithName>): Promise<PaginationResult<AoArNSNameDataWithName>>;
-    getArNSReservedNames(): Promise<Record<string, AoArNSReservedNameData> | Record<string, never>>;
+    getArNSReservedNames(params?: PaginationParams<AoArNSReservedNameDataWithName>): Promise<PaginationResult<AoArNSReservedNameDataWithName>>;
     getArNSReservedName({ name, }: {
         name: string;
     }): Promise<AoArNSReservedNameData | undefined>;
@@ -298,6 +314,20 @@ export interface AoIORead {
         address: WalletAddress;
         vaultId: string;
     }): Promise<AoVaultData>;
+    getPrimaryNameRequest(params: {
+        initiator: WalletAddress;
+    } | {
+        name: string;
+    }): Promise<AoMessageResult>;
+    getPrimaryNameRequests(params: PaginationParams<AoPrimaryNameRequest> & {
+        initiator?: WalletAddress;
+    }): Promise<PaginationResult<AoPrimaryNameRequest>>;
+    getPrimaryName(params: {
+        address: WalletAddress;
+    } | {
+        name: string;
+    }): Promise<AoPrimaryName>;
+    getPrimaryNames(params?: PaginationParams<AoPrimaryName>): Promise<PaginationResult<AoPrimaryName>>;
 }
 export interface AoIOWrite extends AoIORead {
     transfer({ target, qty, }: {
@@ -358,6 +388,9 @@ export interface AoIOWrite extends AoIORead {
         type?: 'lease' | 'permabuy';
         years?: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    requestPrimaryName(params: {
+        name: string;
+    }): Promise<AoMessageResult>;
 }
 export declare function isProcessConfiguration(config: object): config is {
     process: AOProcess;

package/lib/types/utils/ao.d.ts

@@ -1,6 +1,6 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
-import { AoANTRecord } from '../types/ant.js';
+import { AoANTRecord, AoANTRecordEntry } from '../types/ant.js';
 import { AoClient, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
 export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, state, stateContractTxId, antRegistryId, logger, arweave, }: {
     signer: AoSigner;
@@ -31,3 +31,8 @@ export declare function evolveANT({ signer, processId, luaCodeTxId, ao, logger,
 }): Promise<string>;
 export declare function isAoSigner(value: unknown): value is AoSigner;
 export declare function createAoSigner(signer: ContractSigner): AoSigner;
+/**
+ * @param records @type {AoANTRecordEntry[] | Record<string, AoANTRecord>} - the records returned by an ANT
+ * @returns @type {AoANTRecordEntry[]} - the alphabetically sorted records
+ */
+export declare function parseAntRecords(records: AoANTRecordEntry[] | Record<string, AoANTRecord>): AoANTRecordEntry[];

package/lib/types/utils/arweave.d.ts

@@ -15,6 +15,7 @@
  */
 import Arweave from 'arweave';
 import { BlockHeight, Timestamp } from '../types/common.js';
+import { PaginationParams } from '../types/io.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
 export declare const pruneTags: (tags: {
@@ -25,3 +26,7 @@ export declare const pruneTags: (tags: {
     value: string;
 }[];
 export declare const getCurrentBlockUnixTimestampMs: (arweave: Arweave) => Promise<Timestamp>;
+export declare const paginationParamsToTags: <T>(params?: PaginationParams<T>) => {
+    name: string;
+    value: string;
+}[];

package/lib/types/utils/schema.d.ts

@@ -15,7 +15,6 @@
  */
 import { z } from 'zod';
 /**
- *
  * @param schema - zod schema
  * @param v - value to parse
  * @throws {z.SafeParseError<any>} - if the value fails to parse

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "2.4.0-alpha.16";
+export declare const version = "2.5.0-alpha.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "2.4.0",
+  "version": "2.5.0-alpha.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"