@ardrive/turbo-sdk 1.42.0-alpha.11 → 1.42.0-alpha.13

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

@@ -16,6 +16,7 @@
 import { BigNumber } from 'bignumber.js';
 import { solanaOwnerSigner } from '../../common/arnsActions.js';
 import { TurboFactory } from '../../node/factory.js';
+import { arNSActions, } from '../../types.js';
 import { FiatPaymentsDisabledError, InsufficientCreditsError, } from '../../utils/errors.js';
 import { wincPerCredit } from '../constants.js';
 import { configFromOptions, turboFromOptions } from '../utils.js';
@@ -34,6 +35,13 @@ function ownerFromOptions(options) {
     }
     return solanaOwnerSigner(options.ownerKey);
 }
+/** The four ARIO-purchase actions are priced via `arnsPrice`, not this route. */
+const ARNS_PURCHASE_ACTIONS = new Set([
+    'buy-name',
+    'extend-lease',
+    'upgrade-name',
+    'increase-undername-limit',
+]);
 export function requiredNameFromOptions(options) {
     if (options.name === undefined || options.name.length === 0) {
         throw new Error('Must provide an ArNS --name');
@@ -56,6 +64,25 @@ export function typeFromOptions(value) {
     }
     return value;
 }
+/** Parses `--action` for `arns-action-price`, rejecting the four purchase actions. */
+export function actionFromOptions(options) {
+    const { action } = options;
+    if (action === undefined || action.length === 0) {
+        throw new Error(`Must provide --action. One of: ${arNSActions.join(', ')}`);
+    }
+    if (!arNSActions.includes(action)) {
+        throw new Error(`Invalid --action '${action}'. One of: ${arNSActions.join(', ')}`);
+    }
+    if (ARNS_PURCHASE_ACTIONS.has(action)) {
+        throw new Error(`'${action}' is priced via \`turbo arns-price\`, not \`arns-action-price\` — ` +
+            'it spends ARIO, not just the flat credits margin this route quotes.');
+    }
+    return action;
+}
+/** `null` clears the field (Set-Record-Metadata's tri-state), `undefined` leaves it unchanged. */
+function metadataFieldFromOptions(value, clear) {
+    return clear ? null : value;
+}
 export function paidByFromArNSOptions(paidBy) {
     return paidBy !== undefined && paidBy.length > 0 ? paidBy : undefined;
 }
@@ -298,3 +325,87 @@ export async function removeArNSRecord(options, turbo) {
     });
     console.log(JSON.stringify({ message: 'ArNS record removed!', ...result }, null, 2));
 }
+export async function addArNSController(options, turbo) {
+    if (options.antId === undefined) {
+        throw new Error('Must provide an --ant-id to add a controller to');
+    }
+    const client = turbo ?? (await turboFromOptions(options));
+    const result = await client.addArNSController({
+        antId: options.antId,
+        owner: ownerFromOptions(options),
+        target: options.target,
+    });
+    console.log(JSON.stringify({ message: 'ArNS controller added!', ...result }, null, 2));
+}
+export async function removeArNSController(options, turbo) {
+    if (options.antId === undefined) {
+        throw new Error('Must provide an --ant-id to remove a controller from');
+    }
+    const client = turbo ?? (await turboFromOptions(options));
+    const result = await client.removeArNSController({
+        antId: options.antId,
+        owner: ownerFromOptions(options),
+        target: options.target,
+    });
+    console.log(JSON.stringify({ message: 'ArNS controller removed!', ...result }, null, 2));
+}
+export async function transferArNSRecord(options, turbo) {
+    if (options.antId === undefined) {
+        throw new Error('Must provide an --ant-id whose record to transfer');
+    }
+    if (options.undername === undefined || options.undername.length === 0) {
+        throw new Error('Must provide an --undername to transfer');
+    }
+    if (options.target === undefined) {
+        throw new Error('Must provide a --target address to transfer the record to');
+    }
+    const client = turbo ?? (await turboFromOptions(options));
+    const result = await client.transferArNSRecord({
+        antId: options.antId,
+        owner: ownerFromOptions(options),
+        undername: options.undername,
+        target: options.target,
+    });
+    console.log(JSON.stringify({ message: 'ArNS record transferred!', ...result }, null, 2));
+}
+export async function setArNSRecordMetadata(options, turbo) {
+    if (options.antId === undefined) {
+        throw new Error('Must provide an --ant-id to set record metadata on');
+    }
+    const client = turbo ?? (await turboFromOptions(options));
+    const result = await client.setArNSRecordMetadata({
+        antId: options.antId,
+        owner: ownerFromOptions(options),
+        undername: options.undername ?? '@',
+        displayName: metadataFieldFromOptions(options.displayName, options.clearDisplayName),
+        recordLogo: metadataFieldFromOptions(options.recordLogo, options.clearRecordLogo),
+        recordDescription: metadataFieldFromOptions(options.recordDescription, options.clearRecordDescription),
+        recordKeywords: metadataFieldFromOptions(options.recordKeywords, options.clearRecordKeywords),
+    });
+    console.log(JSON.stringify({ message: 'ArNS record metadata set!', ...result }, null, 2));
+}
+export async function removeArNSRecordMetadata(options, turbo) {
+    if (options.antId === undefined) {
+        throw new Error('Must provide an --ant-id to remove record metadata from');
+    }
+    if (options.undername === undefined || options.undername.length === 0) {
+        throw new Error('Must provide an --undername');
+    }
+    const client = turbo ?? (await turboFromOptions(options));
+    const result = await client.removeArNSRecordMetadata({
+        antId: options.antId,
+        owner: ownerFromOptions(options),
+        undername: options.undername,
+    });
+    console.log(JSON.stringify({ message: 'ArNS record metadata removed!', ...result }, null, 2));
+}
+/**
+ * Preview what one of the eight non-purchase actions will debit, without
+ * creating it.
+ */
+export async function arnsActionPrice(options, turbo) {
+    const action = actionFromOptions(options);
+    const client = turbo ?? TurboFactory.unauthenticated(configFromOptions(options));
+    const { wincQty } = await client.getArNSActionPrice(action);
+    console.log(JSON.stringify({ action, wincQty, credits: creditsFromWinc(wincQty) }, null, 2));
+}

