@ar.io/sdk 3.12.1 → 3.13.0-alpha.1

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

@@ -12,6 +12,7 @@ async function buyRecordCLICommand(o) {
     const type = (0, utils_js_1.recordTypeFromOptions)(o);
     const years = (0, utils_js_1.positiveIntegerFromOptions)(o, 'years');
     const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const referrer = (0, utils_js_1.referrerFromOptions)(o);
     const processId = o.processId;
     if (processId === undefined) {
         // TODO: Spawn ANT process, register it to ANT registry, get process ID
@@ -45,12 +46,14 @@ async function buyRecordCLICommand(o) {
         years,
         fundFrom: (0, utils_js_1.fundFromFromOptions)(o),
         paidBy: (0, utils_js_1.stringArrayFromOptions)(o, 'paidBy'),
+        referrer,
     }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 async function upgradeRecordCLICommand(o) {
     const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
     const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
     const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const referrer = (0, utils_js_1.referrerFromOptions)(o);
     if (!o.skipConfirmation) {
         const existingRecord = await ario.getArNSRecord({
             name,
@@ -77,12 +80,14 @@ async function upgradeRecordCLICommand(o) {
         name,
         fundFrom,
         paidBy: (0, utils_js_1.stringArrayFromOptions)(o, 'paidBy'),
+        referrer,
     });
 }
 async function extendLeaseCLICommand(o) {
     const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
     const years = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'years');
     const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const referrer = (0, utils_js_1.referrerFromOptions)(o);
     const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
     if (!o.skipConfirmation) {
         const existingRecord = await ario.getArNSRecord({
@@ -111,12 +116,14 @@ async function extendLeaseCLICommand(o) {
         name,
         years,
         paidBy: (0, utils_js_1.stringArrayFromOptions)(o, 'paidBy'),
+        referrer,
     }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 async function increaseUndernameLimitCLICommand(o) {
     const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
     const increaseCount = (0, utils_js_1.requiredPositiveIntegerFromOptions)(o, 'increaseCount');
     const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const referrer = (0, utils_js_1.referrerFromOptions)(o);
     const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
     if (!o.skipConfirmation) {
         const existingRecord = await ario.getArNSRecord({
@@ -142,11 +149,13 @@ async function increaseUndernameLimitCLICommand(o) {
         name,
         increaseCount,
         paidBy: (0, utils_js_1.stringArrayFromOptions)(o, 'paidBy'),
+        referrer,
     }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 async function requestPrimaryNameCLICommand(o) {
     const { ario, signerAddress } = (0, utils_js_1.writeARIOFromOptions)(o);
     const fundFrom = (0, utils_js_1.fundFromFromOptions)(o);
+    const referrer = (0, utils_js_1.referrerFromOptions)(o);
     const name = (0, utils_js_1.requiredStringFromOptions)(o, 'name');
     if (!o.skipConfirmation) {
         // TODO: Assert name requested is not already owned?
@@ -167,5 +176,6 @@ async function requestPrimaryNameCLICommand(o) {
         name,
         fundFrom,
         paidBy: (0, utils_js_1.stringArrayFromOptions)(o, 'paidBy'),
+        referrer,
     }, (0, utils_js_1.customTagsFromOptions)(o));
 }

package/lib/cjs/cli/options.js

@@ -286,6 +286,10 @@ exports.optionMap = {
         description: 'Addresses to pay for the interaction',
         type: 'array',
     },
+    referrer: {
+        alias: '--referrer <referrer>',
+        description: 'The referrer for ArNS purchase tracking',
+    },
 };
 exports.walletOptions = [
     exports.optionMap.walletFile,
@@ -309,6 +313,7 @@ exports.arnsPurchaseOptions = [
     exports.optionMap.fundFrom,
     exports.optionMap.paidBy,
     exports.optionMap.paymentUrl,
+    exports.optionMap.referrer,
 ];
 exports.epochOptions = [exports.optionMap.epochIndex, exports.optionMap.timestamp];
 exports.addressAndVaultIdOptions = [exports.optionMap.address, exports.optionMap.vaultId];

package/lib/cjs/cli/utils.js

@@ -46,6 +46,7 @@ exports.requiredPositiveIntegerFromOptions = requiredPositiveIntegerFromOptions;
 exports.getANTStateFromOptions = getANTStateFromOptions;
 exports.getTokenCostParamsFromOptions = getTokenCostParamsFromOptions;
 exports.fundFromFromOptions = fundFromFromOptions;
+exports.referrerFromOptions = referrerFromOptions;
 exports.assertLockLengthInRange = assertLockLengthInRange;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
@@ -507,6 +508,9 @@ function fundFromFromOptions(o) {
     }
     return o.fundFrom ?? 'balance';
 }
+function referrerFromOptions(o) {
+    return o.referrer;
+}
 function assertLockLengthInRange(lockLengthMs, assertMin = true) {
     const minLockLengthMs = 1209600000; // 14 days
     const maxLockLengthMs = 378432000000; // ~12 years

package/lib/cjs/common/io.js

@@ -986,6 +986,7 @@ class ARIOWriteable extends ARIOReadable {
             { name: 'Process-Id', value: params.processId },
             { name: 'Purchase-Type', value: params.type || 'lease' },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,
@@ -1016,6 +1017,7 @@ class ARIOWriteable extends ARIOReadable {
             { name: 'Action', value: 'Upgrade-Name' },
             { name: 'Name', value: params.name },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,
@@ -1049,6 +1051,7 @@ class ARIOWriteable extends ARIOReadable {
             { name: 'Name', value: params.name },
             { name: 'Years', value: params.years.toString() },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,
@@ -1073,6 +1076,7 @@ class ARIOWriteable extends ARIOReadable {
             { name: 'Name', value: params.name },
             { name: 'Quantity', value: params.increaseCount.toString() },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,

package/lib/cjs/common/turbo.js

@@ -155,7 +155,7 @@ class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProviderUnau
         }
         this.signer = signer;
     }
-    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, paidBy = [], }) {
+    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, paidBy = [], referrer, }) {
         // Signer check is implicitly handled by requiring it in the constructor
         const url = (0, url_js_1.urlWithSearchParams)({
             baseUrl: `${this.paymentUrl}/v1/arns/purchase/${intent}/${name}`,
@@ -165,6 +165,7 @@ class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProviderUnau
                 type,
                 years,
                 paidBy,
+                referrer,
             },
         });
         const headers = await signedRequestHeadersFromSigner({

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.12.1';
+exports.version = '3.13.0-alpha.1';

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

@@ -1,10 +1,11 @@
-import { assertConfirmationPrompt, assertEnoughBalanceForArNSPurchase, customTagsFromOptions, fundFromFromOptions, positiveIntegerFromOptions, recordTypeFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, stringArrayFromOptions, writeARIOFromOptions, } from '../utils.js';
+import { assertConfirmationPrompt, assertEnoughBalanceForArNSPurchase, customTagsFromOptions, fundFromFromOptions, positiveIntegerFromOptions, recordTypeFromOptions, referrerFromOptions, requiredPositiveIntegerFromOptions, requiredStringFromOptions, stringArrayFromOptions, writeARIOFromOptions, } from '../utils.js';
 export async function buyRecordCLICommand(o) {
     const { ario, signerAddress } = writeARIOFromOptions(o);
     const name = requiredStringFromOptions(o, 'name');
     const type = recordTypeFromOptions(o);
     const years = positiveIntegerFromOptions(o, 'years');
     const fundFrom = fundFromFromOptions(o);
+    const referrer = referrerFromOptions(o);
     const processId = o.processId;
     if (processId === undefined) {
         // TODO: Spawn ANT process, register it to ANT registry, get process ID
@@ -38,12 +39,14 @@ export async function buyRecordCLICommand(o) {
         years,
         fundFrom: fundFromFromOptions(o),
         paidBy: stringArrayFromOptions(o, 'paidBy'),
+        referrer,
     }, customTagsFromOptions(o));
 }
 export async function upgradeRecordCLICommand(o) {
     const name = requiredStringFromOptions(o, 'name');
     const { ario, signerAddress } = writeARIOFromOptions(o);
     const fundFrom = fundFromFromOptions(o);
+    const referrer = referrerFromOptions(o);
     if (!o.skipConfirmation) {
         const existingRecord = await ario.getArNSRecord({
             name,
@@ -70,12 +73,14 @@ export async function upgradeRecordCLICommand(o) {
         name,
         fundFrom,
         paidBy: stringArrayFromOptions(o, 'paidBy'),
+        referrer,
     });
 }
 export async function extendLeaseCLICommand(o) {
     const name = requiredStringFromOptions(o, 'name');
     const years = requiredPositiveIntegerFromOptions(o, 'years');
     const fundFrom = fundFromFromOptions(o);
+    const referrer = referrerFromOptions(o);
     const { ario, signerAddress } = writeARIOFromOptions(o);
     if (!o.skipConfirmation) {
         const existingRecord = await ario.getArNSRecord({
@@ -104,12 +109,14 @@ export async function extendLeaseCLICommand(o) {
         name,
         years,
         paidBy: stringArrayFromOptions(o, 'paidBy'),
+        referrer,
     }, customTagsFromOptions(o));
 }
 export async function increaseUndernameLimitCLICommand(o) {
     const name = requiredStringFromOptions(o, 'name');
     const increaseCount = requiredPositiveIntegerFromOptions(o, 'increaseCount');
     const fundFrom = fundFromFromOptions(o);
+    const referrer = referrerFromOptions(o);
     const { ario, signerAddress } = writeARIOFromOptions(o);
     if (!o.skipConfirmation) {
         const existingRecord = await ario.getArNSRecord({
@@ -135,11 +142,13 @@ export async function increaseUndernameLimitCLICommand(o) {
         name,
         increaseCount,
         paidBy: stringArrayFromOptions(o, 'paidBy'),
+        referrer,
     }, customTagsFromOptions(o));
 }
 export async function requestPrimaryNameCLICommand(o) {
     const { ario, signerAddress } = writeARIOFromOptions(o);
     const fundFrom = fundFromFromOptions(o);
+    const referrer = referrerFromOptions(o);
     const name = requiredStringFromOptions(o, 'name');
     if (!o.skipConfirmation) {
         // TODO: Assert name requested is not already owned?
@@ -160,5 +169,6 @@ export async function requestPrimaryNameCLICommand(o) {
         name,
         fundFrom,
         paidBy: stringArrayFromOptions(o, 'paidBy'),
+        referrer,
     }, customTagsFromOptions(o));
 }

package/lib/esm/cli/options.js

@@ -283,6 +283,10 @@ export const optionMap = {
         description: 'Addresses to pay for the interaction',
         type: 'array',
     },
+    referrer: {
+        alias: '--referrer <referrer>',
+        description: 'The referrer for ArNS purchase tracking',
+    },
 };
 export const walletOptions = [
     optionMap.walletFile,
@@ -306,6 +310,7 @@ export const arnsPurchaseOptions = [
     optionMap.fundFrom,
     optionMap.paidBy,
     optionMap.paymentUrl,
+    optionMap.referrer,
 ];
 export const epochOptions = [optionMap.epochIndex, optionMap.timestamp];
 export const addressAndVaultIdOptions = [optionMap.address, optionMap.vaultId];

package/lib/esm/cli/utils.js

@@ -458,6 +458,9 @@ export function fundFromFromOptions(o) {
     }
     return o.fundFrom ?? 'balance';
 }
+export function referrerFromOptions(o) {
+    return o.referrer;
+}
 export function assertLockLengthInRange(lockLengthMs, assertMin = true) {
     const minLockLengthMs = 1209600000; // 14 days
     const maxLockLengthMs = 378432000000; // ~12 years

package/lib/esm/common/io.js

@@ -981,6 +981,7 @@ export class ARIOWriteable extends ARIOReadable {
             { name: 'Process-Id', value: params.processId },
             { name: 'Purchase-Type', value: params.type || 'lease' },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,
@@ -1011,6 +1012,7 @@ export class ARIOWriteable extends ARIOReadable {
             { name: 'Action', value: 'Upgrade-Name' },
             { name: 'Name', value: params.name },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,
@@ -1044,6 +1046,7 @@ export class ARIOWriteable extends ARIOReadable {
             { name: 'Name', value: params.name },
             { name: 'Years', value: params.years.toString() },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,
@@ -1068,6 +1071,7 @@ export class ARIOWriteable extends ARIOReadable {
             { name: 'Name', value: params.name },
             { name: 'Quantity', value: params.increaseCount.toString() },
             { name: 'Fund-From', value: params.fundFrom },
+            { name: 'Referrer', value: params.referrer },
         ];
         return this.process.send({
             signer: this.signer,

package/lib/esm/common/turbo.js

@@ -148,7 +148,7 @@ export class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProvi
         }
         this.signer = signer;
     }
-    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, paidBy = [], }) {
+    async initiateArNSPurchase({ intent, name, quantity, type, processId, years, paidBy = [], referrer, }) {
         // Signer check is implicitly handled by requiring it in the constructor
         const url = urlWithSearchParams({
             baseUrl: `${this.paymentUrl}/v1/arns/purchase/${intent}/${name}`,
@@ -158,6 +158,7 @@ export class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProvi
                 type,
                 years,
                 paidBy,
+                referrer,
             },
         });
         const headers = await signedRequestHeadersFromSigner({

package/lib/esm/version.js

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

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

@@ -279,6 +279,10 @@ export declare const optionMap: {
         description: string;
         type: string;
     };
+    referrer: {
+        alias: string;
+        description: string;
+    };
 };
 export declare const walletOptions: {
     alias: string;

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

@@ -91,4 +91,7 @@ export declare function getTokenCostParamsFromOptions(o: GetTokenCostCLIOptions)
 export declare function fundFromFromOptions<O extends {
     fundFrom?: string;
 }>(o: O): FundFrom;
+export declare function referrerFromOptions<O extends {
+    referrer?: string;
+}>(o: O): string | undefined;
 export declare function assertLockLengthInRange(lockLengthMs: number, assertMin?: boolean): void;

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

@@ -32,6 +32,7 @@ export interface ArNSPaymentProvider {
 export interface TurboInitiateArNSPurchaseParams extends AoTokenCostParams {
     processId?: TransactionId;
     paidBy?: string | string[];
+    referrer?: string;
 }
 export interface ArNSAuthenticatedPaymentProvider extends ArNSPaymentProvider {
     initiateArNSPurchase(params: TurboInitiateArNSPurchaseParams): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
@@ -57,6 +58,6 @@ export declare class TurboArNSPaymentProviderUnauthenticated implements ArNSPaym
 export declare class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProviderUnauthenticated implements ArNSAuthenticatedPaymentProvider {
     private readonly signer;
     constructor({ signer, ...restConfig }: TurboAuthenticatedConfig);
-    initiateArNSPurchase({ intent, name, quantity, type, processId, years, paidBy, }: TurboInitiateArNSPurchaseParams): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
+    initiateArNSPurchase({ intent, name, quantity, type, processId, years, paidBy, referrer, }: TurboInitiateArNSPurchaseParams): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
 }
 export declare function isTurboArNSSigner(signer: unknown): signer is TurboArNSSigner;

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

@@ -347,17 +347,21 @@ export type AoGetVaultParams = {
 export type AoArNSPurchaseParams = AoArNSNameParams & {
     fundFrom?: FundFrom;
     paidBy?: WalletAddress | WalletAddress[];
+    referrer?: string;
 };
 export type AoBuyRecordParams = AoArNSPurchaseParams & {
     years?: number;
     type: 'lease' | 'permabuy';
     processId: string;
+    referrer?: string;
 };
 export type AoExtendLeaseParams = AoArNSPurchaseParams & {
     years: number;
+    referrer?: string;
 };
 export type AoIncreaseUndernameLimitParams = AoArNSPurchaseParams & {
     increaseCount: number;
+    referrer?: string;
 };
 export type AoVaultedTransferParams = {
     recipient: WalletAddress;

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.12.0";
+export declare const version = "3.12.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.12.1",
+  "version": "3.13.0-alpha.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -128,7 +128,7 @@
   },
   "dependencies": {
     "@dha-team/arbundles": "^1.0.1",
-    "@permaweb/aoconnect": "^0.0.85",
+    "@permaweb/aoconnect": "0.0.68",
     "arweave": "1.15.5",
     "axios": "1.8.4",
     "axios-retry": "^4.3.0",