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

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

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

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

@@ -234,6 +234,19 @@ export declare const optionMap: {
         alias: string;
         description: string;
     };
+    revokable: {
+        alias: string;
+        description: string;
+        type: string;
+    };
+    lockLengthMs: {
+        alias: string;
+        description: string;
+    };
+    recipient: {
+        alias: string;
+        description: string;
+    };
 };
 export declare const walletOptions: {
     alias: string;
@@ -284,6 +297,10 @@ export declare const transferOptions: {
     alias: string;
     description: string;
 }[];
+export declare const vaultedTransferOptions: {
+    alias: string;
+    description: string;
+}[];
 export declare const operatorStakeOptions: {
     alias: string;
     description: string;

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

@@ -68,6 +68,7 @@ export declare function assertConfirmationPrompt<O extends {
 export declare function requiredProcessIdFromOptions<O extends ProcessIdCLIOptions>(o: O): string;
 export declare function readANTFromOptions(options: ProcessIdCLIOptions): AoANTRead;
 export declare function writeANTFromOptions(options: ProcessIdCLIOptions, signer?: ContractSigner): AoANTWrite;
+export declare function booleanFromOptions<O extends GlobalCLIOptions>(options: O, key: string): boolean;
 export declare function requiredStringFromOptions<O extends GlobalCLIOptions>(options: O, key: string): string;
 export declare function requiredStringArrayFromOptions<O extends GlobalCLIOptions>(options: O, key: string): string[];
 export declare function positiveIntegerFromOptions<O extends GlobalCLIOptions>(options: O, key: string): number | undefined;

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

@@ -147,6 +147,9 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         controller: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Sets the transactionId and ttlSeconds of a record (for updating the top level name, use undername "@".)
+     *
+     * @deprecated Use setUndernameRecord instead for undernames, and setBaseNameRecord instead for the top level name (e.g. "@")
      * @param undername @type {string} The record you want to set the transactionId and ttlSeconds of.
      * @param transactionId @type {string} The transactionId of the record.
      * @param ttlSeconds @type {number} The time to live of the record.
@@ -162,17 +165,67 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         ttlSeconds: number;
     }, 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)
+     *
+     * @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.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>;
+    /**
+     * 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)
+     *
+     * @param undername @type {string} The undername of the ANT.
+     * @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.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>;
+    /**
+     * Removes an undername from the ANT. This will remove the undername from the ANT.
+     *
+     * @param undername @type {string} The undername you want to remove.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removeUndernameRecord({ undername: "dapp" }); // removes dapp_ardrive.ar.io
+     * ```
+     */
+    removeUndernameRecord({ undername, }: {
+        undername: string;
+    }): Promise<AoMessageResult>;
+    /**
+     * Removes a record from the ANT. This will remove the record from the ANT. If '@' is provided, the top level name will be removed.
+     *
+     * @deprecated Use removeUndernameRecord instead.
      * @param undername @type {string} The record you want to remove.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
      * ```ts
-     * ant.removeRecord({ subDomain: "shorts" });
+     * ant.removeRecord({ undername: "dapp" }); // removes dapp_ardrive.ar.io
      * ```
      */
     removeRecord({ undername, }: {
         undername: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Sets the ticker of the ANT. This is the abbreviation displayed in ecosystem apps.
+     *
      * @param ticker @type {string} Sets the ANT Ticker.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -184,6 +237,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         ticker: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Sets the name of the ANT. This is the display name of the ANT. This is NOT the base name record.
+     *
      * @param name @type {string} Sets the Name of the ANT.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -195,6 +250,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         name: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Sets the description of the ANT. This is the description of the ANT displayed in ecosystem apps.
+     *
      * @param description @type {string} Sets the ANT Description.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -206,6 +263,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         description: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Sets the keywords of the ANT. This is the keywords of the ANT displayed in ecosystem apps.
+     *
      * @param keywords @type {string[]} Sets the ANT Keywords.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
      * @example
@@ -217,6 +276,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         keywords: string[];
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Sets the logo of the ANT. This is the logo of the ANT displayed in ecosystem apps. Additionally, this logo is displayed for any primary names affiliated with the ANT.
+     *
      * @param txId @type {string} - Arweave transaction id of the logo we want to set
      * @param options @type {WriteOptions} - additional options to add to the write interaction (optional)
      * @returns {Promise<AoMessageResult>} The result of the interaction.
@@ -229,6 +290,9 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         txId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
+     * Releases an ArNS name associated with the ANT. This will release the name to the public and allow anyone to register it. All primary names must be removed before the name can be released.
+     *
+     *
      * @param name @type {string} The name you want to release. The name will be put up for as a recently returned name on the ARIO contract. 50% of the winning bid will be distributed to the ANT owner at the time of purchase. If no purchase in the recently returned name period (14 epochs), the name will be released and can be reregistered by anyone.
      * @param arioProcessId @type {string} The processId of the ARIO contract. This is where the ANT will send the message to release the name.
      * @returns {Promise<AoMessageResult>} The result of the interaction.
@@ -242,7 +306,8 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         arioProcessId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
-     * Sends a message to the ARIO contract to reassign the name to a new ANT. This can only be done by the current owner of the ANT.
+     * Sends a message to the ARIO contract to reassign the the base ArNS name to a new ANT. This can only be done by the current owner of the ANT.
+     *
      * @param name @type {string} The name you want to reassign.
      * @param arioProcessId @type {string} The processId of the ARIO contract.
      * @param antProcessId @type {string} The processId of the ANT contract.
@@ -259,12 +324,33 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
     }, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Approves a primary name request for a given name or address.
+     *
+     * @param name @type {string} The name you want to approve.
+     * @param address @type {WalletAddress} The address you want to approve.
+     * @param arioProcessId @type {string} The processId of the ARIO contract.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.approvePrimaryNameRequest({ name: "ardrive", address: "U7RXcpaVShG4u9nIcPVmm2FJSM5Gru9gQCIiRaIPV7f", arioProcessId: ARIO_TESTNET_PROCESS_ID }); // approves the request for ardrive.ar.io to be registered by the address
+     * ```
      */
     approvePrimaryNameRequest({ name, address, arioProcessId, }: {
         name: string;
         address: WalletAddress;
         arioProcessId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    /**
+     * Removes primary names from the ANT. This will remove the primary names associated with the base ArNS name controlled by this ANT. All primary names must be removed before the name can be released.
+     *
+     * @param names @type {string[]} The names you want to remove.
+     * @param arioProcessId @type {string} The processId of the ARIO contract.
+     * @param notifyOwners @type {boolean} Whether to notify the owners of the primary names.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removePrimaryNames({ names: ["ardrive", "dapp_ardrive"], arioProcessId: ARIO_TESTNET_PROCESS_ID, notifyOwners: true }); // removes the primary names and associated wallet addresses assigned to "ardrive" and "dapp_ardrive"
+     * ```
+     */
     removePrimaryNames({ names, arioProcessId, notifyOwners, }: {
         names: string[];
         arioProcessId: string;

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, AoVaultData, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.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 { mARIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 type ARIOConfigNoSigner = OptionalArweave<ProcessConfiguration>;
@@ -147,6 +147,8 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         target: string;
         qty: number | mARIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    vaultedTransfer({ recipient, quantity, lockLengthMs, revokable, }: AoVaultedTransferParams, options?: WriteOptions): Promise<AoMessageResult>;
+    revokeVault({ vaultId, recipient }: AoRevokeVaultParams, 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

@@ -196,6 +196,18 @@ export interface AoANTWrite extends AoANTRead {
     removeRecord({ undername }: {
         undername: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    setBaseNameRecord({ transactionId, ttlSeconds, }: {
+        transactionId: string;
+        ttlSeconds: number;
+    }): Promise<AoMessageResult>;
+    setUndernameRecord({ undername, transactionId, ttlSeconds, }: {
+        undername: string;
+        transactionId: string;
+        ttlSeconds: number;
+    }): Promise<AoMessageResult>;
+    removeUndernameRecord({ undername, }: {
+        undername: string;
+    }): Promise<AoMessageResult>;
     setTicker({ ticker }: {
         ticker: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;

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

@@ -335,6 +335,16 @@ export type AoExtendLeaseParams = AoArNSPurchaseParams & {
 export type AoIncreaseUndernameLimitParams = AoArNSPurchaseParams & {
     increaseCount: number;
 };
+export type AoVaultedTransferParams = {
+    recipient: WalletAddress;
+    quantity: mARIOToken | number;
+    lockLengthMs: number;
+    revokable?: boolean;
+};
+export type AoRevokeVaultParams = {
+    vaultId: TransactionId;
+    recipient: WalletAddress;
+};
 export type AoGatewayRegistrySettings = {
     delegates: {
         minStake: number;
@@ -439,6 +449,8 @@ export interface AoARIOWrite extends AoARIORead {
         target: WalletAddress;
         qty: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
+    vaultedTransfer({ recipient, quantity, lockLengthMs, revokable }: AoVaultedTransferParams, options?: WriteOptions): Promise<AoMessageResult>;
+    revokeVault({ vaultId, recipient }: AoRevokeVaultParams, options?: WriteOptions): Promise<AoMessageResult>;
     joinNetwork(params: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
     updateGatewaySettings(params: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;

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

package/package.json

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