@ar.io/sdk 2.3.2 → 2.4.0-alpha.1

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

@@ -0,0 +1,190 @@
+/**
+ * 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.
+ */
+import { z } from 'zod';
+import { AoMessageResult, WalletAddress, WriteOptions } from './common.js';
+/**
+ * example error:
+ *  {
+        "code": "custom",
+        "message": "Must be an Arweave Transaction ID",
+        "path": [
+          "Records",
+          "record1",
+          "transactionId"
+        ]
+      },
+ */
+export declare const ArweaveTxIdSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const IntegerStringSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const AntRecordSchema: z.ZodObject<{
+    transactionId: z.ZodEffects<z.ZodString, string, string>;
+    ttlSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    transactionId: string;
+    ttlSeconds: number;
+}, {
+    transactionId: string;
+    ttlSeconds: number;
+}>;
+export type AoANTRecord = z.infer<typeof AntRecordSchema>;
+export declare const AntRecordsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    transactionId: z.ZodEffects<z.ZodString, string, string>;
+    ttlSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    transactionId: string;
+    ttlSeconds: number;
+}, {
+    transactionId: string;
+    ttlSeconds: number;
+}>>;
+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<{
+    Name: z.ZodString;
+    Ticker: z.ZodString;
+    Denomination: z.ZodNumber;
+    Owner: z.ZodEffects<z.ZodString, string, string>;
+    Controllers: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
+    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
+        transactionId: z.ZodEffects<z.ZodString, string, string>;
+        ttlSeconds: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        transactionId: string;
+        ttlSeconds: number;
+    }, {
+        transactionId: string;
+        ttlSeconds: number;
+    }>>;
+    Balances: z.ZodRecord<z.ZodEffects<z.ZodString, string, string>, z.ZodNumber>;
+    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;
+    Denomination: number;
+    Owner: string;
+    Controllers: string[];
+    Records: Record<string, {
+        transactionId: string;
+        ttlSeconds: number;
+    }>;
+    Balances: Record<string, number>;
+    Logo: string;
+    TotalSupply: number;
+    Initialized: boolean;
+}, {
+    "Source-Code-TX-ID": string;
+    Name: string;
+    Ticker: string;
+    Denomination: number;
+    Owner: string;
+    Controllers: string[];
+    Records: Record<string, {
+        transactionId: string;
+        ttlSeconds: number;
+    }>;
+    Balances: Record<string, number>;
+    Logo: string;
+    TotalSupply: number;
+    Initialized: boolean;
+}>;
+export type AoANTState = z.infer<typeof AntStateSchema>;
+export declare const AntHandlerNames: string[];
+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>;
+    Logo: z.ZodEffects<z.ZodString, string, string>;
+    Denomination: z.ZodEffects<z.ZodString, string, string>;
+    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;
+    Denomination: string;
+    Owner: string;
+    Logo: string;
+    "Total-Supply": string;
+    Handlers?: string[] | undefined;
+    HandlerNames?: string[] | undefined;
+}, {
+    "Source-Code-TX-ID": string;
+    Name: string;
+    Ticker: string;
+    Denomination: string;
+    Owner: string;
+    Logo: string;
+    "Total-Supply": string;
+    Handlers?: string[] | undefined;
+    HandlerNames?: string[] | undefined;
+}>;
+export type AoANTInfo = z.infer<typeof AntInfoSchema>;
+/**
+ * @param state {object}
+ * @returns {boolean}
+ */
+export declare function isAoANTState(state: object): state is AoANTState;
+export type AntReadOptions = {
+    strict?: boolean;
+};
+export interface AoANTRead {
+    getState(opts?: AntReadOptions): Promise<AoANTState>;
+    getInfo(opts?: AntReadOptions): Promise<AoANTInfo>;
+    getRecord({ undername }: {
+        undername: string;
+    }, opts?: AntReadOptions): Promise<AoANTRecord | undefined>;
+    getRecords(opts?: AntReadOptions): Promise<Record<string, AoANTRecord>>;
+    getOwner(opts?: AntReadOptions): Promise<WalletAddress>;
+    getControllers(): Promise<WalletAddress[]>;
+    getTicker(opts?: AntReadOptions): Promise<string>;
+    getName(opts?: AntReadOptions): Promise<string>;
+    getBalance({ address }: {
+        address: WalletAddress;
+    }, opts?: AntReadOptions): Promise<number>;
+    getBalances(opts?: AntReadOptions): Promise<Record<WalletAddress, number>>;
+}
+export interface AoANTWrite extends AoANTRead {
+    transfer({ target }: {
+        target: WalletAddress;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    addController({ controller, }: {
+        controller: WalletAddress;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    removeController({ controller, }: {
+        controller: WalletAddress;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    setRecord({ undername, transactionId, ttlSeconds, }: {
+        undername: string;
+        transactionId: string;
+        ttlSeconds: number;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    removeRecord({ undername }: {
+        undername: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    setTicker({ ticker }: {
+        ticker: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    setName({ name }: {
+        name: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+}

package/lib/types/{common.d.ts → types/common.d.ts}

@@ -65,3 +65,23 @@ export interface AoClient {
     unmonitor: typeof unmonitor;
     dryrun: typeof dryrun;
 }
+export interface AOContract {
+    read<K>({ tags, retries, }: {
+        tags?: {
+            name: string;
+            value: string;
+        }[];
+        retries?: number;
+    }): Promise<K>;
+    send<K>({ tags, data, signer, }: {
+        tags: {
+            name: string;
+            value: string;
+        }[];
+        data: string | undefined;
+        signer: AoSigner;
+    }): Promise<{
+        id: string;
+        result?: K;
+    }>;
+}

package/lib/types/{io.d.ts → types/io.d.ts}

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AOProcess } from './common/index.js';
+import { AOProcess } from '../common/index.js';
+import { AoMessageResult, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mIOToken } from './token.js';
-import { AoMessageResult, AoSigner, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './types.js';
 export type PaginationParams = {
     cursor?: string;
     limit?: number;
@@ -203,55 +203,8 @@ export type AoBalanceWithAddress = {
     address: WalletAddress;
     balance: number;
 };
-export type AoANTState = {
-    Name: string;
-    Ticker: string;
-    Denomination: number;
-    Owner: WalletAddress;
-    Controllers: WalletAddress[];
-    Records: Record<string, AoANTRecord>;
-    Balances: Record<WalletAddress, number>;
-    Logo: string;
-    TotalSupply: number;
-    Initialized: boolean;
-    ['Source-Code-TX-ID']: string;
-};
-export type AoANTInfo = {
-    Name: string;
-    Owner: string;
-    Handlers: string[];
-    ['Source-Code-TX-ID']: string;
-    Ticker: string;
-    ['Total-Supply']: string;
-    Logo: string;
-    Denomination: string;
-};
-export type AoANTRecord = {
-    transactionId: string;
-    ttlSeconds: number;
-};
 export type AoJoinNetworkParams = Pick<AoGateway, 'operatorStake' | 'observerAddress'> & Partial<AoGatewaySettings>;
 export type AoUpdateGatewaySettingsParams = AtLeastOne<AoJoinNetworkParams>;
-export interface AOContract {
-    read<K>({ tags, retries, }: {
-        tags?: {
-            name: string;
-            value: string;
-        }[];
-        retries?: number;
-    }): Promise<K>;
-    send<K>({ tags, data, signer, }: {
-        tags: {
-            name: string;
-            value: string;
-        }[];
-        data: string | undefined;
-        signer: AoSigner;
-    }): Promise<{
-        id: string;
-        result?: K;
-    }>;
-}
 export interface AoIORead {
     getInfo(): Promise<{
         Ticker: string;
@@ -316,6 +269,11 @@ export interface AoIOWrite extends AoIORead {
     decreaseDelegateStake(params: {
         target: WalletAddress;
         decreaseQty: number | mIOToken;
+        instant?: boolean;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
+    instantDelegateWithdrawal(params: {
+        target: WalletAddress;
+        vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     saveObservations(params: {
         reportTxId: TransactionId;
@@ -340,60 +298,6 @@ export interface AoIOWrite extends AoIORead {
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
 }
-export interface AoANTRead {
-    getState(): Promise<AoANTState>;
-    getInfo(): Promise<AoANTInfo>;
-    getRecord({ undername }: {
-        undername: any;
-    }): Promise<AoANTRecord | undefined>;
-    getRecords(): Promise<Record<string, AoANTRecord>>;
-    getOwner(): Promise<WalletAddress>;
-    getControllers(): Promise<WalletAddress[]>;
-    getTicker(): Promise<string>;
-    getName(): Promise<string>;
-    getBalance({ address }: {
-        address: WalletAddress;
-    }): Promise<number>;
-    getBalances(): Promise<Record<WalletAddress, number>>;
-}
-export interface AoANTWrite extends AoANTRead {
-    transfer({ target }: {
-        target: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    addController({ controller, }: {
-        controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeController({ controller, }: {
-        controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setRecord({ undername, transactionId, ttlSeconds, }: {
-        undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeRecord({ undername }: {
-        undername: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setTicker({ ticker }: {
-        ticker: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setName({ name }: {
-        name: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-}
-export interface AoANTRegistryRead {
-    accessControlList(params: {
-        address: string;
-    }): Promise<{
-        Owned: string[];
-        Controlled: string[];
-    }>;
-}
-export interface AoANTRegistryWrite extends AoANTRegistryRead {
-    register(params: {
-        processId: string;
-    }): Promise<AoMessageResult>;
-}
 export declare function isProcessConfiguration(config: object): config is {
     process: AOProcess;
 };

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

@@ -1,7 +1,7 @@
 import Arweave from 'arweave';
-import { z } from 'zod';
 import { Logger } from '../common/index.js';
-import { AoANTRecord, AoANTState, AoClient, AoSigner, ContractSigner, WalletAddress } from '../types.js';
+import { AoANTRecord } 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;
     module?: string;
@@ -31,61 +31,3 @@ 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;
-export declare const AntStateSchema: z.ZodObject<{
-    Name: z.ZodString;
-    Ticker: z.ZodString;
-    Owner: z.ZodString;
-    Controllers: z.ZodArray<z.ZodString, "many">;
-    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, z.ZodTypeAny, "passthrough">>>;
-    Balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
-    "Source-Code-TX-ID": z.ZodString;
-}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-    Name: z.ZodString;
-    Ticker: z.ZodString;
-    Owner: z.ZodString;
-    Controllers: z.ZodArray<z.ZodString, "many">;
-    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, z.ZodTypeAny, "passthrough">>>;
-    Balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
-    "Source-Code-TX-ID": z.ZodString;
-}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-    Name: z.ZodString;
-    Ticker: z.ZodString;
-    Owner: z.ZodString;
-    Controllers: z.ZodArray<z.ZodString, "many">;
-    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        transactionId: z.ZodString;
-        ttlSeconds: z.ZodNumber;
-    }, z.ZodTypeAny, "passthrough">>>;
-    Balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
-    "Source-Code-TX-ID": z.ZodString;
-}, z.ZodTypeAny, "passthrough">>;
-/**
- * @param state
- * @returns {boolean}
- * @throws {z.ZodError} if the state object does not match the expected schema
- */
-export declare function isAoANTState(state: object, logger?: Logger): state is AoANTState;

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

@@ -1,18 +1,3 @@
-/**
- * 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.
- */
-import { BlockHeight } from '../common.js';
+import { BlockHeight } from '../types/common.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;

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

@@ -18,3 +18,4 @@ export * from './http-client.js';
 export * from './ao.js';
 export * from './json.js';
 export * from './processes.js';
+export * from './schema.js';

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

@@ -15,7 +15,8 @@
  */
 import { EventEmitter } from 'eventemitter3';
 import { ILogger } from '../common/logger.js';
-import { AoANTRegistryRead, AoArNSNameData, AoIORead, ProcessId, WalletAddress } from '../types.js';
+import { AoANTRegistryRead } from '../types/ant-registry.js';
+import { AoArNSNameData, AoIORead, ProcessId, WalletAddress } from '../types/index.js';
 /**
  * @beta This API is in beta and may change in the future.
  */

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

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+import { z } from 'zod';
+/**
+ *
+ * @param schema - zod schema
+ * @param v - value to parse
+ * @throws {z.SafeParseError<any>} - if the value fails to parse
+ */
+export declare function parseSchemaResult(schema: z.ZodTypeAny, v: unknown): z.SafeParseSuccess<any>;

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.3.2-alpha.4";
+export declare const version = "2.3.3-alpha.1";

package/lib/types/web/index.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export { ArweaveSigner, ArconnectSigner } from '@dha-team/arbundles';
-export * from '../types.js';
+export * from '../types/index.js';
 export * from '../common/index.js';
 export * from '../constants.js';
 export * from '../utils/index.js';

package/package.json

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