package/lib/esm/cli/options.js

@@ -231,6 +231,48 @@ export const optionMap = {
         alias: '--ttl-seconds <ttlSeconds>',
         description: 'TTL in seconds for the ArNS record',
     },
+    arnsDisplayName: {
+        alias: '--display-name <displayName>',
+        description: 'Display name for the record (Set-Record-Metadata)',
+    },
+    arnsClearDisplayName: {
+        alias: '--clear-display-name',
+        description: 'Clear the record display name (Set-Record-Metadata)',
+        default: false,
+    },
+    arnsRecordLogo: {
+        alias: '--record-logo <transactionId>',
+        description: 'Arweave transaction ID for the record logo (Set-Record-Metadata)',
+    },
+    arnsClearRecordLogo: {
+        alias: '--clear-record-logo',
+        description: 'Clear the record logo (Set-Record-Metadata)',
+        default: false,
+    },
+    arnsRecordDescription: {
+        alias: '--record-description <description>',
+        description: 'Description for the record (Set-Record-Metadata)',
+    },
+    arnsClearRecordDescription: {
+        alias: '--clear-record-description',
+        description: 'Clear the record description (Set-Record-Metadata)',
+        default: false,
+    },
+    arnsRecordKeywords: {
+        alias: '--record-keywords <keywords...>',
+        description: 'Keywords for the record (Set-Record-Metadata)',
+        type: 'array',
+    },
+    arnsClearRecordKeywords: {
+        alias: '--clear-record-keywords',
+        description: 'Clear the record keywords (Set-Record-Metadata)',
+        default: false,
+    },
+    arnsAction: {
+        alias: '--action <action>',
+        description: 'ArNS action to price: set-record, remove-record, set-record-metadata, ' +
+            'remove-record-metadata, transfer-record, add-controller, remove-controller, or transfer',
+    },
     // ---- Payment history ----
     limit: {
         alias: '--limit <limit>',
@@ -362,3 +404,38 @@ export const removeArNSRecordOptions = [
     optionMap.arnsAntId,
     optionMap.arnsUndername,
 ];
+export const addArNSControllerOptions = [
+    ...walletOptions,
+    optionMap.arnsOwnerKey,
+    optionMap.arnsAntId,
+    optionMap.arnsTarget,
+];
+export const removeArNSControllerOptions = addArNSControllerOptions;
+export const transferArNSRecordOptions = [
+    ...walletOptions,
+    optionMap.arnsOwnerKey,
+    optionMap.arnsAntId,
+    optionMap.arnsUndername,
+    optionMap.arnsTarget,
+];
+export const setArNSRecordMetadataOptions = [
+    ...walletOptions,
+    optionMap.arnsOwnerKey,
+    optionMap.arnsAntId,
+    optionMap.arnsUndername,
+    optionMap.arnsDisplayName,
+    optionMap.arnsClearDisplayName,
+    optionMap.arnsRecordLogo,
+    optionMap.arnsClearRecordLogo,
+    optionMap.arnsRecordDescription,
+    optionMap.arnsClearRecordDescription,
+    optionMap.arnsRecordKeywords,
+    optionMap.arnsClearRecordKeywords,
+];
+export const removeArNSRecordMetadataOptions = [
+    ...walletOptions,
+    optionMap.arnsOwnerKey,
+    optionMap.arnsAntId,
+    optionMap.arnsUndername,
+];
+export const arnsActionPriceOptions = [optionMap.arnsAction];

package/lib/esm/common/chunked.js

@@ -35,7 +35,7 @@ const chunkingHeader = { 'x-chunking-version': '2' };
  * uploading them in parallel, and emitting progress/error events.
  */
 export class ChunkedUploader {
-    constructor({ http, token, maxChunkConcurrency = defaultMaxChunkConcurrency, maxFinalizeMs, chunkByteCount = defaultChunkByteCount, logger = Logger.default, chunkingMode = 'auto', dataItemByteCount, }) {
+    constructor({ http, token, maxChunkConcurrency = defaultMaxChunkConcurrency, maxFinalizeMs, chunkByteCount = defaultChunkByteCount, logger = Logger.default, chunkingMode = 'auto', dataItemByteCount, x402, x402RefundIdentity, }) {
         this.assertChunkParams({
             chunkByteCount,
             chunkingMode,
@@ -54,6 +54,9 @@ export class ChunkedUploader {
             dataItemByteCount,
         });
         this.maxBacklogQueue = this.maxChunkConcurrency * backlogQueueFactor;
+        this.x402 = x402;
+        this.x402RefundIdentity = x402RefundIdentity;
+        this.dataItemByteCount = dataItemByteCount;
     }
     shouldChunkUpload({ chunkByteCount, chunkingMode, dataItemByteCount, }) {
         if (chunkingMode === 'disabled') {
@@ -92,7 +95,54 @@ export class ChunkedUploader {
     /**
      * Initialize or resume an upload session, returning the upload ID.
      */
+    /**
+     * Open a multipart upload paid for with x402.
+     *
+     * The bundler settles the payment at CREATE, before accepting a single chunk
+     * — so an unpaid upload never consumes storage. That is why the size is
+     * declared here and the money moves here, not at finalize.
+     *
+     * The 402 handshake is delegated to `wrapFetchWithPayment`, the same
+     * mechanism the single-shot x402 POST already uses, so the signer and the
+     * spend cap behave identically on both paths.
+     */
+    async initPaidUpload(x402) {
+        if (this.paidUploadId !== undefined) {
+            this.logger.debug('Resuming the already-paid chunked upload', {
+                uploadId: this.paidUploadId,
+            });
+            return this.paidUploadId;
+        }
+        if (this.x402RefundIdentity === undefined) {
+            throw new Error('An x402-paid chunked upload needs a refund identity — it is the Turbo wallet credited if the upload delivers fewer bytes than were paid for.');
+        }
+        const { address, signatureType } = this.x402RefundIdentity;
+        const endpoint = `/chunks/${this.token}/-1/-1?chunkSize=${this.chunkByteCount}` +
+            `&totalBytes=${this.dataItemByteCount}` +
+            `&address=${encodeURIComponent(address)}` +
+            `&signatureType=${signatureType}`;
+        this.logger.debug('Opening an x402-paid chunked upload', {
+            totalBytes: this.dataItemByteCount,
+        });
+        const res = await this.http.get({
+            endpoint: endpoint,
+            headers: chunkingHeader,
+            x402Options: x402,
+        });
+        if (res.chunkSize !== undefined && res.chunkSize !== this.chunkByteCount) {
+            this.logger.warn('Chunk size mismatch! Overriding with server value.', {
+                clientExpected: this.chunkByteCount,
+                serverReturned: res.chunkSize,
+            });
+            this.chunkByteCount = res.chunkSize;
+        }
+        this.paidUploadId = res.id;
+        return res.id;
+    }
     async initUpload() {
+        if (this.x402 !== undefined) {
+            return this.initPaidUpload(this.x402);
+        }
         const res = await this.http.get({
             endpoint: `/chunks/${this.token}/-1/-1?chunkSize=${this.chunkByteCount}`,
             headers: chunkingHeader,

package/lib/esm/common/http.js

@@ -48,7 +48,18 @@ export class TurboHTTPService {
         this.baseURL = url;
         this.retryConfig = retryConfig;
     }
-    async get({ endpoint, signal, allowedStatuses = [200, 202], headers, }) {
+    async get({ endpoint, signal, allowedStatuses = [200, 202], headers, x402Options, }) {
+        if (x402Options !== undefined) {
+            const maxMUSDCAmount = x402Options.maxMUSDCAmount !== undefined
+                ? BigInt(x402Options.maxMUSDCAmount.toString())
+                : undefined;
+            const fetchWithPay = wrapFetchWithPayment(fetch, x402Options.signer, maxMUSDCAmount);
+            return this.tryRequest(async () => fetchWithPay(this.baseURL + endpoint, {
+                method: 'GET',
+                headers: { ...defaultHeaders, ...headers },
+                signal,
+            }), allowedStatuses);
+        }
         return this.withRetry(() => fetch(this.baseURL + endpoint, {
             method: 'GET',
             headers: { ...defaultHeaders, ...headers },

package/lib/esm/common/payment.js

@@ -137,6 +137,24 @@ export class TurboUnauthenticatedPaymentService {
             wincTotal: price.wincTotalWithAntSpawn ?? price.winc,
         };
     }
+    /**
+     * Preview the flat credits margin one of the eight non-purchase actions
+     * (everything except Buy-Name/Extend-Lease/Upgrade-Name/
+     * Increase-Undername-Limit) will debit, without creating it. Those four
+     * purchase actions are priced by `getArNSPriceForName` instead — their
+     * cost is dominated by the ARIO purchase, not this margin, so this route
+     * rejects them.
+     *
+     * No signature required: this mirrors `getArNSPriceForName`'s read-only,
+     * unauthenticated shape rather than `getArNSActionStatus`'s (which happens
+     * to live on the authenticated client today despite needing no signature
+     * either).
+     */
+    async getArNSActionPrice(action) {
+        return this.httpService.get({
+            endpoint: `/arns/actions/${action}/price`,
+        });
+    }
     /**
      * Fail fast (client-side) on malformed ArNS requests so JS callers that bypass
      * the compile-time intent unions get a clear `ProvidedInputError` instead of an
@@ -659,7 +677,7 @@ export class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymen
     /**
      * Point a name (or undername) at an Arweave transaction.
      *
-     * Free — Turbo sponsors the Solana fee. Completes in one call while Turbo is
+     * Costs a small credit margin — never SOL, which Turbo sponsors. Completes in one call while Turbo is
      * a controller of the ANT, and returns `awaiting-signature` once the customer
      * has revoked Turbo, at which point `owner` signs it themselves. Both paths
      * are handled here.
@@ -683,14 +701,15 @@ export class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymen
             String(ttlSeconds),
         ]));
     }
-    /** Remove a record (an undername). Free; same two-shape rules as setArNSRecord. */
+    /** Remove a record (an undername). Costs credits, never SOL. */
     async removeArNSRecord({ antId, owner, undername, onNonce, }) {
         return this.completeArNSAction('remove-record', { antId, ownerAddress: await owner.getAddress(), undername }, owner, { onNonce }, buildArNSCustodyMessage('remove-record', [antId, undername]));
     }
     /**
      * Edit a RECORD's metadata — its display name, logo, description, keywords.
      *
-     * Free, and owner-or-controller on chain, so it behaves exactly like
+     * Costs a small credit margin (never SOL), and is owner-or-controller on
+     * chain, so it behaves exactly like
      * {@link setArNSRecord}: Turbo-alone while it is a controller, owner-signed
      * after a revoke.
      *
@@ -722,7 +741,7 @@ export class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymen
             arNSKeywordsField(recordKeywords),
         ]));
     }
-    /** Clear a record's metadata. Free; same two-shape rules. */
+    /** Clear a record's metadata. Costs credits, never SOL; same two-shape rules. */
     async removeArNSRecordMetadata({ antId, owner, undername, onNonce, }) {
         return this.completeArNSAction('remove-record-metadata', { antId, ownerAddress: await owner.getAddress(), undername }, owner, { onNonce }, buildArNSCustodyMessage('remove-record-metadata', [antId, undername]));
     }
@@ -740,7 +759,8 @@ export class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymen
      * is what makes `setArNSRecord` a single call.
      *
      * Owner-signed: changing an ANT's access control is an owner-only
-     * instruction. Free to the customer — Turbo funds the ACL page growth.
+     * instruction. Costs a small credit margin; Turbo funds the ACL page growth
+     * in SOL.
      */
     async addArNSController({ antId, owner, target, onNonce, }) {
         return this.completeArNSAction('add-controller', {
@@ -753,7 +773,8 @@ export class TurboAuthenticatedPaymentService extends TurboUnauthenticatedPaymen
      * Revoke controller rights — the escape hatch that keeps "Turbo is not a
      * custodian" honest.
      *
-     * Always available, always free, and needs nothing from Turbo but the fee.
+     * Always available, and needs nothing from Turbo but the fee. Costs a small
+     * credit margin rather than SOL.
      * After revoking, `setArNSRecord` keeps working: it simply starts returning
      * `awaiting-signature` so the owner signs their own record writes.
      */

package/lib/esm/common/turbo.js

@@ -60,6 +60,14 @@ export class TurboUnauthenticatedClient {
     getArNSPriceForName(params) {
         return this.paymentService.getArNSPriceForName(params);
     }
+    /**
+     * Previews what one of the eight non-purchase ArNS actions will debit,
+     * without creating it. Use {@link getArNSPriceForName} for the four
+     * ARIO-purchase actions instead.
+     */
+    getArNSActionPrice(action) {
+        return this.paymentService.getArNSActionPrice(action);
+    }
     /**
      * Returns the status of an ArNS purchase by its nonce.
      */
@@ -266,11 +274,11 @@ export class TurboAuthenticatedClient extends TurboUnauthenticatedClient {
     removeArNSRecord(params) {
         return this.paymentService.removeArNSRecord(params);
     }
-    /** Grant controller rights — omit `target` for Turbo itself. Free. */
+    /** Grant controller rights — omit `target` for Turbo itself. Costs credits. */
     addArNSController(params) {
         return this.paymentService.addArNSController(params);
     }
-    /** Revoke controller rights. Always available, always free. */
+    /** Revoke controller rights. Always available; costs credits, never SOL. */
     removeArNSController(params) {
         return this.paymentService.removeArNSController(params);
     }
@@ -282,15 +290,15 @@ export class TurboAuthenticatedClient extends TurboUnauthenticatedClient {
     setArNSRecordMetadata(params) {
         return this.paymentService.setArNSRecordMetadata(params);
     }
-    /** Clear a record's metadata. Free; handles both shapes. */
+    /** Clear a record's metadata. Costs credits, never SOL; handles both shapes. */
     removeArNSRecordMetadata(params) {
         return this.paymentService.removeArNSRecordMetadata(params);
     }
-    /** Hand ONE record over — not the whole ANT. Free; handles both shapes. */
+    /** Hand ONE record over — not the whole ANT. Costs credits, never SOL. */
     transferArNSRecord(params) {
         return this.paymentService.transferArNSRecord(params);
     }
-    /** Hand the ANT to a new owner. Irreversible. Free. */
+    /** Hand the ANT to a new owner. Irreversible. Costs credits, never SOL. */
     transferArNSAnt(params) {
         return this.paymentService.transferArNSAnt(params);
     }

package/lib/esm/common/upload.js

@@ -221,9 +221,6 @@ export class TurboAuthenticatedBaseUploadService extends TurboUnauthenticatedUpl
             !this.x402EnabledTokens.includes(this.token)) {
             throw new Error('x402 uploads are not supported for token: ' + this.token);
         }
-        if (params.chunkingMode === 'force' && fundingMode instanceof X402Funding) {
-            throw new Error("Chunking mode 'force' is not supported when x402 is enabled");
-        }
         this.logger.debug('Starting file upload', { params });
         let retries = 0;
         const maxRetries = this.retryConfig.retries ?? 3;
@@ -259,6 +256,19 @@ export class TurboAuthenticatedBaseUploadService extends TurboUnauthenticatedUpl
             // this result due to the wrapped retry logic of this method.
             try {
                 const { chunkByteCount, maxChunkConcurrency } = params;
+                // Built here rather than after the chunked branch so BOTH paths can
+                // pay with it. Chunked x402 uploads used to be impossible — the
+                // bundler had no way to charge for a multipart upload — so this branch
+                // deliberately fell back to a single request, which capped x402 at the
+                // single-item limit no matter how the client chunked. The bundler now
+                // settles at create, so the fallback is no longer needed.
+                const x402Options = fundingMode instanceof X402Funding
+                    ? {
+                        signer: fundingMode.signer ??
+                            (await makeX402Signer(this.signer.signer)),
+                        maxMUSDCAmount: fundingMode.maxMUSDCAmount,
+                    }
+                    : undefined;
                 const chunkedUploader = new ChunkedUploader({
                     http: this.httpService,
                     token: this.token,
@@ -268,9 +278,17 @@ export class TurboAuthenticatedBaseUploadService extends TurboUnauthenticatedUpl
                     dataItemByteCount: dataItemSizeFactory(),
                     chunkingMode: params.chunkingMode,
                     maxFinalizeMs: params.maxFinalizeMs,
+                    ...(x402Options ? { x402: x402Options } : {}),
+                    ...(x402Options
+                        ? {
+                            x402RefundIdentity: {
+                                address: await this.signer.getNativeAddress(),
+                                signatureType: this.signer.signer.signatureType,
+                            },
+                        }
+                        : {}),
                 });
-                if (chunkedUploader.shouldUseChunkUploader &&
-                    !(fundingMode instanceof X402Funding)) {
+                if (chunkedUploader.shouldUseChunkUploader) {
                     const response = await chunkedUploader.upload({
                         dataItemStreamFactory,
                         dataItemSizeFactory,
@@ -280,13 +298,6 @@ export class TurboAuthenticatedBaseUploadService extends TurboUnauthenticatedUpl
                     });
                     return { ...response, cryptoFundResult };
                 }
-                const x402Options = fundingMode instanceof X402Funding
-                    ? {
-                        signer: fundingMode.signer ??
-                            (await makeX402Signer(this.signer.signer)),
-                        maxMUSDCAmount: fundingMode.maxMUSDCAmount,
-                    }
-                    : undefined;
                 const response = await this.uploadSignedDataItem({
                     dataItemStreamFactory,
                     dataItemSizeFactory,

package/lib/esm/types.js

@@ -101,7 +101,7 @@ export const arNSPurchaseIntents = [
 ];
 // ===== ArNS actions (sponsored — the current bundler surface) =====
 /**
- * The nine sponsored ArNS actions.
+ * The twelve sponsored ArNS actions.
  *
  * Sponsorship covers these twelve and NOTHING else. Everything else in the
  * ArNS, ANT and core programs stays on the direct-signer path and costs the

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

@@ -1,6 +1,6 @@
-import { ArNSFiatPurchaseQuoteParams, ArNSFiatPurchaseQuoteResponse, ArNSNameType, ArNSPriceParams, ArNSPriceResponse, ArNSPurchaseStatusResponse } from '../../types.js';
+import { ArNSAction, ArNSActionPriceResponse, ArNSFiatPurchaseQuoteParams, ArNSFiatPurchaseQuoteResponse, ArNSNameType, ArNSPriceParams, ArNSPriceResponse, ArNSPurchaseStatusResponse } from '../../types.js';
 import { ArNSActionCompleted, ArNSOwnerSigner } from '../../types.js';
-import { ArNSFiatQuoteOptions, ArNSPriceOptions, ArNSPurchaseOptions, ArNSPurchaseStatusOptions, RemoveArNSRecordOptions, SetArNSRecordOptions, TransferArNSAntOptions } from '../types.js';
+import { AddArNSControllerOptions, ArNSActionPriceOptions, ArNSFiatQuoteOptions, ArNSPriceOptions, ArNSPurchaseOptions, ArNSPurchaseStatusOptions, RemoveArNSControllerOptions, RemoveArNSRecordMetadataOptions, RemoveArNSRecordOptions, SetArNSRecordMetadataOptions, SetArNSRecordOptions, TransferArNSAntOptions, TransferArNSRecordOptions } from '../types.js';
 export type ArNSPriceClient = {
     getArNSPriceForName(params: ArNSPriceParams): Promise<ArNSPriceResponse>;
 };
@@ -50,12 +50,49 @@ export type ArNSCustodyClient = {
         owner: ArNSOwnerSigner;
         undername: string;
     }): Promise<ArNSActionCompleted>;
+    addArNSController(params: {
+        antId: string;
+        owner: ArNSOwnerSigner;
+        target?: string;
+    }): Promise<ArNSActionCompleted>;
+    removeArNSController(params: {
+        antId: string;
+        owner: ArNSOwnerSigner;
+        target?: string;
+    }): Promise<ArNSActionCompleted>;
+    setArNSRecordMetadata(params: {
+        antId: string;
+        owner: ArNSOwnerSigner;
+        undername?: string;
+        displayName?: string | null;
+        recordLogo?: string | null;
+        recordDescription?: string | null;
+        recordKeywords?: string[] | null;
+    }): Promise<ArNSActionCompleted>;
+    removeArNSRecordMetadata(params: {
+        antId: string;
+        owner: ArNSOwnerSigner;
+        undername: string;
+    }): Promise<ArNSActionCompleted>;
+    transferArNSRecord(params: {
+        antId: string;
+        owner: ArNSOwnerSigner;
+        undername: string;
+        target: string;
+    }): Promise<ArNSActionCompleted>;
+};
+export type ArNSActionPriceClient = {
+    getArNSActionPrice(action: ArNSAction): Promise<ArNSActionPriceResponse>;
 };
 export declare function requiredNameFromOptions(options: {
     name?: string;
 }): string;
 export declare function positiveIntFromOption(value: string | undefined, flag: string): number;
 export declare function typeFromOptions(value: string | undefined): ArNSNameType;
+/** Parses `--action` for `arns-action-price`, rejecting the four purchase actions. */
+export declare function actionFromOptions(options: {
+    action?: string;
+}): ArNSAction;
 export declare function paidByFromArNSOptions(paidBy: string[] | undefined): string[] | undefined;
 /**
  * Infer the ArNS pricing intent from the provided flags:
@@ -83,4 +120,14 @@ export declare function arnsPurchaseStatus(options: ArNSPurchaseStatusOptions, t
 export declare function transferArNSAnt(options: TransferArNSAntOptions, turbo?: ArNSCustodyClient): Promise<void>;
 export declare function setArNSRecord(options: SetArNSRecordOptions, turbo?: ArNSCustodyClient): Promise<void>;
 export declare function removeArNSRecord(options: RemoveArNSRecordOptions, turbo?: ArNSCustodyClient): Promise<void>;
+export declare function addArNSController(options: AddArNSControllerOptions, turbo?: ArNSCustodyClient): Promise<void>;
+export declare function removeArNSController(options: RemoveArNSControllerOptions, turbo?: ArNSCustodyClient): Promise<void>;
+export declare function transferArNSRecord(options: TransferArNSRecordOptions, turbo?: ArNSCustodyClient): Promise<void>;
+export declare function setArNSRecordMetadata(options: SetArNSRecordMetadataOptions, turbo?: ArNSCustodyClient): Promise<void>;
+export declare function removeArNSRecordMetadata(options: RemoveArNSRecordMetadataOptions, turbo?: ArNSCustodyClient): Promise<void>;
+/**
+ * Preview what one of the eight non-purchase actions will debit, without
+ * creating it.
+ */
+export declare function arnsActionPrice(options: ArNSActionPriceOptions, turbo?: ArNSActionPriceClient): Promise<void>;
 //# sourceMappingURL=arns.d.ts.map

package/lib/types/cli/commands/arns.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"arns.d.ts","sourceRoot":"","sources":["../../../../src/cli/commands/arns.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,0BAA0B,EAE3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAMtE,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,uBAAuB,EACvB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAyBrB,MAAM,MAAM,eAAe,GAAG;IAC5B,mBAAmB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC1E,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qBAAqB,CAAC,CAAC,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,CAAC,MAAM,EAAE;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,eAAe,CAAC;QACvB,IAAI,CAAC,EAAE,YAAY,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,eAAe,CAAC,MAAM,EAAE;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,0BAA0B,CAAC,MAAM,EAAE;QACjC,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,eAAe,CAAC,MAAM,EAAE;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,eAAe,CAAC,MAAM,EAAE;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,aAAa,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,gBAAgB,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAK1E;AAED,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,GACX,MAAM,CASR;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,CAKvE;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,GAC3B,MAAM,EAAE,GAAG,SAAS,CAEtB;AASD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,gBAAgB,GACxB,eAAe,CAwCjB;AAyCD,wBAAsB,SAAS,CAC7B,OAAO,EAAE,gBAAgB,EACzB,KAAK,CAAC,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC,CAmBf;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,wBAAwB,CACtB,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,6BAA6B,CAAC,CAAC;CAC3C,CAAC;AAEF,wBAAsB,aAAa,CACjC,OAAO,EAAE,oBAAoB,EAC7B,KAAK,CAAC,EAAE,mBAAmB,GAC1B,OAAO,CAAC,IAAI,CAAC,CA4Df;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAsBf;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAWf;AAED,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAcf;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAUf;AAED,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,yBAAyB,EAClC,KAAK,CAAC,EAAE,gBAAgB,GACvB,OAAO,CAAC,IAAI,CAAC,CAgBf;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,sBAAsB,EAC/B,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAkBf;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,oBAAoB,EAC7B,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAqBf;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,uBAAuB,EAChC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAkBf"}
+{"version":3,"file":"arns.d.ts","sourceRoot":"","sources":["../../../../src/cli/commands/arns.ts"],"names":[],"mappings":"AAmBA,OAAO,EACL,UAAU,EACV,uBAAuB,EACvB,2BAA2B,EAC3B,6BAA6B,EAC7B,YAAY,EACZ,eAAe,EACf,iBAAiB,EACjB,0BAA0B,EAG3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAMtE,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,+BAA+B,EAC/B,uBAAuB,EACvB,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,aAAa,CAAC;AAyBrB,MAAM,MAAM,eAAe,GAAG;IAC5B,mBAAmB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC1E,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qBAAqB,CAAC,CAAC,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,CAAC,MAAM,EAAE;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,eAAe,CAAC;QACvB,IAAI,CAAC,EAAE,YAAY,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,eAAe,CAAC,MAAM,EAAE;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,0BAA0B,CAAC,MAAM,EAAE;QACjC,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,eAAe,CAAC,MAAM,EAAE;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,eAAe,CAAC,MAAM,EAAE;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,aAAa,CAAC,MAAM,EAAE;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,gBAAgB,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,iBAAiB,CAAC,MAAM,EAAE;QACxB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,oBAAoB,CAAC,MAAM,EAAE;QAC3B,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,qBAAqB,CAAC,MAAM,EAAE;QAC5B,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;KAClC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,wBAAwB,CAAC,MAAM,EAAE;QAC/B,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjC,kBAAkB,CAAC,MAAM,EAAE;QACzB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,eAAe,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC,CAAC;AAUF,MAAM,MAAM,qBAAqB,GAAG;IAClC,kBAAkB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;CAC1E,CAAC;AAEF,wBAAgB,uBAAuB,CAAC,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAK1E;AAED,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,GACX,MAAM,CASR;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,YAAY,CAKvE;AAED,sFAAsF;AACtF,wBAAgB,iBAAiB,CAAC,OAAO,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,UAAU,CAiB1E;AAUD,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,GAC3B,MAAM,EAAE,GAAG,SAAS,CAEtB;AASD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,gBAAgB,GACxB,eAAe,CAwCjB;AAyCD,wBAAsB,SAAS,CAC7B,OAAO,EAAE,gBAAgB,EACzB,KAAK,CAAC,EAAE,eAAe,GACtB,OAAO,CAAC,IAAI,CAAC,CAmBf;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,wBAAwB,CACtB,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,6BAA6B,CAAC,CAAC;CAC3C,CAAC;AAEF,wBAAsB,aAAa,CACjC,OAAO,EAAE,oBAAoB,EAC7B,KAAK,CAAC,EAAE,mBAAmB,GAC1B,OAAO,CAAC,IAAI,CAAC,CA4Df;AAED,wBAAsB,WAAW,CAC/B,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAsBf;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAWf;AAED,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAcf;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,mBAAmB,EAC5B,KAAK,CAAC,EAAE,kBAAkB,GACzB,OAAO,CAAC,IAAI,CAAC,CAUf;AAED,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,yBAAyB,EAClC,KAAK,CAAC,EAAE,gBAAgB,GACvB,OAAO,CAAC,IAAI,CAAC,CAgBf;AAED,wBAAsB,eAAe,CACnC,OAAO,EAAE,sBAAsB,EAC/B,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAkBf;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,oBAAoB,EAC7B,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAqBf;AAED,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,uBAAuB,EAChC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAkBf;AAED,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,wBAAwB,EACjC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAef;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,2BAA2B,EACpC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAef;AAED,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,yBAAyB,EAClC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAwBf;AAED,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,4BAA4B,EACrC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAmCf;AAED,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,+BAA+B,EACxC,KAAK,CAAC,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC,CAsBf;AAED;;;GAGG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,sBAAsB,EAC/B,KAAK,CAAC,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAaf"}