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

package/lib/cjs/cli/utils.js

@@ -296,10 +296,16 @@ function paginationParamsFromOptions(options) {
         if (Array.isArray(filters)) {
             // every odd value is a key, every even value is a value for that key
             for (let i = 0; i < filters.length; i += 2) {
-                // convert any strings that are numbers to numbers
+                // convert any strings that are numbers to numbers and any 'true'/'false' to booleans
                 const value = filters[i + 1].split(',').map((v) => {
                     const num = +v;
-                    return isNaN(num) ? v : num;
+                    if (!isNaN(num))
+                        return num;
+                    if (v === 'true')
+                        return true;
+                    if (v === 'false')
+                        return false;
+                    return v;
                 });
                 filtersObject[filters[i]] = value;
             }

package/lib/cjs/common/marketplace.js

@@ -271,7 +271,9 @@ class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             signer: this.signer,
         });
     }
-    async listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, }) {
+    async listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, onProgress = (event) => {
+        this.logger.info(`List name for sale progress: ${event.step}`);
+    }, }) {
         // Get arns record for the current ant id associated with it
         const record = await this.ario.getArNSRecord({ name: name });
         this.logger.info(`Record ${name} found: ${JSON.stringify(record)}`);
@@ -284,6 +286,7 @@ class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             process: new index_js_1.AOProcess({
                 processId: antId,
                 ao: this.process.ao,
+                logger: this.logger,
             }),
             signer: this.signer,
         });
@@ -293,7 +296,18 @@ class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             throw new Error('Wallet address does not match the owner of the ANT. Only the owner can list the name for sale.');
         }
         let intent;
