feat(revokable vaults): init revokeVault and vaultedTransfer commands…

… and methods PE-7514

src/cli/cli.ts

@@ -64,7 +64,11 @@ import {
   listArNSReturnedNames,
   listGateways,
 } from './commands/readCommands.js';
-import { transfer } from './commands/transfer.js';
+import {
+  revokeVaultCLICommand,
+  transferCLICommand,
+  vaultedTransferCLICommand,
+} from './commands/transfer.js';
 import {
   addressAndVaultIdOptions,
   antStateOptions,
@@ -84,6 +88,7 @@ import {
   tokenCostOptions,
   transferOptions,
   updateGatewaySettingsOptions,
+  vaultedTransferOptions,
   writeActionOptions,
 } from './options.js';
 import {
@@ -424,7 +429,21 @@ makeCommand({
   name: 'transfer',
   description: 'Transfer ARIO to another address',
   options: transferOptions,
-  action: transfer,
+  action: transferCLICommand,
+});
+
+makeCommand({
+  name: 'vaulted-transfer',
+  description: 'Transfer ARIO to another address into a locked vault',
+  options: vaultedTransferOptions,
+  action: vaultedTransferCLICommand,
+});
+
+makeCommand({
+  name: 'revoke-vault',
+  description: 'Revoke a vaulted transfer as the controller',
+  options: [...writeActionOptions, optionMap.vaultId, optionMap.recipient],
+  action: revokeVaultCLICommand,
 });
 
 makeCommand({

src/cli/commands/transfer.ts

@@ -13,17 +13,29 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { TransferCLIOptions } from '../types.js';
+import {
+  AoRevokeVaultParams,
+  AoVaultedTransferParams,
+} from '../../types/io.js';
+import {
+  CLIWriteOptionsFromAoParams,
+  JsonSerializable,
+  TransferCLIOptions,
+} from '../types.js';
 import {
   assertEnoughMARIOBalance,
   confirmationPrompt,
   formatARIOWithCommas,
+  formatMARIOToARIOWithCommas,
+  requiredMARIOFromOptions,
+  requiredPositiveIntegerFromOptions,
+  requiredStringFromOptions,
   requiredTargetAndQuantityFromOptions,
   writeARIOFromOptions,
   writeActionTagsFromOptions,
 } from '../utils.js';
 
-export async function transfer(options: TransferCLIOptions) {
+export async function transferCLICommand(options: TransferCLIOptions) {
   const { target, arioQuantity } =
     requiredTargetAndQuantityFromOptions(options);
   const { ario, signerAddress } = writeARIOFromOptions(options);
@@ -59,3 +71,85 @@ export async function transfer(options: TransferCLIOptions) {
 
   return output;
 }
+
+export async function vaultedTransferCLICommand(
+  o: CLIWriteOptionsFromAoParams<AoVaultedTransferParams>,
+): Promise<JsonSerializable> {
+  const mARIOQuantity = requiredMARIOFromOptions(o, 'quantity');
+  const recipient = requiredStringFromOptions(o, 'recipient');
+  const { ario, signerAddress } = writeARIOFromOptions(o);
+  const lockLengthMs = requiredPositiveIntegerFromOptions(o, 'lockLengthMs');
+
+  if (!o.skipConfirmation) {
+    await assertEnoughMARIOBalance({
+      ario,
+      address: signerAddress,
+      mARIOQuantity,
+    });
+
+    const confirm = await confirmationPrompt(
+      `Are you sure you want transfer ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO to ${recipient}, locked in a ${o.revokable ? 'non-' : ''}revokable vault for ${lockLengthMs}ms?`,
+    );
+    if (!confirm) {
+      return { message: 'Transfer aborted by user' };
+    }
+  }
+
+  const result = await ario.vaultedTransfer(
+    {
+      recipient,
+      quantity: mARIOQuantity,
+      lockLengthMs,
+      revokable: o.revokable,
+    },
+    writeActionTagsFromOptions(o),
+  );
+
+  const output = {
+    senderAddress: signerAddress,
+    transferResult: result,
+    message: `Successfully vaulted transferred ${formatMARIOToARIOWithCommas(mARIOQuantity)} ARIO to ${recipient}`,
+  };
+
+  return output;
+}
+
+export async function revokeVaultCLICommand(
+  o: CLIWriteOptionsFromAoParams<AoRevokeVaultParams>,
+): Promise<JsonSerializable> {
+  const { ario, signerAddress } = writeARIOFromOptions(o);
+  const vaultId = requiredStringFromOptions(o, 'vaultId');
+  const recipient = requiredStringFromOptions(o, 'recipient');
+
+  if (!o.skipConfirmation) {
+    const vault = await ario.getVault({ vaultId, address: recipient });
+    if (!vault) {
+      throw new Error(
+        `Vault for recipient '${recipient}' with vault id '${vaultId}' not found`,
+      );
+    }
+
+    const confirm = await confirmationPrompt(
+      `Are you sure you want to revoke vault with id ${vaultId} from ${recipient}?`,
+    );
+    if (!confirm) {
+      return { message: 'Revoke aborted by user' };
+    }
+  }
+
+  const result = await ario.revokeVault(
+    {
+      vaultId,
+      recipient,
+    },
+    writeActionTagsFromOptions(o),
+  );
+
+  const output = {
+    senderAddress: signerAddress,
+    transferResult: result,
+    message: `Successfully revoked vault with id ${vaultId}`,
+  };
+
+  return output;
+}

src/cli/options.ts

@@ -243,6 +243,20 @@ export const optionMap = {
     description:
       'Where to fund the action from. e.g. "balance", "stakes", or "any',
   },
+  revokable: {
+    alias: '--revokable',
+    description:
+      'Whether the vaulted transfer is revokable by the sender. Defaults to false',
+    type: 'boolean',
+  },
+  lockLengthMs: {
+    alias: '--lock-length-ms <lockLengthMs>',
+    description: 'The length of time in milliseconds to lock the transfer for',
+  },
+  recipient: {
+    alias: '--recipient <recipient>',
+    description: 'The recipient to interact with',
+  },
 };
 
 export const walletOptions = [
@@ -303,6 +317,14 @@ export const transferOptions = [
   optionMap.target,
 ];
 
+export const vaultedTransferOptions = [
+  ...writeActionOptions,
+  optionMap.quantity,
+  optionMap.recipient,
+  optionMap.lockLengthMs,
+  optionMap.revokable,
+];
+
 export const operatorStakeOptions = [
   ...writeActionOptions,
   optionMap.operatorStake,

src/cli/utils.ts

@@ -543,6 +543,13 @@ export function writeANTFromOptions(
   });
 }
 
+export function booleanFromOptions<O extends GlobalCLIOptions>(
+  options: O,
+  key: string,
+): boolean {
+  return !!options[key];
+}
+
 export function requiredStringFromOptions<O extends GlobalCLIOptions>(
   options: O,
   key: string,

src/common/io.ts

@@ -62,8 +62,10 @@ import {
   AoIncreaseUndernameLimitParams,
   AoPaginatedAddressParams,
   AoRegistrationFees,
+  AoRevokeVaultParams,
   AoTokenCostParams,
   AoVaultData,
+  AoVaultedTransferParams,
   AoWalletVault,
   CostDetailsResult,
   DemandFactorSettings,
@@ -770,6 +772,46 @@ export class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
     });
   }
 
+  async vaultedTransfer(
+    {
+      recipient,
+      quantity,
+      lockLengthMs,
+      revokable = false,
+    }: AoVaultedTransferParams,
+    options?: WriteOptions,
+  ): Promise<AoMessageResult> {
+    const { tags = [] } = options || {};
+
+    return this.process.send({
+      tags: [
+        ...tags,
+        { name: 'Action', value: 'Vaulted-Transfer' },
+        { name: 'Recipient', value: recipient },
+        { name: 'Quantity', value: quantity.toString() },
+        { name: 'Lock-Length', value: lockLengthMs.toString() },
+        { name: 'Revokable', value: `${revokable}` },
+      ],
+      signer: this.signer,
+    });
+  }
+
+  async revokeVault(
+    { vaultId, recipient }: AoRevokeVaultParams,
+    options?: WriteOptions,
+  ): Promise<AoMessageResult> {
+    const { tags = [] } = options || {};
+    return this.process.send({
+      tags: [
+        ...tags,
+        { name: 'Action', value: 'Revoke-Vault' },
+        { name: 'Vault-Id', value: vaultId },
+        { name: 'Recipient', value: recipient },
+      ],
+      signer: this.signer,
+    });
+  }
+
   async joinNetwork(
     {
       operatorStake,

src/types/io.ts

@@ -455,6 +455,18 @@ 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;
@@ -625,6 +637,15 @@ export interface AoARIOWrite extends AoARIORead {
     },
     options?: WriteOptions,
   ): Promise<AoMessageResult>;
+  vaultedTransfer(
+    { recipient, quantity, lockLengthMs, revokable }: AoVaultedTransferParams,
+    options?: WriteOptions,
+  ): Promise<AoMessageResult>;
+  revokeVault(
+    { vaultId, recipient }: AoRevokeVaultParams,
+    options?: WriteOptions,
+  ): Promise<AoMessageResult>;
+
   // TODO: these could be moved to a separate Gateways class that implements gateway specific interactions
   joinNetwork(
     params: AoJoinNetworkParams,