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

package/lib/cjs/common/ant-registry.js

@@ -17,9 +17,9 @@ exports.AoANTRegistryWriteable = exports.AoANTRegistryReadable = exports.ANTRegi
  * limitations under the License.
  */
 const constants_js_1 = require("../constants.js");
-const types_js_1 = require("../types.js");
+const index_js_1 = require("../types/index.js");
 const ao_js_1 = require("../utils/ao.js");
-const index_js_1 = require("./index.js");
+const index_js_2 = require("./index.js");
 class ANTRegistry {
     static init(config) {
         if (config && config.signer) {
@@ -37,21 +37,21 @@ class AoANTRegistryReadable {
     process;
     constructor(config) {
         if (config &&
-            ((0, types_js_1.isProcessIdConfiguration)(config) || (0, types_js_1.isProcessConfiguration)(config))) {
-            if ((0, types_js_1.isProcessConfiguration)(config)) {
+            ((0, index_js_1.isProcessIdConfiguration)(config) || (0, index_js_1.isProcessConfiguration)(config))) {
+            if ((0, index_js_1.isProcessConfiguration)(config)) {
                 this.process = config.process;
             }
-            else if ((0, types_js_1.isProcessIdConfiguration)(config)) {
-                this.process = new index_js_1.AOProcess({
+            else if ((0, index_js_1.isProcessIdConfiguration)(config)) {
+                this.process = new index_js_2.AOProcess({
                     processId: config.processId,
                 });
             }
             else {
-                throw new index_js_1.InvalidContractConfigurationError();
+                throw new index_js_2.InvalidContractConfigurationError();
             }
         }
         else {
-            this.process = new index_js_1.AOProcess({
+            this.process = new index_js_2.AOProcess({
                 processId: constants_js_1.ANT_REGISTRY_ID,
             });
         }

package/lib/cjs/common/ant.js

@@ -16,49 +16,62 @@ exports.AoANTWriteable = exports.AoANTReadable = exports.ANT = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const types_js_1 = require("../types.js");
+const zod_1 = require("zod");
+const ant_js_1 = require("../types/ant.js");
+const index_js_1 = require("../types/index.js");
 const ao_js_1 = require("../utils/ao.js");
-const index_js_1 = require("./index.js");
+const schema_js_1 = require("../utils/schema.js");
+const index_js_2 = require("./index.js");
 class ANT {
-    static init({ signer, ...config }) {
+    static init({ signer, strict = false, ...config }) {
         // ao supported implementation
-        if ((0, types_js_1.isProcessConfiguration)(config) || (0, types_js_1.isProcessIdConfiguration)(config)) {
+        if ((0, index_js_1.isProcessConfiguration)(config) || (0, index_js_1.isProcessIdConfiguration)(config)) {
             if (!signer) {
-                return new AoANTReadable(config);
+                return new AoANTReadable({ strict, ...config });
             }
-            return new AoANTWriteable({ signer, ...config });
+            return new AoANTWriteable({ signer, strict, ...config });
         }
-        throw new index_js_1.InvalidContractConfigurationError();
+        throw new index_js_2.InvalidContractConfigurationError();
     }
 }
 exports.ANT = ANT;
 class AoANTReadable {
     process;
+    strict;
     constructor(config) {
-        if ((0, types_js_1.isProcessConfiguration)(config)) {
+        this.strict = config.strict || false;
+        if ((0, index_js_1.isProcessConfiguration)(config)) {
             this.process = config.process;
         }
-        else if ((0, types_js_1.isProcessIdConfiguration)(config)) {
-            this.process = new index_js_1.AOProcess({
+        else if ((0, index_js_1.isProcessIdConfiguration)(config)) {
+            this.process = new index_js_2.AOProcess({
                 processId: config.processId,
             });
         }
         else {
-            throw new index_js_1.InvalidContractConfigurationError();
+            throw new index_js_2.InvalidContractConfigurationError();
         }
     }
-    async getState() {
+    async getState({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'State' }];
         const res = await this.process.read({
             tags,
         });
+        if (strict) {
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntStateSchema.passthrough().and(zod_1.z.object({
+                Records: zod_1.z.record(zod_1.z.string(), ant_js_1.AntRecordSchema.passthrough()),
+            })), res);
+        }
         return res;
     }
-    async getInfo() {
+    async getInfo({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'Info' }];
         const info = await this.process.read({
             tags,
         });
+        if (strict) {
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntInfoSchema.passthrough(), info);
+        }
         return info;
     }
     /**
@@ -70,7 +83,7 @@ class AoANTReadable {
      * ant.getRecord({ undername: "john" });
      * ```
      */
-    async getRecord({ undername }) {
+    async getRecord({ undername }, { strict } = { strict: this.strict }) {
         const tags = [
             { name: 'Sub-Domain', value: undername },
             { name: 'Action', value: 'Record' },
@@ -78,6 +91,8 @@ class AoANTReadable {
         const record = await this.process.read({
             tags,
         });
+        if (strict)
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntRecordSchema.passthrough(), record);
         return record;
     }
     /**
@@ -88,11 +103,13 @@ class AoANTReadable {
      * ant.getRecords();
      * ````
      */
-    async getRecords() {
+    async getRecords({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'Records' }];
         const records = await this.process.read({
             tags,
         });
+        if (strict)
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntRecordsSchema, records);
         return records;
     }
     /**
@@ -103,8 +120,8 @@ class AoANTReadable {
      *  ant.getOwner();
      * ```
      */
-    async getOwner() {
-        const info = await this.getInfo();
+    async getOwner({ strict } = { strict: this.strict }) {
+        const info = await this.getInfo({ strict });
         return info.Owner;
     }
     /**
@@ -115,11 +132,13 @@ class AoANTReadable {
      * ant.getControllers();
      * ```
      */
-    async getControllers() {
+    async getControllers({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'Controllers' }];
         const controllers = await this.process.read({
             tags,
         });
+        if (strict)
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntControllersSchema, controllers);
         return controllers;
     }
     /**
@@ -130,8 +149,8 @@ class AoANTReadable {
      * ant.getName();
      * ```
      */
-    async getName() {
-        const info = await this.getInfo();
+    async getName({ strict } = { strict: this.strict }) {
+        const info = await this.getInfo({ strict });
         return info.Name;
     }
     /**
@@ -142,8 +161,8 @@ class AoANTReadable {
      * ant.getTicker();
      * ```
      */
-    async getTicker() {
-        const info = await this.getInfo();
+    async getTicker({ strict } = { strict: this.strict }) {
+        const info = await this.getInfo({ strict });
         return info.Ticker;
     }
     /**
@@ -154,11 +173,13 @@ class AoANTReadable {
      * ant.getBalances();
      * ```
      */
-    async getBalances() {
+    async getBalances({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'Balances' }];
         const balances = await this.process.read({
             tags,
         });
+        if (strict)
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntBalancesSchema, balances);
         return balances;
     }
     /**
@@ -170,7 +191,7 @@ class AoANTReadable {
      * ant.getBalance({ address });
      * ```
      */
-    async getBalance({ address }) {
+    async getBalance({ address }, { strict } = { strict: this.strict }) {
         const tags = [
             { name: 'Action', value: 'Balance' },
             { name: 'Recipient', value: address },
@@ -178,6 +199,8 @@ class AoANTReadable {
         const balance = await this.process.read({
             tags,
         });
+        if (strict)
+            (0, schema_js_1.parseSchemaResult)(zod_1.z.number(), balance);
         return balance;
     }
 }

package/lib/cjs/common/io.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IOWriteable = exports.IOReadable = exports.IO = void 0;
 const constants_js_1 = require("../constants.js");
-const io_js_1 = require("../io.js");
+const io_js_1 = require("../types/io.js");
 const ao_js_1 = require("../utils/ao.js");
 const arweave_js_1 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
@@ -513,6 +513,19 @@ class IOWriteable extends IOReadable {
                 { name: 'Action', value: 'Decrease-Delegate-Stake' },
                 { name: 'Target', value: params.target },
                 { name: 'Quantity', value: params.decreaseQty.valueOf().toString() },
+                { name: 'Instant', value: `${params.instant || false}` },
+            ],
+        });
+    }
+    async instantDelegateWithdrawal(params, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            signer: this.signer,
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Decrease-Delegate-Stake' },
+                { name: 'Target', value: params.target },
+                { name: 'Vault-Id', value: params.vaultId },
             ],
         });
     }

package/lib/cjs/node/index.js

@@ -33,7 +33,7 @@ exports.ArconnectSigner = exports.ArweaveSigner = void 0;
 var arbundles_1 = require("@dha-team/arbundles");
 Object.defineProperty(exports, "ArweaveSigner", { enumerable: true, get: function () { return arbundles_1.ArweaveSigner; } });
 Object.defineProperty(exports, "ArconnectSigner", { enumerable: true, get: function () { return arbundles_1.ArconnectSigner; } });
-__exportStar(require("../types.js"), exports);
+__exportStar(require("../types/index.js"), exports);
 __exportStar(require("../common/index.js"), exports);
 __exportStar(require("../constants.js"), exports);
 __exportStar(require("../utils/index.js"), exports);

package/lib/cjs/types/ant.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAoANTState = exports.AntInfoSchema = exports.AntHandlersSchema = exports.AntHandlerNames = exports.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntRecordsSchema = exports.AntRecordSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
+/**
+ * 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.
+ */
+const zod_1 = require("zod");
+const constants_js_1 = require("../constants.js");
+/**
+ * example error:
+ *  {
+        "code": "custom",
+        "message": "Must be an Arweave Transaction ID",
+        "path": [
+          "Records",
+          "record1",
+          "transactionId"
+        ]
+      },
+ */
+exports.ArweaveTxIdSchema = zod_1.z
+    .string({
+    description: 'Arweave Transaction ID',
+})
+    .refine((val) => constants_js_1.ARWEAVE_TX_REGEX.test(val), {
+    message: 'Must be an Arweave Transaction ID',
+});
+exports.IntegerStringSchema = zod_1.z
+    .string({
+    description: 'Integer String',
+})
+    .refine((val) => {
+    const num = parseInt(val);
+    return Number.isInteger(num) && num >= 0;
+}, { message: 'Must be a non negative integer string' });
+exports.AntRecordSchema = zod_1.z.object({
+    transactionId: exports.ArweaveTxIdSchema.describe('The Target ID of the undername'),
+    ttlSeconds: zod_1.z.number(),
+});
+exports.AntRecordsSchema = zod_1.z.record(zod_1.z.string(), exports.AntRecordSchema);
+exports.AntControllersSchema = zod_1.z.array(exports.ArweaveTxIdSchema.describe('Controller address'));
+exports.AntBalancesSchema = zod_1.z.record(exports.ArweaveTxIdSchema.describe('Holder address'), zod_1.z.number());
+exports.AntStateSchema = zod_1.z.object({
+    Name: zod_1.z.string().describe('The name of the ANT.'),
+    Ticker: zod_1.z.string().describe('The ticker symbol for the ANT.'),
+    Denomination: zod_1.z
+        .number()
+        .describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.')
+        .min(0, { message: 'Denomination must be a non-negative number' }),
+    Owner: exports.ArweaveTxIdSchema.describe('The Owners address.'),
+    Controllers: exports.AntControllersSchema.describe('Controllers of the ANT who have administrative privileges.'),
+    Records: exports.AntRecordsSchema.describe('Records associated with the ANT.'),
+    Balances: exports.AntBalancesSchema.describe('Balance details for each address holding the ANT.'),
+    Logo: exports.ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
+    TotalSupply: zod_1.z
+        .number()
+        .describe('Total supply of the ANT in circulation.')
+        .min(0, { message: 'Total supply must be a non-negative number' }),
+    Initialized: zod_1.z
+        .boolean()
+        .describe('Flag indicating whether the ANT has been initialized.'),
+    ['Source-Code-TX-ID']: exports.ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
+});
+exports.AntHandlerNames = [
+    'evolve',
+    '_eval',
+    '_default',
+    'transfer',
+    'balance',
+    'balances',
+    'totalSupply',
+    'info',
+    'addController',
+    'removeController',
+    'controllers',
+    'setRecord',
+    'removeRecord',
+    'record',
+    'records',
+    'setName',
+    'setTicker',
+    'initializeState',
+    'state',
+];
+exports.AntHandlersSchema = zod_1.z
+    .array(zod_1.z.string({ description: 'Handler Name' }))
+    .refine((antHandlers) => {
+    return exports.AntHandlerNames.every((handler) => antHandlers.includes(handler));
+}, {
+    message: 'ANT is missing required handlers',
+});
+exports.AntInfoSchema = zod_1.z.object({
+    Name: zod_1.z.string().describe('The name of the ANT.'),
+    Owner: exports.ArweaveTxIdSchema.describe('The Owners address.'),
+    ['Source-Code-TX-ID']: exports.ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
+    Ticker: zod_1.z.string().describe('The ticker symbol for the ANT.'),
+    ['Total-Supply']: exports.IntegerStringSchema.describe('Total supply of the ANT in circulation.'),
+    Logo: exports.ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
+    Denomination: exports.IntegerStringSchema.describe('The number of decimal places to use for the ANT. Defaults to 0 if not set representing whole numbers.'),
+    Handlers: exports.AntHandlersSchema.optional().describe('List of handlers for the ANT.'),
+    HandlerNames: exports.AntHandlersSchema.optional().describe('Deprecated: List of handlers for the ANT. Use "Handlers" instead.'),
+});
+/**
+ * @param state {object}
+ * @returns {boolean}
+ */
+function isAoANTState(state) {
+    return exports.AntStateSchema.safeParse(state).success;
+}
+exports.isAoANTState = isAoANTState;

package/lib/cjs/types/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/{io.js → types/io.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = void 0;
-const arweave_js_1 = require("./utils/arweave.js");
+const arweave_js_1 = require("../utils/arweave.js");
 // Typeguard functions
 function isProcessConfiguration(config) {
     return 'process' in config;

package/lib/cjs/{token.js → types/token.js}

@@ -16,7 +16,7 @@ exports.mIOToken = exports.IOToken = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const constants_js_1 = require("./constants.js");
+const constants_js_1 = require("../constants.js");
 class PositiveFiniteInteger {
     positiveFiniteInteger;
     constructor(positiveFiniteInteger) {

package/lib/cjs/utils/ao.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAoANTState = exports.AntStateSchema = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
+exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -177,37 +177,3 @@ function createAoSigner(signer) {
     return aoSigner;
 }
 exports.createAoSigner = createAoSigner;
-// using passThrough to require the minimum fields and allow others (eg TotalSupply, Logo, etc)
-exports.AntStateSchema = zod_1.z
-    .object({
-    Name: zod_1.z.string(),
-    Ticker: zod_1.z.string(),
-    Owner: zod_1.z.string(),
-    Controllers: zod_1.z.array(zod_1.z.string()),
-    Records: zod_1.z.record(zod_1.z.string(), zod_1.z
-        .object({
-        transactionId: zod_1.z.string(),
-        ttlSeconds: zod_1.z.number(),
-    })
-        .passthrough()),
-    Balances: zod_1.z.record(zod_1.z.string(), zod_1.z.number()),
-    ['Source-Code-TX-ID']: zod_1.z.string(),
-})
-    .passthrough();
-/**
- * @param state
- * @returns {boolean}
- * @throws {z.ZodError} if the state object does not match the expected schema
- */
-function isAoANTState(state, logger = index_js_1.Logger.default) {
-    try {
-        exports.AntStateSchema.parse(state);
-        return true;
-    }
-    catch (error) {
-        // this allows us to see the path of the error in the object as well as the expected schema on invalid fields
-        logger.error(error.issues);
-        return false;
-    }
-}
-exports.isAoANTState = isAoANTState;

package/lib/cjs/utils/arweave.js

@@ -1,6 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isBlockHeight = exports.validateArweaveId = void 0;
+/**
+ * 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.
+ */
 const constants_js_1 = require("../constants.js");
 const validateArweaveId = (id) => {
     return constants_js_1.ARWEAVE_TX_REGEX.test(id);

package/lib/cjs/utils/index.js

@@ -34,3 +34,4 @@ __exportStar(require("./http-client.js"), exports);
 __exportStar(require("./ao.js"), exports);
 __exportStar(require("./json.js"), exports);
 __exportStar(require("./processes.js"), exports);
+__exportStar(require("./schema.js"), exports);

package/lib/cjs/utils/processes.js

@@ -98,6 +98,7 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
             }
             const ant = ant_js_1.ANT.init({
                 processId,
+                strict: true,
             });
             const state = (await timeout(this.timeoutMs, ant.getState()).catch((e) => {
                 this.emit('error', `Error getting state for process ${processId}: ${e}`);

package/lib/cjs/utils/schema.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSchemaResult = void 0;
+/**
+ *
+ * @param schema - zod schema
+ * @param v - value to parse
+ * @throws {z.SafeParseError<any>} - if the value fails to parse
+ */
+function parseSchemaResult(schema, v) {
+    const schemaResult = schema.safeParse(v);
+    if (!schemaResult.success) {
+        throw new Error(JSON.stringify(schemaResult.error.format(), null, 2));
+    }
+    return schemaResult;
+}
+exports.parseSchemaResult = parseSchemaResult;

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '2.3.2';
+exports.version = '2.4.0-alpha.1';

package/lib/cjs/web/index.js

@@ -33,7 +33,7 @@ exports.ArconnectSigner = exports.ArweaveSigner = void 0;
 var arbundles_1 = require("@dha-team/arbundles");
 Object.defineProperty(exports, "ArweaveSigner", { enumerable: true, get: function () { return arbundles_1.ArweaveSigner; } });
 Object.defineProperty(exports, "ArconnectSigner", { enumerable: true, get: function () { return arbundles_1.ArconnectSigner; } });
-__exportStar(require("../types.js"), exports);
+__exportStar(require("../types/index.js"), exports);
 __exportStar(require("../common/index.js"), exports);
 __exportStar(require("../constants.js"), exports);
 __exportStar(require("../utils/index.js"), exports);

package/lib/esm/common/ant-registry.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { ANT_REGISTRY_ID } from '../constants.js';
-import { isProcessConfiguration, isProcessIdConfiguration, } from '../types.js';
+import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/index.js';
 import { createAoSigner } from '../utils/ao.js';
 import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANTRegistry {