@ar.io/sdk 3.0.0-alpha.1 → 3.0.1-alpha.1

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

@@ -38,10 +38,10 @@ async function joinNetwork(options) {
     if (!options.skipConfirmation) {
         const settings = await ario.getGatewayRegistrySettings();
         if (settings.operators.minStake > mARIOQuantity.valueOf()) {
-            throw new Error(`The minimum operator stake is ${(0, utils_js_1.formatARIOWithCommas)(new index_js_1.mARIOToken(settings.operators.minStake).toARIO())} IO. Please provide a higher stake.`);
+            throw new Error(`The minimum operator stake is ${(0, utils_js_1.formatARIOWithCommas)(new index_js_1.mARIOToken(settings.operators.minStake).toARIO())} ARIO. Please provide a higher stake.`);
         }
         await (0, utils_js_1.assertEnoughBalance)(ario, signerAddress, mARIOQuantity.toARIO());
-        await (0, utils_js_1.assertConfirmationPrompt)(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${(0, utils_js_1.formatARIOWithCommas)(mARIOQuantity.toARIO())} IO to join the AR.IO network\nAre you sure?\n`, options);
+        await (0, utils_js_1.assertConfirmationPrompt)(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${(0, utils_js_1.formatARIOWithCommas)(mARIOQuantity.toARIO())} ARIO to join the AR.IO network\nAre you sure?\n`, options);
     }
     const result = await ario.joinNetwork(settings, (0, utils_js_1.writeActionTagsFromOptions)(options));
     const output = {
@@ -96,7 +96,7 @@ async function saveObservations(o) {
 exports.saveObservations = saveObservations;
 async function increaseOperatorStake(o) {
     const increaseQty = (0, utils_js_1.requiredMIOFromOptions)(o, 'operatorStake');
-    await (0, utils_js_1.assertConfirmationPrompt)(`You are about to increase your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(increaseQty.toARIO())} IO\nAre you sure?`, o);
+    await (0, utils_js_1.assertConfirmationPrompt)(`You are about to increase your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(increaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return ((0, utils_js_1.writeARIOFromOptions)(o).ario.increaseOperatorStake({
         increaseQty,
     }),
@@ -106,7 +106,7 @@ exports.increaseOperatorStake = increaseOperatorStake;
 async function decreaseOperatorStake(o) {
     const decreaseQty = (0, utils_js_1.requiredMIOFromOptions)(o, 'operatorStake');
     // TODO: Can assert stake is sufficient for action, and new target stake meets contract minimum
-    await (0, utils_js_1.assertConfirmationPrompt)(`You are about to decrease your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(decreaseQty.toARIO())} IO\nAre you sure?`, o);
+    await (0, utils_js_1.assertConfirmationPrompt)(`You are about to decrease your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(decreaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return (0, utils_js_1.writeARIOFromOptions)(o).ario.decreaseOperatorStake({
         decreaseQty,
     }, (0, utils_js_1.writeActionTagsFromOptions)(o));

package/lib/cjs/cli/options.js

@@ -65,7 +65,7 @@ exports.optionMap = {
     },
     quantity: {
         alias: '-q, --quantity <quantity>',
-        description: 'The quantity of IO to interact with',
+        description: 'The quantity of ARIO to interact with',
     },
     autoStake: {
         alias: '--auto-stake',

package/lib/cjs/cli/utils.js

@@ -296,15 +296,15 @@ function recordTypeFromOptions(options) {
 exports.recordTypeFromOptions = recordTypeFromOptions;
 function requiredMIOFromOptions(options, key) {
     if (options[key] === undefined) {
-        throw new Error(`No ${key} provided. Use --${key} denominated in IO`);
+        throw new Error(`No ${key} provided. Use --${key} denominated in ARIO`);
     }
     return new index_js_1.ARIOToken(+options[key]).toMARIO();
 }
 exports.requiredMIOFromOptions = requiredMIOFromOptions;
-async function assertEnoughBalance(io, address, ioQuantity) {
-    const balance = await io.getBalance({ address });
-    if (balance < ioQuantity.toMARIO().valueOf()) {
-        throw new Error(`Insufficient IO balance for action. Balance available: ${new index_js_1.mARIOToken(balance).toARIO()} IO`);
+async function assertEnoughBalance(ario, address, arioQuantity) {
+    const balance = await ario.getBalance({ address });
+    if (balance < arioQuantity.toMARIO().valueOf()) {
+        throw new Error(`Insufficient ARIO balance for action. Balance available: ${new index_js_1.mARIOToken(balance).toARIO()} ARIO`);
     }
 }
 exports.assertEnoughBalance = assertEnoughBalance;

package/lib/cjs/common/contracts/ao-process.js

@@ -17,6 +17,7 @@ exports.AOProcess = void 0;
  * limitations under the License.
  */
 const aoconnect_1 = require("@permaweb/aoconnect");
+const base64_js_1 = require("../../utils/base64.js");
 const json_js_1 = require("../../utils/json.js");
 const version_js_1 = require("../../version.js");
 const error_js_1 = require("../error.js");
@@ -89,16 +90,20 @@ class AOProcess {
                     processId: this.processId,
                 });
                 // TODO: do a read as a dry run to check if the process supports the action
+                // anchor is a random text produce non-deterministic messages IDs when deterministic signers are provided (ETH)
+                const anchor = (0, base64_js_1.getRandomText)(32);
                 const messageId = await this.ao.message({
                     process: this.processId,
                     // TODO: any other default tags we want to add?
                     tags: [...tags, { name: 'AR-IO-SDK', value: version_js_1.version }],
                     data,
                     signer,
+                    anchor,
                 });
                 this.logger.debug(`Sent message to process`, {
                     messageId,
                     processId: this.processId,
+                    anchor,
                 });
                 // check the result of the send interaction
                 const output = await this.ao.result({

package/lib/cjs/utils/base64.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sha256B64Url = exports.toB64Url = exports.fromB64Url = void 0;
+exports.getRandomText = exports.sha256B64Url = exports.toB64Url = exports.fromB64Url = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -52,3 +52,12 @@ function sha256B64Url(input) {
     return toB64Url((0, crypto_1.createHash)('sha256').update(Uint8Array.from(input)).digest());
 }
 exports.sha256B64Url = sha256B64Url;
+function getRandomText(length = 32) {
+    // Generate a buffer of random bytes
+    const buffer = (0, crypto_1.randomBytes)(length);
+    // Convert bytes to hexadecimal string
+    return Array.from(buffer, (byte) => byte.toString(16).padStart(2, '0'))
+        .join('')
+        .slice(0, length);
+}
+exports.getRandomText = getRandomText;

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.0.0-alpha.1';
+exports.version = '3.0.1-alpha.1';

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

@@ -32,10 +32,10 @@ export async function joinNetwork(options) {
     if (!options.skipConfirmation) {
         const settings = await ario.getGatewayRegistrySettings();
         if (settings.operators.minStake > mARIOQuantity.valueOf()) {
-            throw new Error(`The minimum operator stake is ${formatARIOWithCommas(new mARIOToken(settings.operators.minStake).toARIO())} IO. Please provide a higher stake.`);
+            throw new Error(`The minimum operator stake is ${formatARIOWithCommas(new mARIOToken(settings.operators.minStake).toARIO())} ARIO. Please provide a higher stake.`);
         }
         await assertEnoughBalance(ario, signerAddress, mARIOQuantity.toARIO());
-        await assertConfirmationPrompt(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${formatARIOWithCommas(mARIOQuantity.toARIO())} IO to join the AR.IO network\nAre you sure?\n`, options);
+        await assertConfirmationPrompt(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${formatARIOWithCommas(mARIOQuantity.toARIO())} ARIO to join the AR.IO network\nAre you sure?\n`, options);
     }
     const result = await ario.joinNetwork(settings, writeActionTagsFromOptions(options));
     const output = {
@@ -86,7 +86,7 @@ export async function saveObservations(o) {
 }
 export async function increaseOperatorStake(o) {
     const increaseQty = requiredMARIOFromOptions(o, 'operatorStake');
-    await assertConfirmationPrompt(`You are about to increase your operator stake by ${formatARIOWithCommas(increaseQty.toARIO())} IO\nAre you sure?`, o);
+    await assertConfirmationPrompt(`You are about to increase your operator stake by ${formatARIOWithCommas(increaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return (writeARIOFromOptions(o).ario.increaseOperatorStake({
         increaseQty,
     }),
@@ -95,7 +95,7 @@ export async function increaseOperatorStake(o) {
 export async function decreaseOperatorStake(o) {
     const decreaseQty = requiredMARIOFromOptions(o, 'operatorStake');
     // TODO: Can assert stake is sufficient for action, and new target stake meets contract minimum
-    await assertConfirmationPrompt(`You are about to decrease your operator stake by ${formatARIOWithCommas(decreaseQty.toARIO())} IO\nAre you sure?`, o);
+    await assertConfirmationPrompt(`You are about to decrease your operator stake by ${formatARIOWithCommas(decreaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return writeARIOFromOptions(o).ario.decreaseOperatorStake({
         decreaseQty,
     }, writeActionTagsFromOptions(o));

package/lib/esm/cli/options.js

@@ -62,7 +62,7 @@ export const optionMap = {
     },
     quantity: {
         alias: '-q, --quantity <quantity>',
-        description: 'The quantity of IO to interact with',
+        description: 'The quantity of ARIO to interact with',
     },
     autoStake: {
         alias: '--auto-stake',

package/lib/esm/cli/utils.js

@@ -267,14 +267,14 @@ export function recordTypeFromOptions(options) {
 }
 export function requiredMIOFromOptions(options, key) {
     if (options[key] === undefined) {
-        throw new Error(`No ${key} provided. Use --${key} denominated in IO`);
+        throw new Error(`No ${key} provided. Use --${key} denominated in ARIO`);
     }
     return new ARIOToken(+options[key]).toMARIO();
 }
-export async function assertEnoughBalance(io, address, ioQuantity) {
-    const balance = await io.getBalance({ address });
-    if (balance < ioQuantity.toMARIO().valueOf()) {
-        throw new Error(`Insufficient IO balance for action. Balance available: ${new mARIOToken(balance).toARIO()} IO`);
+export async function assertEnoughBalance(ario, address, arioQuantity) {
+    const balance = await ario.getBalance({ address });
+    if (balance < arioQuantity.toMARIO().valueOf()) {
+        throw new Error(`Insufficient ARIO balance for action. Balance available: ${new mARIOToken(balance).toARIO()} ARIO`);
     }
 }
 export async function confirmationPrompt(message) {

package/lib/esm/common/contracts/ao-process.js

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import { connect } from '@permaweb/aoconnect';
+import { getRandomText } from '../../utils/base64.js';
 import { safeDecode } from '../../utils/json.js';
 import { version } from '../../version.js';
 import { WriteInteractionError } from '../error.js';
@@ -86,16 +87,20 @@ export class AOProcess {
                     processId: this.processId,
                 });
                 // TODO: do a read as a dry run to check if the process supports the action
+                // anchor is a random text produce non-deterministic messages IDs when deterministic signers are provided (ETH)
+                const anchor = getRandomText(32);
                 const messageId = await this.ao.message({
                     process: this.processId,
                     // TODO: any other default tags we want to add?
                     tags: [...tags, { name: 'AR-IO-SDK', value: version }],
                     data,
                     signer,
+                    anchor,
                 });
                 this.logger.debug(`Sent message to process`, {
                     messageId,
                     processId: this.processId,
+                    anchor,
                 });
                 // check the result of the send interaction
                 const output = await this.ao.result({

package/lib/esm/utils/base64.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createHash } from 'crypto';
+import { createHash, randomBytes } from 'crypto';
 // safely encodes and decodes base64url strings to and from buffers
 const BASE64_CHAR_62 = '+';
 const BASE64_CHAR_63 = '/';
@@ -46,3 +46,11 @@ export function toB64Url(buffer) {
 export function sha256B64Url(input) {
     return toB64Url(createHash('sha256').update(Uint8Array.from(input)).digest());
 }
+export function getRandomText(length = 32) {
+    // Generate a buffer of random bytes
+    const buffer = randomBytes(length);
+    // Convert bytes to hexadecimal string
+    return Array.from(buffer, (byte) => byte.toString(16).padStart(2, '0'))
+        .join('')
+        .slice(0, length);
+}

package/lib/esm/version.js

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

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

@@ -52,7 +52,7 @@ export declare function recordTypeFromOptions<O extends {
     type?: string;
 }>(options: O): 'lease' | 'permabuy';
 export declare function requiredMIOFromOptions<O extends GlobalCLIOptions>(options: O, key: string): mARIOToken;
-export declare function assertEnoughBalance(io: AoARIORead, address: string, ioQuantity: ARIOToken): Promise<void>;
+export declare function assertEnoughBalance(ario: AoARIORead, address: string, arioQuantity: ARIOToken): Promise<void>;
 export declare function confirmationPrompt(message: string): Promise<boolean>;
 export declare function assertConfirmationPrompt<O extends {
     skipConfirmation?: boolean;

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

@@ -2,3 +2,4 @@
 export declare function fromB64Url(str: string): Buffer;
 export declare function toB64Url(buffer: Buffer): string;
 export declare function sha256B64Url(input: Buffer): string;
+export declare function getRandomText(length?: number): string;

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 = "2.7.0-alpha.7";
+export declare const version = "3.0.0";

package/package.json

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