@ar.io/sdk 3.9.0-alpha.2 → 3.9.0-alpha.4

package/lib/cjs/cli/options.js

@@ -268,6 +268,10 @@ exports.optionMap = {
         alias: '--recipient <recipient>',
         description: 'The recipient to interact with',
     },
+    logo: {
+        alias: '--logo <logo>',
+        description: 'The ANT logo',
+    },
 };
 exports.walletOptions = [
     exports.optionMap.walletFile,
@@ -369,6 +373,7 @@ exports.antStateOptions = [
     exports.optionMap.description,
     exports.optionMap.controllers,
     exports.optionMap.ttlSeconds,
+    exports.optionMap.logo,
 ];
 exports.setAntBaseNameOptions = [
     exports.optionMap.processId,

package/lib/cjs/cli/utils.js

@@ -434,6 +434,7 @@ function getANTStateFromOptions(options) {
         ticker: options.ticker,
         name: options.name,
         keywords: options.keywords,
+        logo: options.logo,
         ttlSeconds: options.ttlSeconds !== undefined
             ? +options.ttlSeconds
             : exports.defaultTtlSecondsCLI,

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

@@ -68,7 +68,13 @@ class AOProcess {
                     processId: this.processId,
                 });
                 if (attempts >= retries) {
-                    throw error;
+                    this.logger.error(`Maximum read attempts exceeded`, {
+                        error: error?.message,
+                        stack: error?.stack,
+                        tags,
+                        processId: this.processId,
+                    });
+                    throw new Error(`Maximum read attempts exceeded for process ${this.processId}`);
                 }
                 // exponential backoff
                 await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 1000));
@@ -106,6 +112,8 @@ class AOProcess {
         let attempts = 0;
         let messageId;
         let result = undefined;
+        // anchor is a random text produce non-deterministic messages IDs when deterministic signers are provided (ETH)
+        const anchor = (0, base64_js_1.getRandomText)(32);
         while (attempts < retries) {
             try {
                 this.logger.debug(`Evaluating send interaction on contract`, {
@@ -113,12 +121,9 @@ class AOProcess {
                     data,
                     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);
-                messageId = await this.ao.message({
+                // MUST NOT retry messaging if a message was already sent. This could result in a double entry-like condition when sending tokens for example.
+                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,
@@ -129,7 +134,6 @@ class AOProcess {
                     processId: this.processId,
                     anchor,
                 });
-                // check the result of the send interaction
                 result = await this.ao.result({
                     message: messageId,
                     process: this.processId,
@@ -156,7 +160,13 @@ class AOProcess {
                     processId: this.processId,
                 });
                 if (attempts >= retries) {
-                    throw error;
+                    this.logger.error(`Maximum read result attempts exceeded`, {
+                        error: error?.message,
+                        stack: error?.stack,
+                        tags,
+                        processId: this.processId,
+                    });
+                    throw new Error(`Maximum read result attempts exceeded for process ${this.processId}.`);
                 }
                 // exponential backoff
                 await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 2000));

package/lib/cjs/utils/ao.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeUnicodeFromError = exports.errorMessageFromOutput = exports.parseAoEpochData = exports.initANTStateForAddress = exports.defaultTargetManifestId = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
+exports.removeUnicodeFromError = exports.errorMessageFromOutput = exports.parseAoEpochData = exports.initANTStateForAddress = exports.defaultANTLogoId = exports.defaultTargetManifestId = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -141,7 +141,8 @@ function createAoSigner(signer) {
 }
 exports.createAoSigner = createAoSigner;
 exports.defaultTargetManifestId = '-k7t8xMoB8hW482609Z9F4bTFMC3MnuW8bTvTyT8pFI';
-function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords = [], controllers = [], description = '', ticker = 'aos', name = 'ANT', }) {
+exports.defaultANTLogoId = 'Sie_26dvgyok0PZD_-iQAFOhOd5YxDTkczOLoqTTL_A';
+function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords = [], controllers = [], description = '', ticker = 'aos', name = 'ANT', logo = exports.defaultANTLogoId, }) {
     return {
         ticker,
         name,
@@ -156,6 +157,7 @@ function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords =
                 ttlSeconds,
             },
         },
+        logo,
     };
 }
 exports.initANTStateForAddress = initANTStateForAddress;

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.9.0-alpha.2';
+exports.version = '3.9.0-alpha.4';

package/lib/esm/cli/options.js

@@ -265,6 +265,10 @@ export const optionMap = {
         alias: '--recipient <recipient>',
         description: 'The recipient to interact with',
     },
