@ardrive/turbo-sdk 1.42.0-alpha.9 → 1.43.0-alpha.1

package/lib/cjs/cli/cli.js

@@ -147,6 +147,37 @@ const utils_js_1 = require("./utils.js");
     .description('Remove a resolution record (undername) from a Turbo-custodied ANT'), options_js_1.removeArNSRecordOptions).action(async (_commandOptions, command) => {
     await (0, utils_js_1.runCommand)(command, arns_js_1.removeArNSRecord);
 });
+(0, utils_js_1.applyOptions)(commander_1.program
+    .command('add-arns-controller')
+    .description('Grant controller rights on a Turbo-custodied ANT'), options_js_1.addArNSControllerOptions).action(async (_commandOptions, command) => {
+    await (0, utils_js_1.runCommand)(command, arns_js_1.addArNSController);
+});
+(0, utils_js_1.applyOptions)(commander_1.program
+    .command('remove-arns-controller')
+    .description('Revoke controller rights on a Turbo-custodied ANT'), options_js_1.removeArNSControllerOptions).action(async (_commandOptions, command) => {
+    await (0, utils_js_1.runCommand)(command, arns_js_1.removeArNSController);
+});
+(0, utils_js_1.applyOptions)(commander_1.program
+    .command('transfer-arns-record')
+    .description('Transfer one record (undername) on a Turbo-custodied ANT to another address'), options_js_1.transferArNSRecordOptions).action(async (_commandOptions, command) => {
+    await (0, utils_js_1.runCommand)(command, arns_js_1.transferArNSRecord);
+});
+(0, utils_js_1.applyOptions)(commander_1.program
+    .command('set-arns-record-metadata')
+    .description("Set a record's display name, logo, description, or keywords on a Turbo-custodied ANT"), options_js_1.setArNSRecordMetadataOptions).action(async (_commandOptions, command) => {
+    await (0, utils_js_1.runCommand)(command, arns_js_1.setArNSRecordMetadata);
+});
+(0, utils_js_1.applyOptions)(commander_1.program
+    .command('remove-arns-record-metadata')
+    .description("Clear a record's metadata on a Turbo-custodied ANT"), options_js_1.removeArNSRecordMetadataOptions).action(async (_commandOptions, command) => {
+    await (0, utils_js_1.runCommand)(command, arns_js_1.removeArNSRecordMetadata);
+});
+(0, utils_js_1.applyOptions)(commander_1.program
+    .command('arns-action-price')
+    .description('Preview the Turbo Credit price of a non-purchase ArNS action (set-record, remove-record, ' +
+    'set-record-metadata, remove-record-metadata, transfer-record, add-controller, remove-controller, transfer)'), options_js_1.arnsActionPriceOptions).action(async (_commandOptions, command) => {
+    await (0, utils_js_1.runCommand)(command, arns_js_1.arnsActionPrice);
+});
 (0, utils_js_1.applyOptions)(commander_1.program
     .command('inspect-data-items')
     .description('Lists all given or received Turbo credit share approvals for specified address or connected wallet'), [options_js_1.optionMap.folderPath]).action(async (_commandOptions, command) => {

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.requiredNameFromOptions = requiredNameFromOptions;
 exports.positiveIntFromOption = positiveIntFromOption;
 exports.typeFromOptions = typeFromOptions;
+exports.actionFromOptions = actionFromOptions;
 exports.paidByFromArNSOptions = paidByFromArNSOptions;
 exports.arnsPriceParamsFromOptions = arnsPriceParamsFromOptions;
 exports.arnsPrice = arnsPrice;
@@ -15,6 +16,12 @@ exports.arnsPurchaseStatus = arnsPurchaseStatus;
 exports.transferArNSAnt = transferArNSAnt;
 exports.setArNSRecord = setArNSRecord;
 exports.removeArNSRecord = removeArNSRecord;
+exports.addArNSController = addArNSController;
+exports.removeArNSController = removeArNSController;
+exports.transferArNSRecord = transferArNSRecord;
+exports.setArNSRecordMetadata = setArNSRecordMetadata;
+exports.removeArNSRecordMetadata = removeArNSRecordMetadata;
+exports.arnsActionPrice = arnsActionPrice;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -33,6 +40,7 @@ exports.removeArNSRecord = removeArNSRecord;
 const bignumber_js_1 = require("bignumber.js");
 const arnsActions_js_1 = require("../../common/arnsActions.js");
 const factory_js_1 = require("../../node/factory.js");
+const types_js_1 = require("../../types.js");
 const errors_js_1 = require("../../utils/errors.js");
 const constants_js_1 = require("../constants.js");
 const utils_js_1 = require("../utils.js");
@@ -51,6 +59,13 @@ function ownerFromOptions(options) {
     }
     return (0, arnsActions_js_1.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',
+]);
 function requiredNameFromOptions(options) {
     if (options.name === undefined || options.name.length === 0) {
         throw new Error('Must provide an ArNS --name');
@@ -73,6 +88,25 @@ function typeFromOptions(value) {
     }
     return value;
 }
+/** Parses `--action` for `arns-action-price`, rejecting the four purchase actions. */
+function actionFromOptions(options) {
+    const { action } = options;
+    if (action === undefined || action.length === 0) {
+        throw new Error(`Must provide --action. One of: ${types_js_1.arNSActions.join(', ')}`);
+    }
+    if (!types_js_1.arNSActions.includes(action)) {
+        throw new Error(`Invalid --action '${action}'. One of: ${types_js_1.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;
+}
 function paidByFromArNSOptions(paidBy) {
     return paidBy !== undefined && paidBy.length > 0 ? paidBy : undefined;
 }
@@ -156,12 +190,17 @@ function logPurchaseResult(action, result) {
 async function arnsPrice(options, turbo) {
     const params = arnsPriceParamsFromOptions(options);
     const client = turbo ?? factory_js_1.TurboFactory.unauthenticated((0, utils_js_1.configFromOptions)(options));
-    const { winc, mARIO } = await client.getArNSPriceForName(params);
+    const { winc, wincTotal, antSpawnSurchargeWinc, mARIO } = await client.getArNSPriceForName(params);
+    // `wincTotal` is the figure to pay. `winc` is the name only and excludes the
+    // ANT spawn surcharge, which for a Buy-Name can exceed the name's own price,
+    // so printing it as the price under-quotes what `buy-arns-name` then debits.
     console.log(JSON.stringify({
         name: params.name,
         intent: params.intent,
-        winc,
-        credits: creditsFromWinc(winc),
+        wincTotal,
+        credits: creditsFromWinc(wincTotal),
+        nameOnlyWinc: winc,
+        antSpawnSurchargeWinc,
         mARIO,
     }, null, 2));
 }
@@ -315,3 +354,87 @@ async function removeArNSRecord(options, turbo) {
     });
     console.log(JSON.stringify({ message: 'ArNS record removed!', ...result }, null, 2));
 }
+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 (0, utils_js_1.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));
+}
+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 (0, utils_js_1.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));
+}
+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 (0, utils_js_1.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));
+}
+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 (0, utils_js_1.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));
+}
+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 (0, utils_js_1.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.
+ */
+async function arnsActionPrice(options, turbo) {
+    const action = actionFromOptions(options);
+    const client = turbo ?? factory_js_1.TurboFactory.unauthenticated((0, utils_js_1.configFromOptions)(options));
+    const { wincQty } = await client.getArNSActionPrice(action);
+    console.log(JSON.stringify({ action, wincQty, credits: creditsFromWinc(wincQty) }, null, 2));
+}

package/lib/cjs/cli/options.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeArNSRecordOptions = exports.setArNSRecordOptions = exports.transferArNSAntOptions = exports.arnsPurchaseStatusOptions = exports.upgradeArNSNameOptions = exports.increaseArNSUndernamesOptions = exports.extendArNSLeaseOptions = exports.buyArNSNameOptions = exports.arnsFiatQuoteOptions = exports.arnsPriceOptions = exports.listSharesOptions = exports.revokeCreditsOptions = exports.shareCreditsOptions = exports.uploadFileOptions = exports.uploadFolderOptions = exports.uploadOptions = exports.globalOptions = exports.walletOptions = exports.optionMap = void 0;
+exports.arnsActionPriceOptions = exports.removeArNSRecordMetadataOptions = exports.setArNSRecordMetadataOptions = exports.transferArNSRecordOptions = exports.removeArNSControllerOptions = exports.addArNSControllerOptions = exports.removeArNSRecordOptions = exports.setArNSRecordOptions = exports.transferArNSAntOptions = exports.arnsPurchaseStatusOptions = exports.upgradeArNSNameOptions = exports.increaseArNSUndernamesOptions = exports.extendArNSLeaseOptions = exports.buyArNSNameOptions = exports.arnsFiatQuoteOptions = exports.arnsPriceOptions = exports.listSharesOptions = exports.revokeCreditsOptions = exports.shareCreditsOptions = exports.uploadFileOptions = exports.uploadFolderOptions = exports.uploadOptions = exports.globalOptions = exports.walletOptions = exports.optionMap = void 0;
 exports.optionMap = {
     token: {
         alias: '-t, --token <type>',
@@ -234,6 +234,48 @@ exports.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>',
@@ -365,3 +407,38 @@ exports.removeArNSRecordOptions = [
     exports.optionMap.arnsAntId,
     exports.optionMap.arnsUndername,
 ];
+exports.addArNSControllerOptions = [
+    ...exports.walletOptions,
+    exports.optionMap.arnsOwnerKey,
+    exports.optionMap.arnsAntId,
+    exports.optionMap.arnsTarget,
+];
+exports.removeArNSControllerOptions = exports.addArNSControllerOptions;
+exports.transferArNSRecordOptions = [
+    ...exports.walletOptions,
+    exports.optionMap.arnsOwnerKey,
+    exports.optionMap.arnsAntId,
+    exports.optionMap.arnsUndername,
+    exports.optionMap.arnsTarget,
+];
+exports.setArNSRecordMetadataOptions = [
+    ...exports.walletOptions,
+    exports.optionMap.arnsOwnerKey,
+    exports.optionMap.arnsAntId,
+    exports.optionMap.arnsUndername,
+    exports.optionMap.arnsDisplayName,
+    exports.optionMap.arnsClearDisplayName,
+    exports.optionMap.arnsRecordLogo,
+    exports.optionMap.arnsClearRecordLogo,
+    exports.optionMap.arnsRecordDescription,
+    exports.optionMap.arnsClearRecordDescription,
+    exports.optionMap.arnsRecordKeywords,
+    exports.optionMap.arnsClearRecordKeywords,
+];
+exports.removeArNSRecordMetadataOptions = [
+    ...exports.walletOptions,
+    exports.optionMap.arnsOwnerKey,
+    exports.optionMap.arnsAntId,
+    exports.optionMap.arnsUndername,
+];
+exports.arnsActionPriceOptions = [exports.optionMap.arnsAction];

package/lib/cjs/common/arnsActions.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildArNSCustodyMessage = buildArNSCustodyMessage;
+exports.arNSMetadataField = arNSMetadataField;
+exports.arNSKeywordsField = arNSKeywordsField;
 exports.arNSOwnerProofHeaders = arNSOwnerProofHeaders;
 exports.solanaOwnerSigner = solanaOwnerSigner;
 exports.emptySignatureSlots = emptySignatureSlots;
@@ -39,6 +41,27 @@ const base64_js_1 = require("../utils/base64.js");
 function buildArNSCustodyMessage(action, fields) {
     return ['arns', action, ...fields].join('\n');
 }
+/**
+ * A metadata field's ABSENT/EMPTY distinction, as the bundler binds it.
+ *
+ * `null` (clear the field) must not sign the same message as `''` (set it to
+ * empty), or a signature authorizing one would authorize the other. NUL can
+ * never appear in a value that reached here — the route rejects control
+ * characters — so it is a safe sentinel.
+ */
+function arNSMetadataField(value) {
+    return value === null || value === undefined ? '\u0000' : value;
+}
+/**
+ * Keywords joined on a separator the route rejects INSIDE a keyword, so
+ * `['a,b']` and `['a','b']` cannot be re-partitioned into one another with the
+ * same signature.
+ */
+function arNSKeywordsField(keywords) {
+    return keywords === null || keywords === undefined
+        ? '\u0000'
+        : keywords.join('\u0001');
+}
 /** Solana's signature-type discriminator in Turbo's signed-request scheme. */
 const SOLANA_SIGNATURE_TYPE = 4;
 /**

package/lib/cjs/common/chunked.js

@@ -41,7 +41,7 @@ const chunkingHeader = { 'x-chunking-version': '2' };
  * uploading them in parallel, and emitting progress/error events.
  */
 class ChunkedUploader {
-    constructor({ http, token, maxChunkConcurrency = exports.defaultMaxChunkConcurrency, maxFinalizeMs, chunkByteCount = exports.defaultChunkByteCount, logger = logger_js_1.Logger.default, chunkingMode = 'auto', dataItemByteCount, }) {
+    constructor({ http, token, maxChunkConcurrency = exports.defaultMaxChunkConcurrency, maxFinalizeMs, chunkByteCount = exports.defaultChunkByteCount, logger = logger_js_1.Logger.default, chunkingMode = 'auto', dataItemByteCount, x402, x402RefundIdentity, }) {
         this.assertChunkParams({
             chunkByteCount,
             chunkingMode,
@@ -60,6 +60,9 @@ class ChunkedUploader {
             dataItemByteCount,
         });
         this.maxBacklogQueue = this.maxChunkConcurrency * backlogQueueFactor;
+        this.x402 = x402;
+        this.x402RefundIdentity = x402RefundIdentity;
+        this.dataItemByteCount = dataItemByteCount;
     }
     shouldChunkUpload({ chunkByteCount, chunkingMode, dataItemByteCount, }) {
         if (chunkingMode === 'disabled') {
@@ -98,7 +101,54 @@ 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,