@ar.io/sdk 3.4.0-alpha.2 → 3.4.0-alpha.4

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

@@ -1,4 +1,4 @@
-import { assertEnoughMARIOBalance, confirmationPrompt, formatARIOWithCommas, formatMARIOToARIOWithCommas, requiredMARIOFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
+import { assertEnoughMARIOBalance, assertLockLengthInRange, confirmationPrompt, formatARIOWithCommas, formatMARIOToARIOWithCommas, requiredMARIOFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, requiredTargetAndQuantityFromOptions, writeARIOFromOptions, writeActionTagsFromOptions, } from '../utils.js';
 export async function transferCLICommand(options) {
     const { target, arioQuantity } = requiredTargetAndQuantityFromOptions(options);
     const { ario, signerAddress } = writeARIOFromOptions(options);
@@ -29,6 +29,7 @@ export async function vaultedTransferCLICommand(o) {
     const recipient = requiredStringFromOptions(o, 'recipient');
     const { ario, signerAddress } = writeARIOFromOptions(o);
     const lockLengthMs = requiredPositiveIntegerFromOptions(o, 'lockLengthMs');
+    assertLockLengthInRange(lockLengthMs);
     if (!o.skipConfirmation) {
         await assertEnoughMARIOBalance({
             ario,
@@ -78,3 +79,81 @@ export async function revokeVaultCLICommand(o) {
     };
     return output;
 }
+export async function createVaultCLICommand(o) {
+    const mARIOQuantity = requiredMARIOFromOptions(o, 'quantity');
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const lockLengthMs = requiredPositiveIntegerFromOptions(o, 'lockLengthMs');
+    assertLockLengthInRange(lockLengthMs);
+    if (!o.skipConfirmation) {
+        await assertEnoughMARIOBalance({
+            ario,
+            address: signerAddress,
+            mARIOQuantity,
+        });
+        const confirm = await confirmationPrompt(`Are you sure you want to create a vault with ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO, locked for ${lockLengthMs}ms?`);
+        if (!confirm) {
+            return { message: 'Vault creation aborted by user' };
+        }
+    }
+    const result = await ario.createVault({
+        quantity: mARIOQuantity,
+        lockLengthMs,
+    }, writeActionTagsFromOptions(o));
+    const output = {
+        senderAddress: signerAddress,
+        transferResult: result,
+        message: `Successfully created vault with ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO`,
+    };
+    return output;
+}
+export async function extendVaultCLICommand(o) {
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const vaultId = requiredStringFromOptions(o, 'vaultId');
+    const extendLengthMs = requiredPositiveIntegerFromOptions(o, 'extendLengthMs');
+    assertLockLengthInRange(extendLengthMs, false);
+    if (!o.skipConfirmation) {
+        const vault = await ario.getVault({ vaultId, address: signerAddress });
+        if (!vault) {
+            throw new Error(`Vault for signer '${signerAddress}' with vault id '${vaultId}' not found`);
+        }
+        const confirm = await confirmationPrompt(`Are you sure you want to extend vault with id ${vaultId} for ${extendLengthMs}ms?`);
+        if (!confirm) {
+            return { message: 'Vault extension aborted by user' };
+        }
+    }
+    const result = await ario.extendVault({
+        vaultId,
+        extendLengthMs,
+    }, writeActionTagsFromOptions(o));
+    const output = {
+        senderAddress: signerAddress,
+        transferResult: result,
+        message: `Successfully extended vault with id ${vaultId}`,
+    };
+    return output;
+}
+export async function increaseVaultCLICommand(o) {
+    const mARIOQuantity = requiredMARIOFromOptions(o, 'quantity');
+    const { ario, signerAddress } = writeARIOFromOptions(o);
+    const vaultId = requiredStringFromOptions(o, 'vaultId');
+    if (!o.skipConfirmation) {
+        const vault = await ario.getVault({ vaultId, address: signerAddress });
+        if (!vault) {
+            throw new Error(`Vault for signer '${signerAddress}' with vault id '${vaultId}' not found`);
+        }
+        const confirm = await confirmationPrompt(`Are you sure you want to increase vault with id ${vaultId} by ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO?`);
+        if (!confirm) {
+            return { message: 'Vault increase aborted by user' };
+        }
+    }
+    const result = await ario.increaseVault({
+        vaultId,
+        quantity: mARIOQuantity,
+    }, writeActionTagsFromOptions(o));
+    const output = {
+        senderAddress: signerAddress,
+        transferResult: result,
+        message: `Successfully increased vault with id ${vaultId} by ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO`,
+    };
+    return output;
+}

package/lib/esm/cli/options.js

@@ -245,7 +245,11 @@ export const optionMap = {
     },
     lockLengthMs: {
         alias: '--lock-length-ms <lockLengthMs>',
-        description: 'The length of time in milliseconds to lock the transfer for',
+        description: 'The length of time in milliseconds to lock the vault for',
+    },
+    extendLengthMs: {
+        alias: '--extend-length-ms <extendLengthMs>',
+        description: 'The length of time in milliseconds to extend the vault for',
     },
     recipient: {
         alias: '--recipient <recipient>',
@@ -351,3 +355,13 @@ export const antStateOptions = [
     optionMap.controllers,
     optionMap.ttlSeconds,
 ];
+export const setAntBaseNameOptions = [
+    optionMap.processId,
+    optionMap.transactionId,
+    optionMap.ttlSeconds,
+    ...writeActionOptions,
+];
+export const setAntUndernameOptions = [
+    ...setAntBaseNameOptions,
+    optionMap.undername,
+];

package/lib/esm/cli/utils.js

@@ -19,6 +19,7 @@ import { readFileSync } from 'fs';
 import prompts from 'prompts';
 import { ANT, AOProcess, ARIO, ARIOToken, ARIO_DEVNET_PROCESS_ID, ARIO_TESTNET_PROCESS_ID, ArweaveSigner, Logger, createAoSigner, fromB64Url, fundFromOptions, initANTStateForAddress, isValidFundFrom, isValidIntent, mARIOToken, sha256B64Url, validIntents, } from '../node/index.js';
 import { globalOptions } from './options.js';
+export const defaultTtlSecondsCLI = 3600;
 export function stringifyJsonForCLIDisplay(json) {
     return JSON.stringify(json, null, 2);
 }
@@ -385,7 +386,9 @@ export function getANTStateFromOptions(options) {
         ticker: options.ticker,
         name: options.name,
         keywords: options.keywords,
-        ttlSeconds: options.ttlSeconds !== undefined ? +options.ttlSeconds : 3600,
+        ttlSeconds: options.ttlSeconds !== undefined
+            ? +options.ttlSeconds
+            : defaultTtlSecondsCLI,
     });
 }
 export function getTokenCostParamsFromOptions(o) {
@@ -415,3 +418,16 @@ export function fundFromFromOptions(o) {
     }
     return o.fundFrom ?? 'balance';
 }
+export function assertLockLengthInRange(lockLengthMs, assertMin = true) {
+    const minLockLengthMs = 1209600000; // 14 days
+    const maxLockLengthMs = 378432000000; // ~12 years
+    if (lockLengthMs > maxLockLengthMs) {
+        throw new Error(`Lock length must be at most 12 years (378432000000 ms). Provided lock length: ${lockLengthMs} ms`);
+    }
+    if (!assertMin) {
+        return;
+    }
+    if (lockLengthMs < minLockLengthMs) {
+        throw new Error(`Lock length must be at least 14 days (1209600000 ms). Provided lock length: ${lockLengthMs} ms`);
+    }
+}

package/lib/esm/common/ant.js

@@ -30,6 +30,7 @@ export class ANT {
 }
 export class AoANTReadable {
     process;
+    processId;
     strict;
     constructor(config) {
         this.strict = config.strict || false;
@@ -44,6 +45,7 @@ export class AoANTReadable {
         else {
             throw new InvalidContractConfigurationError();
         }
+        this.processId = this.process.processId;
     }
     async getState({ strict } = { strict: this.strict }) {
         const tags = [{ name: 'Action', value: 'State' }];
@@ -287,12 +289,8 @@ export class AoANTWriteable extends AoANTReadable {
      * @param transactionId @type {string} The transactionId of the record.
      * @param ttlSeconds @type {number} The time to live of the record.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
      */
-    async setRecord({ undername, transactionId, ttlSeconds, }, options) {
+    async setRecord({ undername, transactionId, ttlSeconds }, options) {
         return this.process.send({
             tags: [
                 ...(options?.tags ?? []),
@@ -315,16 +313,12 @@ export class AoANTWriteable extends AoANTReadable {
      * ant.setBaseNameRecord({ transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
      * ```
      */
-    async setBaseNameRecord({ transactionId, ttlSeconds, }) {
-        return this.process.send({
-            tags: [
-                { name: 'Action', value: 'Set-Record' },
-                { name: 'Sub-Domain', value: '@' },
-                { name: 'Transaction-Id', value: transactionId },
-                { name: 'TTL-Seconds', value: ttlSeconds.toString() },
-            ],
-            signer: this.signer,
-        });
+    async setBaseNameRecord({ transactionId, ttlSeconds }, options) {
+        return this.setRecord({
+            transactionId,
+            ttlSeconds,
+            undername: '@',
+        }, options);
     }
     /**
      * Adds or updates an undername of the ANT. An undername is appended to the base name of the ANT (e.g. ardrive.ar.io) to form a fully qualified name (e.g. dapp_ardrive.ar.io)
@@ -338,12 +332,12 @@ export class AoANTWriteable extends AoANTReadable {
      * ant.setUndernameRecord({ undername: "dapp", transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // dapp_ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
      * ```
      */
-    async setUndernameRecord({ undername, transactionId, ttlSeconds, }) {
+    async setUndernameRecord({ undername, transactionId, ttlSeconds }, options) {
         return this.setRecord({
             undername,
             transactionId,
             ttlSeconds,
-        });
+        }, options);
     }
     /**
      * Removes an undername from the ANT. This will remove the undername from the ANT.

package/lib/esm/common/io.js

@@ -513,6 +513,42 @@ export class ARIOWriteable extends ARIOReadable {
             signer: this.signer,
         });
     }
+    async createVault({ lockLengthMs, quantity }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Create-Vault' },
+                { name: 'Lock-Length', value: lockLengthMs.toString() },
+                { name: 'Quantity', value: quantity.toString() },
+            ],
+            signer: this.signer,
+        });
+    }
+    async extendVault({ vaultId, extendLengthMs }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Extend-Vault' },
+                { name: 'Vault-Id', value: vaultId },
+                { name: 'Extend-Length', value: extendLengthMs.toString() },
+            ],
+            signer: this.signer,
+        });
+    }
+    async increaseVault({ vaultId, quantity }, options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            tags: [
+                ...tags,
+                { name: 'Action', value: 'Increase-Vault' },
+                { name: 'Vault-Id', value: vaultId },
+                { name: 'Quantity', value: quantity.toString() },
+            ],
+            signer: this.signer,
+        });
+    }
     async joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [

package/lib/esm/types/io.js

@@ -19,7 +19,7 @@ export const fundFromOptions = ['balance', 'stakes', 'any'];
 export const isValidFundFrom = (fundFrom) => {
     return fundFromOptions.indexOf(fundFrom) !== -1;
 };
-// Typeguard functions
+// Type-guard functions
 export function isProcessConfiguration(config) {
     return 'process' in config;
 }

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.4.0-alpha.2';
+export const version = '3.4.0-alpha.4';

package/lib/types/cli/commands/antCommands.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams } from '../../types/ant.js';
+import { CLIWriteOptionsFromAoAntParams } from '../types.js';
+/** @deprecated -- use set-ant-base-name and set-ant-undername */
+export declare function setAntRecordCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function setAntBaseNameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetBaseNameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;
+export declare function setAntUndernameCLICommand(o: CLIWriteOptionsFromAoAntParams<AoANTSetUndernameRecordParams>): Promise<import("../../types/common.js").AoMessageResult>;

package/lib/types/cli/commands/transfer.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AoRevokeVaultParams, AoVaultedTransferParams } from '../../types/io.js';
+import { AoCreateVaultParams, AoExtendVaultParams, AoIncreaseVaultParams, AoRevokeVaultParams, AoVaultedTransferParams } from '../../types/io.js';
 import { CLIWriteOptionsFromAoParams, JsonSerializable, TransferCLIOptions } from '../types.js';
 export declare function transferCLICommand(options: TransferCLIOptions): Promise<{
     senderAddress: string;
@@ -24,3 +24,18 @@ export declare function transferCLICommand(options: TransferCLIOptions): Promise
 }>;
 export declare function vaultedTransferCLICommand(o: CLIWriteOptionsFromAoParams<AoVaultedTransferParams>): Promise<JsonSerializable>;
 export declare function revokeVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoRevokeVaultParams>): Promise<JsonSerializable>;
+export declare function createVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoCreateVaultParams>): Promise<JsonSerializable>;
+export declare function extendVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoExtendVaultParams>): Promise<{
+    senderAddress: string;
+    transferResult: import("../../types/common.js").AoMessageResult;
+    message: string;
+} | {
+    message: string;
+}>;
+export declare function increaseVaultCLICommand(o: CLIWriteOptionsFromAoParams<AoIncreaseVaultParams>): Promise<{
+    senderAddress: string;
+    transferResult: import("../../types/common.js").AoMessageResult;
+    message: string;
+} | {
+    message: string;
+}>;

package/lib/types/cli/options.d.ts

@@ -243,6 +243,10 @@ export declare const optionMap: {
         alias: string;
         description: string;
     };
+    extendLengthMs: {
+        alias: string;
+        description: string;
+    };
     recipient: {
         alias: string;
         description: string;
@@ -333,3 +337,11 @@ export declare const antStateOptions: {
     alias: string;
     description: string;
 }[];
+export declare const setAntBaseNameOptions: {
+    alias: string;
+    description: string;
+}[];
+export declare const setAntUndernameOptions: {
+    alias: string;
+    description: string;
+}[];

package/lib/types/cli/types.d.ts

@@ -49,6 +49,9 @@ export type CLIOptionsFromAoParams<T> = {
 };
 export type CLIReadOptionsFromAoParams<T> = CLIOptionsFromAoParams<T> & GlobalCLIOptions;
 export type CLIWriteOptionsFromAoParams<T> = WriteActionCLIOptions & CLIOptionsFromAoParams<T>;
+export type CLIWriteOptionsFromAoAntParams<T> = CLIWriteOptionsFromAoParams<T & {
+    processId: string;
+}>;
 export type PaginationCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<PaginationParams>;
 export type AddressCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoAddressParams>;
 export type ProcessIdCLIOptions = GlobalCLIOptions & {

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

@@ -2,6 +2,7 @@ import { JWKInterface } from 'arweave/node/lib/wallet.js';
 import { Command, OptionValues } from 'commander';
 import { ARIOToken, AoANTRead, AoANTWrite, AoARIORead, AoARIOWrite, AoGetCostDetailsParams, AoRedelegateStakeParams, AoSigner, AoUpdateGatewaySettingsParams, ContractSigner, EpochInput, FundFrom, Logger, PaginationParams, SpawnANTState, WriteOptions, mARIOToken } from '../node/index.js';
 import { ANTStateCLIOptions, AddressCLIOptions, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, InitiatorCLIOptions, JsonSerializable, PaginationCLIOptions, ProcessIdCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WalletCLIOptions, WriteActionCLIOptions } from './types.js';
+export declare const defaultTtlSecondsCLI = 3600;
 export declare function stringifyJsonForCLIDisplay(json: JsonSerializable | unknown): string;
 export declare function runCommand<O extends OptionValues>(command: Command, action: (options: O) => Promise<JsonSerializable>): Promise<void>;
 export interface CommanderOption {
@@ -85,3 +86,4 @@ export declare function getTokenCostParamsFromOptions(o: GetTokenCostCLIOptions)
 export declare function fundFromFromOptions<O extends {
     fundFrom?: string;
 }>(o: O): FundFrom;
+export declare function assertLockLengthInRange(lockLengthMs: number, assertMin?: boolean): void;

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

@@ -1,4 +1,4 @@
-import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTState, AoANTWrite } from '../types/ant.js';
+import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams, AoANTState, AoANTWrite } from '../types/ant.js';
 import { AoMessageResult, ProcessConfiguration, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
 import { AOProcess } from './index.js';
 type ANTConfigOptionalStrict = Required<ProcessConfiguration> & {
@@ -12,6 +12,7 @@ export declare class ANT {
 }
 export declare class AoANTReadable implements AoANTRead {
     protected process: AOProcess;
+    readonly processId: string;
     private strict;
     constructor(config: ANTConfigOptionalStrict);
     getState({ strict }?: AntReadOptions): Promise<AoANTState>;
@@ -154,16 +155,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * @param transactionId @type {string} The transactionId of the record.
      * @param ttlSeconds @type {number} The time to live of the record.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
-     * @example
-     * ```ts
-     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
-     * ```
      */
-    setRecord({ undername, transactionId, ttlSeconds, }: {
-        undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    setRecord({ undername, transactionId, ttlSeconds }: AoANTSetUndernameRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Sets the top level name of the ANT. This is the name that will be used to resolve the ANT (e.g. ardrive.ar.io)
      *
@@ -175,10 +168,7 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * ant.setBaseNameRecord({ transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
      * ```
      */
-    setBaseNameRecord({ transactionId, ttlSeconds, }: {
-        transactionId: string;
-        ttlSeconds: number;
-    }): Promise<AoMessageResult>;
+    setBaseNameRecord({ transactionId, ttlSeconds }: AoANTSetBaseNameRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Adds or updates an undername of the ANT. An undername is appended to the base name of the ANT (e.g. ardrive.ar.io) to form a fully qualified name (e.g. dapp_ardrive.ar.io)
      *
@@ -191,11 +181,7 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
      * ant.setUndernameRecord({ undername: "dapp", transactionId: "432l1cy0aksiL_x9M359faGzM_yjralacHIUo8_nQXM", ttlSeconds: 100 }); // dapp_ardrive.ar.io will resolve to the provided transaction id and be cached for 100 seconds by clients
      * ```
      */
-    setUndernameRecord({ undername, transactionId, ttlSeconds, }: {
-        undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }): Promise<AoMessageResult>;
+    setUndernameRecord({ undername, transactionId, ttlSeconds }: AoANTSetUndernameRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Removes an undername from the ANT. This will remove the undername from the ANT.
      *

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

@@ -15,7 +15,7 @@
  */
 import Arweave from 'arweave';
 import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, OptionalArweave, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoARIORead, AoARIOWrite, AoAllDelegates, AoAllGatewayVaults, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoPaginatedAddressParams, AoRegistrationFees, AoRevokeVaultParams, AoVaultData, AoVaultedTransferParams, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
+import { AoARIORead, AoARIOWrite, AoAllDelegates, AoAllGatewayVaults, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoCreateVaultParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoExtendVaultParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoIncreaseVaultParams, AoPaginatedAddressParams, AoRegistrationFees, AoRevokeVaultParams, AoVaultData, AoVaultedTransferParams, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
 import { mARIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 type ARIOConfigNoSigner = OptionalArweave<ProcessConfiguration>;
@@ -149,6 +149,9 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
     }, options?: WriteOptions): Promise<AoMessageResult>;
     vaultedTransfer({ recipient, quantity, lockLengthMs, revokable, }: AoVaultedTransferParams, options?: WriteOptions): Promise<AoMessageResult>;
     revokeVault({ vaultId, recipient }: AoRevokeVaultParams, options?: WriteOptions): Promise<AoMessageResult>;
+    createVault({ lockLengthMs, quantity }: AoCreateVaultParams, options?: WriteOptions): Promise<AoMessageResult>;
+    extendVault({ vaultId, extendLengthMs }: AoExtendVaultParams, options?: WriteOptions): Promise<AoMessageResult>;
+    increaseVault({ vaultId, quantity }: AoIncreaseVaultParams, options?: WriteOptions): Promise<AoMessageResult>;
     joinNetwork({ operatorStake, allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
     updateGatewaySettings({ allowDelegatedStaking, allowedDelegates, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { z } from 'zod';
-import { AoMessageResult, WalletAddress, WriteOptions } from './common.js';
+import { AoWriteAction, WalletAddress } from './common.js';
 /**
  * example error:
  *  {
@@ -161,6 +161,7 @@ export type AntReadOptions = {
     strict?: boolean;
 };
 export interface AoANTRead {
+    processId: string;
     getState(opts?: AntReadOptions): Promise<AoANTState>;
     getInfo(opts?: AntReadOptions): Promise<AoANTInfo>;
     getRecord({ undername }: {
@@ -179,67 +180,64 @@ export interface AoANTRead {
     getHandlers(): Promise<AoANTHandler[]>;
 }
 export interface AoANTWrite extends AoANTRead {
-    transfer({ target }: {
+    transfer: AoWriteAction<{
         target: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    addController({ controller, }: {
+    }>;
+    addController: AoWriteAction<{
         controller: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removeController({ controller, }: {
+    }>;
+    removeController: AoWriteAction<{
         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>;
-    setBaseNameRecord({ transactionId, ttlSeconds, }: {
-        transactionId: string;
-        ttlSeconds: number;
-    }): Promise<AoMessageResult>;
-    setUndernameRecord({ undername, transactionId, ttlSeconds, }: {
+    }>;
+    /** @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@") */
+    setRecord: AoWriteAction<AoANTSetUndernameRecordParams>;
+    removeRecord: AoWriteAction<{
         undername: string;
-        transactionId: string;
-        ttlSeconds: number;
-    }): Promise<AoMessageResult>;
-    removeUndernameRecord({ undername, }: {
+    }>;
+    setBaseNameRecord: AoWriteAction<AoANTSetBaseNameRecordParams>;
+    setUndernameRecord: AoWriteAction<AoANTSetUndernameRecordParams>;
+    removeUndernameRecord: AoWriteAction<{
         undername: string;
-    }): Promise<AoMessageResult>;
-    setTicker({ ticker }: {
+    }>;
+    setTicker: AoWriteAction<{
         ticker: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setDescription({ description }: {
+    }>;
+    setDescription: AoWriteAction<{
         description: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setKeywords({ keywords }: {
+    }>;
+    setKeywords: AoWriteAction<{
         keywords: string[];
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setName({ name }: {
+    }>;
+    setName: AoWriteAction<{
         name: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    setLogo({ txId }: {
+    }>;
+    setLogo: AoWriteAction<{
         txId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    releaseName({ name, arioProcessId }: {
+    }>;
+    releaseName: AoWriteAction<{
         name: string;
         arioProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    reassignName({ name, arioProcessId, antProcessId, }: {
+    }>;
+    reassignName: AoWriteAction<{
         name: string;
         arioProcessId: string;
         antProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    approvePrimaryNameRequest({ name, address, arioProcessId, }: {
+    }>;
+    approvePrimaryNameRequest: AoWriteAction<{
         name: string;
-        address: WalletAddress;
+        address: string;
         arioProcessId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    removePrimaryNames({ names, arioProcessId, notifyOwners, }: {
+    }>;
+    removePrimaryNames: AoWriteAction<{
         names: string[];
         arioProcessId: string;
         notifyOwners?: boolean;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    }>;
 }
+export type AoANTSetBaseNameRecordParams = {
+    transactionId: string;
+    ttlSeconds: number;
+};
+export type AoANTSetUndernameRecordParams = AoANTSetBaseNameRecordParams & {
+    undername: string;
+};

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

@@ -111,3 +111,5 @@ export interface AOContract {
         result?: K;
     }>;
 }
+/** utility type to ensure WriteOptions are appended to each parameter set */
+export type AoWriteAction<P, R = AoMessageResult> = (params: P, options?: WriteOptions) => Promise<R>;