+        const createIntentEventData = {
+            name,
+            antId,
+            orderType: type,
+            price,
+            expirationTime,
+        };
         try {
+            onProgress({
+                step: 'creating-intent',
+                ...createIntentEventData,
+            });
             const intentResult = await this.createIntent({
                 antId,
                 orderType: type,
@@ -308,29 +322,67 @@ class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             }
             this.logger.info(`Intent created: ${JSON.stringify(intentResult.result)}`);
             intent = intentResult.result;
+            onProgress({
+                step: 'intent-created',
+                ...createIntentEventData,
+                intent,
+            });
         }
         catch (error) {
             this.logger.error(`Error creating intent: ${error.message}`);
             // check error for existing intent. Will be a contract error message.
             const isExistingIntentError = error.message.includes('An intent already exists for this ANT ID');
             if (isExistingIntentError) {
-                intent = await this.getIntentByANTId(antId).catch((error) => {
-                    this.logger.error(`Failed to get intent: ${error.message}`);
-                    throw new Error('An intent already exists for this ANT ID but failed to get intent:\n\n' +
-                        error.message);
+                intent = await this.getIntentByANTId(antId).catch((getIntentError) => {
+                    this.logger.error(`Failed to get intent: ${getIntentError.message}`);
+                    const intentError = new Error('An intent already exists for this ANT ID but failed to get intent:\n\n' +
+                        getIntentError.message);
+                    onProgress({
+                        step: 'error',
+                        name,
+                        antId,
+                        error: intentError,
+                        failedStep: 'creating-intent',
+                    });
+                    throw intentError;
                 });
             }
             else {
                 // Possible to get other errors, eg insufficient deposited ario balance. Rethrow them here.
+                onProgress({
+                    step: 'error',
+                    name,
+                    antId,
+                    error: error,
+                    failedStep: 'creating-intent',
+                });
                 throw error;
             }
         }
         // Type guard to ensure intent is defined
         if (intent === undefined) {
-            throw new Error('Failed to create intent');
+            const intentError = new Error('Failed to create intent');
+            onProgress({
+                step: 'error',
+                name,
+                antId,
+                error: intentError,
+                failedStep: 'creating-intent',
+            });
+            throw intentError;
         }
+        const transferAntEventData = {
+            name,
+            antId,
+            intentId: intent.intentId,
+            marketplaceProcessId: this.process.processId,
+        };
         let antTransferResult;
         try {
+            onProgress({
+                step: 'transferring-ant',
+                ...transferAntEventData,
+            });
             antTransferResult = await ant.transfer({
                 target: this.process.processId,
                 removeControllers: false, // important: do not remove the controllers of the ANT to prevent loss of control
@@ -338,9 +390,22 @@ class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
                 tags: [{ name: 'X-Intent-Id', value: intent.intentId }],
             });
             this.logger.info(`ANT transferred: ${JSON.stringify(antTransferResult)}`);
+            onProgress({
+                step: 'ant-transferred',
+                ...transferAntEventData,
+                transferResult: antTransferResult,
+            });
         }
         catch (error) {
             this.logger.error(`Failed to transfer ANT: ${error.message}`);
+            onProgress({
+                step: 'error',
+                name,
+                antId,
+                error: error,
+                failedStep: 'transferring-ant',
+                intent,
+            });
             return {
                 intent,
                 order: null,
@@ -373,23 +438,49 @@ class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             }
             catch (error) {
                 this.logger.error(`Failed to get order: ${error.message}`);
+                const orderError = new Error('Failed to get order: ' + error.message);
+                onProgress({
+                    step: 'error',
+                    name,
+                    antId,
+                    error: orderError,
+                    failedStep: 'transferring-ant',
+                    intent,
+                });
                 return {
                     intent,
                     order: null,
                     antTransferResult,
-                    error: new Error('Failed to get order: ' + error.message),
+                    error: orderError,
                 };
             }
         }
         if (order === null) {
             this.logger.error(`Failed to get order`);
+            const orderError = new Error('Failed to get order');
+            onProgress({
+                step: 'error',
+                name,
+                antId,
+                error: orderError,
+                failedStep: 'transferring-ant',
+                intent,
+            });
             return {
                 intent,
                 order: null,
                 antTransferResult,
-                error: new Error('Failed to get order'),
+                error: orderError,
             };
         }
+        onProgress({
+            step: 'complete',
+            name,
+            antId,
+            intent,
+            order,
+            transferResult: antTransferResult,
+        });
         return { intent, order, antTransferResult, error: null };
     }
     async cancelOrder(orderId) {

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

package/lib/esm/cli/utils.js

@@ -242,10 +242,16 @@ export function paginationParamsFromOptions(options) {
         if (Array.isArray(filters)) {
             // every odd value is a key, every even value is a value for that key
             for (let i = 0; i < filters.length; i += 2) {
-                // convert any strings that are numbers to numbers
+                // convert any strings that are numbers to numbers and any 'true'/'false' to booleans
                 const value = filters[i + 1].split(',').map((v) => {
                     const num = +v;
-                    return isNaN(num) ? v : num;
+                    if (!isNaN(num))
+                        return num;
+                    if (v === 'true')
+                        return true;
+                    if (v === 'false')
+                        return false;
+                    return v;
                 });
                 filtersObject[filters[i]] = value;
             }

package/lib/esm/common/marketplace.js

@@ -265,7 +265,9 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             signer: this.signer,
         });
     }
-    async listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, }) {
+    async listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, onProgress = (event) => {
+        this.logger.info(`List name for sale progress: ${event.step}`);
+    }, }) {
         // Get arns record for the current ant id associated with it
         const record = await this.ario.getArNSRecord({ name: name });
         this.logger.info(`Record ${name} found: ${JSON.stringify(record)}`);
@@ -278,6 +280,7 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             process: new AOProcess({
                 processId: antId,
                 ao: this.process.ao,
+                logger: this.logger,
             }),
             signer: this.signer,
         });
@@ -287,7 +290,18 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             throw new Error('Wallet address does not match the owner of the ANT. Only the owner can list the name for sale.');
         }
         let intent;