+    logo: {
+        alias: '--logo <logo>',
+        description: 'The ANT logo',
+    },
 };
 export const walletOptions = [
     optionMap.walletFile,
@@ -366,6 +370,7 @@ export const antStateOptions = [
     optionMap.description,
     optionMap.controllers,
     optionMap.ttlSeconds,
+    optionMap.logo,
 ];
 export const setAntBaseNameOptions = [
     optionMap.processId,

package/lib/esm/cli/utils.js

@@ -391,6 +391,7 @@ export function getANTStateFromOptions(options) {
         ticker: options.ticker,
         name: options.name,
         keywords: options.keywords,
+        logo: options.logo,
         ttlSeconds: options.ttlSeconds !== undefined
             ? +options.ttlSeconds
             : defaultTtlSecondsCLI,

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

@@ -65,7 +65,13 @@ export class AOProcess {
                     processId: this.processId,
                 });
                 if (attempts >= retries) {
-                    throw error;
+                    this.logger.error(`Maximum read attempts exceeded`, {
+                        error: error?.message,
+                        stack: error?.stack,
+                        tags,
+                        processId: this.processId,
+                    });
+                    throw new Error(`Maximum read attempts exceeded for process ${this.processId}`);
                 }
                 // exponential backoff
                 await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 1000));
@@ -103,6 +109,8 @@ export class AOProcess {
         let attempts = 0;
         let messageId;
         let result = undefined;
+        // anchor is a random text produce non-deterministic messages IDs when deterministic signers are provided (ETH)
+        const anchor = getRandomText(32);
         while (attempts < retries) {
             try {
                 this.logger.debug(`Evaluating send interaction on contract`, {
@@ -110,12 +118,9 @@ export class AOProcess {
                     data,
                     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);
-                messageId = await this.ao.message({
+                // MUST NOT retry messaging if a message was already sent. This could result in a double entry-like condition when sending tokens for example.
+                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,
@@ -126,7 +131,6 @@ export class AOProcess {
                     processId: this.processId,
                     anchor,
                 });
-                // check the result of the send interaction
                 result = await this.ao.result({
                     message: messageId,
                     process: this.processId,
@@ -153,7 +157,13 @@ export class AOProcess {
                     processId: this.processId,
                 });
                 if (attempts >= retries) {
-                    throw error;
+                    this.logger.error(`Maximum read result attempts exceeded`, {
+                        error: error?.message,
+                        stack: error?.stack,
+                        tags,
+                        processId: this.processId,
+                    });
+                    throw new Error(`Maximum read result attempts exceeded for process ${this.processId}.`);
                 }
                 // exponential backoff
                 await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 2000));

package/lib/esm/utils/ao.js

@@ -134,7 +134,8 @@ export function createAoSigner(signer) {
     return aoSigner;
 }
 export const defaultTargetManifestId = '-k7t8xMoB8hW482609Z9F4bTFMC3MnuW8bTvTyT8pFI';
-export function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords = [], controllers = [], description = '', ticker = 'aos', name = 'ANT', }) {
+export const defaultANTLogoId = 'Sie_26dvgyok0PZD_-iQAFOhOd5YxDTkczOLoqTTL_A';
+export function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, keywords = [], controllers = [], description = '', ticker = 'aos', name = 'ANT', logo = defaultANTLogoId, }) {
     return {
         ticker,
         name,
@@ -149,6 +150,7 @@ export function initANTStateForAddress({ owner, targetId, ttlSeconds = 3600, key
                 ttlSeconds,
             },
         },
+        logo,
     };
 }
 /**

package/lib/esm/version.js

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

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

@@ -261,6 +261,10 @@ export declare const optionMap: {
         alias: string;
         description: string;
     };
+    logo: {
+        alias: string;
+        description: string;
+    };
 };
 export declare const walletOptions: {
     alias: string;

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

@@ -101,6 +101,7 @@ export type ANTStateCLIOptions = WriteActionCLIOptions & {
     description?: string;
     controllers?: string[];
     ttlSeconds?: string;
+    logo?: string;
 };
 export type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
     [key: string]: JsonSerializable;

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

@@ -11,6 +11,7 @@ export type SpawnANTState = {
     ticker: string;
     records: Record<string, AoANTRecord>;
     balances: Record<WalletAddress, number>;
+    logo: string;
 };
 export type SpawnANTParams = {
     signer: AoSigner;
@@ -43,7 +44,8 @@ export declare function evolveANT({ signer, processId, luaCodeTxId, ao, logger,
 export declare function isAoSigner(value: unknown): value is AoSigner;
 export declare function createAoSigner(signer: ContractSigner): AoSigner;
 export declare const defaultTargetManifestId = "-k7t8xMoB8hW482609Z9F4bTFMC3MnuW8bTvTyT8pFI";
-export declare function initANTStateForAddress({ owner, targetId, ttlSeconds, keywords, controllers, description, ticker, name, }: Partial<SpawnANTState> & {
+export declare const defaultANTLogoId = "Sie_26dvgyok0PZD_-iQAFOhOd5YxDTkczOLoqTTL_A";
+export declare function initANTStateForAddress({ owner, targetId, ttlSeconds, keywords, controllers, description, ticker, name, logo, }: Partial<SpawnANTState> & {
     targetId?: string;
     ttlSeconds?: number;
     owner: 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.9.0-alpha.1";
+export declare const version = "3.9.0-alpha.3";

package/package.json

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