+        const createIntentEventData = {
+            name,
+            antId,
+            orderType: type,
+            price,
+            expirationTime,
+        };
         try {
+            onProgress({
+                step: 'creating-intent',
+                ...createIntentEventData,
+            });
             const intentResult = await this.createIntent({
                 antId,
                 orderType: type,
@@ -302,29 +316,67 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             }
             this.logger.info(`Intent created: ${JSON.stringify(intentResult.result)}`);
             intent = intentResult.result;
+            onProgress({
+                step: 'intent-created',
+                ...createIntentEventData,
+                intent,
+            });
         }
         catch (error) {
             this.logger.error(`Error creating intent: ${error.message}`);
             // check error for existing intent. Will be a contract error message.
             const isExistingIntentError = error.message.includes('An intent already exists for this ANT ID');
             if (isExistingIntentError) {
-                intent = await this.getIntentByANTId(antId).catch((error) => {
-                    this.logger.error(`Failed to get intent: ${error.message}`);
-                    throw new Error('An intent already exists for this ANT ID but failed to get intent:\n\n' +
-                        error.message);
+                intent = await this.getIntentByANTId(antId).catch((getIntentError) => {
+                    this.logger.error(`Failed to get intent: ${getIntentError.message}`);
+                    const intentError = new Error('An intent already exists for this ANT ID but failed to get intent:\n\n' +
+                        getIntentError.message);
+                    onProgress({
+                        step: 'error',
+                        name,
+                        antId,
+                        error: intentError,
+                        failedStep: 'creating-intent',
+                    });
+                    throw intentError;
                 });
             }
             else {
                 // Possible to get other errors, eg insufficient deposited ario balance. Rethrow them here.
+                onProgress({
+                    step: 'error',
+                    name,
+                    antId,
+                    error: error,
+                    failedStep: 'creating-intent',
+                });
                 throw error;
             }
         }
         // Type guard to ensure intent is defined
         if (intent === undefined) {
-            throw new Error('Failed to create intent');
+            const intentError = new Error('Failed to create intent');
+            onProgress({
+                step: 'error',
+                name,
+                antId,
+                error: intentError,
+                failedStep: 'creating-intent',
+            });
+            throw intentError;
         }
+        const transferAntEventData = {
+            name,
+            antId,
+            intentId: intent.intentId,
+            marketplaceProcessId: this.process.processId,
+        };
         let antTransferResult;
         try {
+            onProgress({
+                step: 'transferring-ant',
+                ...transferAntEventData,
+            });
             antTransferResult = await ant.transfer({
                 target: this.process.processId,
                 removeControllers: false, // important: do not remove the controllers of the ANT to prevent loss of control
@@ -332,9 +384,22 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
                 tags: [{ name: 'X-Intent-Id', value: intent.intentId }],
             });
             this.logger.info(`ANT transferred: ${JSON.stringify(antTransferResult)}`);
+            onProgress({
+                step: 'ant-transferred',
+                ...transferAntEventData,
+                transferResult: antTransferResult,
+            });
         }
         catch (error) {
             this.logger.error(`Failed to transfer ANT: ${error.message}`);
+            onProgress({
+                step: 'error',
+                name,
+                antId,
+                error: error,
+                failedStep: 'transferring-ant',
+                intent,
+            });
             return {
                 intent,
                 order: null,
@@ -367,23 +432,49 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
             }
             catch (error) {
                 this.logger.error(`Failed to get order: ${error.message}`);
+                const orderError = new Error('Failed to get order: ' + error.message);
+                onProgress({
+                    step: 'error',
+                    name,
+                    antId,
+                    error: orderError,
+                    failedStep: 'transferring-ant',
+                    intent,
+                });
                 return {
                     intent,
                     order: null,
                     antTransferResult,
-                    error: new Error('Failed to get order: ' + error.message),
+                    error: orderError,
                 };
             }
         }
         if (order === null) {
             this.logger.error(`Failed to get order`);
+            const orderError = new Error('Failed to get order');
+            onProgress({
+                step: 'error',
+                name,
+                antId,
+                error: orderError,
+                failedStep: 'transferring-ant',
+                intent,
+            });
             return {
                 intent,
                 order: null,
                 antTransferResult,
-                error: new Error('Failed to get order'),
+                error: orderError,
             };
         }
+        onProgress({
+            step: 'complete',
+            name,
+            antId,
+            intent,
+            order,
+            transferResult: antTransferResult,
+        });
         return { intent, order, antTransferResult, error: null };
     }
     async cancelOrder(orderId) {

package/lib/esm/version.js

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

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

@@ -195,6 +195,83 @@ export interface AoArNSMarketplaceRead {
         antIds: string[];
     }>;
 }
+/**
+ * Common fields for create-intent progress events
+ */
+export interface CreateIntentEventData {
+    name: string;
+    antId: string;
+    orderType: 'fixed' | 'dutch' | 'english';
+    price: string;
+    expirationTime: number;
+}
+/**
+ * Progress event emitted while creating the marketplace intent
+ */
+export interface CreatingIntentProgressEvent extends CreateIntentEventData {
+    step: 'creating-intent';
+}
+/**
+ * Progress event emitted after successfully creating the marketplace intent
+ */
+export interface IntentCreatedProgressEvent extends CreateIntentEventData {
+    step: 'intent-created';
+    intent: MarketplaceIntent;
+}
+/**
+ * Common fields for transfer-ant progress events
+ */
+export interface TransferAntEventData {
+    name: string;
+    antId: string;
+    intentId: string;
+    marketplaceProcessId: string;
+}
+/**
+ * Progress event emitted while transferring the ANT to the marketplace
+ */
+export interface TransferringAntProgressEvent extends TransferAntEventData {
+    step: 'transferring-ant';
+}
+/**
+ * Progress event emitted after successfully transferring the ANT to the marketplace
+ */
+export interface AntTransferredProgressEvent extends TransferAntEventData {
+    step: 'ant-transferred';
+    transferResult: AoMessageResult<Record<string, string | number | boolean | null>>;
+}
+/**
+ * Progress event emitted when an error occurs during the workflow
+ */
+export interface ListNameForSaleErrorEvent {
+    step: 'error';
+    name: string;
+    antId: string;
+    error: Error;
+    /**
+     * The step that was in progress when the error occurred
+     */
+    failedStep: 'creating-intent' | 'transferring-ant';
+    /**
+     * The intent if it was created before the error occurred
+     */
+    intent?: MarketplaceIntent;
+}
+/**
+ * Progress event emitted when the workflow completes successfully
+ */
+export interface ListNameForSaleCompleteEvent {
+    step: 'complete';
+    name: string;
+    antId: string;
+    intent: MarketplaceIntent;
+    order: Order;
+    transferResult: AoMessageResult<Record<string, string | number | boolean | null>>;
+}
+/**
+ * Progress events emitted during listNameForSale workflow
+ */
+export type ListNameForSaleProgressEvent = CreatingIntentProgressEvent | IntentCreatedProgressEvent | TransferringAntProgressEvent | AntTransferredProgressEvent | ListNameForSaleErrorEvent | ListNameForSaleCompleteEvent;
 export interface AoArNSMarketplaceWrite {
     createIntent(params: CreateIntentParams): Promise<AoMessageResult<MarketplaceIntent>>;
     cancelOrder(orderId: string): Promise<AoMessageResult>;
@@ -220,7 +297,7 @@ export interface AoArNSMarketplaceWrite {
      * @param params - Parameters including name, expiration time, price, type, wallet address, and optional auction parameters
      * @returns Result containing intent, order, ANT transfer result, and any error
      */
-    listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, }: {
+    listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, onProgress, }: {
         name: string;
         expirationTime: number;
         price: string;
@@ -228,6 +305,7 @@ export interface AoArNSMarketplaceWrite {
         walletAddress: WalletAddress;
         minimumPrice?: string;
         decreaseInterval?: string;
+        onProgress?: (event: ListNameForSaleProgressEvent) => void;
     }): Promise<{
         intent: MarketplaceIntent;
         order: Order | null;
@@ -345,7 +423,7 @@ export declare class ArNSMarketplaceWrite extends ArNSMarketplaceRead implements
         dominantToken?: string;
         swapToken?: string;
     }): Promise<AoMessageResult>;
-    listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, }: {
+    listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, onProgress, }: {
         name: string;
         expirationTime: number;
         price: string;
@@ -353,6 +431,7 @@ export declare class ArNSMarketplaceWrite extends ArNSMarketplaceRead implements
         walletAddress: WalletAddress;
         minimumPrice?: string;
         decreaseInterval?: string;
+        onProgress?: (event: ListNameForSaleProgressEvent) => void;
     }): Promise<{
         intent: MarketplaceIntent;
         order: Order | null;

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.23.0-alpha.1";
+export declare const version = "3.23.0-alpha.3";

package/package.json

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