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

package/lib/cjs/common/marketplace.js

@@ -19,6 +19,10 @@ exports.calculateSaleTax = calculateSaleTax;
  * limitations under the License.
  */
 const index_js_1 = require("../node/index.js");
+/**
+ * Read-only client for the ArNS marketplace
+ * @experimental
+ */
 class ArNSMarketplaceRead {
     process;
     logger;
@@ -194,6 +198,10 @@ class ArNSMarketplaceRead {
     }
 }
 exports.ArNSMarketplaceRead = ArNSMarketplaceRead;
+/**
+ * Write client for the ArNS marketplace
+ * @experimental
+ */
 class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
     process;
     signer;
@@ -614,6 +622,7 @@ exports.ArNSMarketplaceWrite = ArNSMarketplaceWrite;
  * Calculates the listing fee for an order based on the end timestamp.
  * The fee is calculated by rounding up the hours until the end timestamp to the nearest hour.
  *
+ * @experimental
  * @param params - Parameters for calculating the listing fee
  * @param params.listingFeePerHour - The listing fee per hour in mARIO (as a string)
  * @param params.endTimestamp - Unix timestamp when the order expires
@@ -643,6 +652,7 @@ function calculateListingFee({ listingFeePerHour, endTimestamp, }) {
 /**
  * Calculates the sale tax for an order based on the sale amount.
  *
+ * @experimental
  * @param params - Parameters for calculating the sale tax
  * @param params.saleAmount - The sale amount in mARIO (as a string or number)
  * @param params.saleTaxNumerator - The numerator for sale tax calculation

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

package/lib/esm/common/marketplace.js

@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 import { ANT, AOProcess, Logger, MARKETPLACE_CONTRACT_ID, paginationParamsToTags, } from '../node/index.js';
+/**
+ * Read-only client for the ArNS marketplace
+ * @experimental
+ */
 export class ArNSMarketplaceRead {
     process;
     logger;
@@ -188,6 +192,10 @@ export class ArNSMarketplaceRead {
         return { intents, orders, balances, antIds: antIdsArray };
     }
 }
+/**
+ * Write client for the ArNS marketplace
+ * @experimental
+ */
 export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
     process;
     signer;
@@ -607,6 +615,7 @@ export class ArNSMarketplaceWrite extends ArNSMarketplaceRead {
  * Calculates the listing fee for an order based on the end timestamp.
  * The fee is calculated by rounding up the hours until the end timestamp to the nearest hour.
  *
+ * @experimental
  * @param params - Parameters for calculating the listing fee
  * @param params.listingFeePerHour - The listing fee per hour in mARIO (as a string)
  * @param params.endTimestamp - Unix timestamp when the order expires
@@ -636,6 +645,7 @@ export function calculateListingFee({ listingFeePerHour, endTimestamp, }) {
 /**
  * Calculates the sale tax for an order based on the sale amount.
  *
+ * @experimental
  * @param params - Parameters for calculating the sale tax
  * @param params.saleAmount - The sale amount in mARIO (as a string or number)
  * @param params.saleTaxNumerator - The numerator for sale tax calculation

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.4';
+export const version = '3.23.0-alpha.5';

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

@@ -19,6 +19,7 @@ import { AoARIOWrite, PaginationParams, PaginationResult } from '../types/io.js'
 /**
  * User-provided order parameters for intent-based order creation
  * These are the user-configurable fields when creating an order via the intent workflow
+ * @experimental
  */
 export interface MarketplaceOrderIntentParams {
     orderType?: 'fixed' | 'dutch' | 'english';
@@ -30,6 +31,7 @@ export interface MarketplaceOrderIntentParams {
 }
 /**
  * Intent structure - matches Lua Intent type
+ * @experimental
  */
 export interface MarketplaceIntent {
     intentId: string;
@@ -46,6 +48,7 @@ export interface MarketplaceIntent {
 }
 /**
  * Fee information structure for calculating order costs
+ * @experimental
  */
 export interface MarketplaceFeeInfo {
     listingFeePerHour: string;
@@ -54,6 +57,7 @@ export interface MarketplaceFeeInfo {
 }
 /**
  * Intent statistics structure
+ * @experimental
  */
 export interface MarketplaceIntentStats {
     total: number;
@@ -63,6 +67,7 @@ export interface MarketplaceIntentStats {
 }
 /**
  * Activity information structure
+ * @experimental
  */
 export interface MarketplaceActivityInfo {
     totalOrders: number;
@@ -74,7 +79,8 @@ export interface MarketplaceActivityInfo {
     listedOrders: number;
 }
 /**
- * marketplace information structure
+ * Marketplace information structure
+ * @experimental
  */
 export interface MarketplaceInfo {
     totalPairs: number;
@@ -83,6 +89,7 @@ export interface MarketplaceInfo {
 }
 /**
  * Info response structure from the marketplace
+ * @experimental
  */
 export interface InfoResponse {
     name: string;
@@ -95,6 +102,7 @@ export interface InfoResponse {
 }
 /**
  * Parameters for creating an intent (Create-Order action is assumed)
+ * @experimental
  */
 export interface CreateIntentParams {
     antId: string;
@@ -107,6 +115,7 @@ export interface CreateIntentParams {
 }
 /**
  * Parameters for paginated intent queries
+ * @experimental
  */
 export interface GetPaginatedIntentsParams {
     cursor?: string;
@@ -117,6 +126,7 @@ export interface GetPaginatedIntentsParams {
 }
 /**
  * Parameters for creating an order using internal ARIO balance
+ * @experimental
  */
 export interface CreateOrderParams {
     swapToken: string;
@@ -130,6 +140,7 @@ export interface CreateOrderParams {
 }
 /**
  * Parameters for getting orders with flexible selectors
+ * @experimental
  */
 export interface GetOrdersParams extends GetPaginatedIntentsParams {
     status?: 'all' | 'listed' | 'completed' | 'active' | 'ready-for-settlement' | 'executed' | 'cancelled' | 'expired';
@@ -139,6 +150,7 @@ export interface GetOrdersParams extends GetPaginatedIntentsParams {
 }
 /**
  * Individual order structure returned from Get-Orders and Get-Order handlers
+ * @experimental
  */
 export interface Order {
     id: string;
@@ -161,6 +173,10 @@ export interface Order {
     endedAt?: number;
     bids?: Record<string, boolean>;
 }
+/**
+ * Marketplace balance information for a wallet address
+ * @experimental
+ */
 export interface MarketplaceBalance {
     address: WalletAddress;
     balance: string;
@@ -168,6 +184,10 @@ export interface MarketplaceBalance {
     totalBalance: string;
     orders: Record<string, string>;
 }
+/**
+ * Read-only interface for the ArNS marketplace
+ * @experimental
+ */
 export interface AoArNSMarketplaceRead {
     getInfo(): Promise<InfoResponse>;
     getPaginatedIntents(params: GetPaginatedIntentsParams): Promise<PaginationResult<MarketplaceIntent>>;
@@ -197,6 +217,7 @@ export interface AoArNSMarketplaceRead {
 }
 /**
  * Common fields for create-intent progress events
+ * @experimental
  */
 export interface CreateIntentEventData {
     name: string;
@@ -207,12 +228,14 @@ export interface CreateIntentEventData {
 }
 /**
  * Progress event emitted while creating the marketplace intent
+ * @experimental
  */
 export interface CreatingIntentProgressEvent extends CreateIntentEventData {
     step: 'creating-intent';
 }
 /**
  * Progress event emitted after successfully creating the marketplace intent
+ * @experimental
  */
 export interface IntentCreatedProgressEvent extends CreateIntentEventData {
     step: 'intent-created';
@@ -220,6 +243,7 @@ export interface IntentCreatedProgressEvent extends CreateIntentEventData {
 }
 /**
  * Common fields for transfer-ant progress events
+ * @experimental
  */
 export interface TransferAntEventData {
     name: string;
@@ -229,12 +253,14 @@ export interface TransferAntEventData {
 }
 /**
  * Progress event emitted while transferring the ANT to the marketplace
+ * @experimental
  */
 export interface TransferringAntProgressEvent extends TransferAntEventData {
     step: 'transferring-ant';
 }
 /**
  * Progress event emitted after successfully transferring the ANT to the marketplace
+ * @experimental
  */
 export interface AntTransferredProgressEvent extends TransferAntEventData {
     step: 'ant-transferred';
@@ -242,6 +268,7 @@ export interface AntTransferredProgressEvent extends TransferAntEventData {
 }
 /**
  * Progress event emitted when an error occurs during the workflow
+ * @experimental
  */
 export interface ListNameForSaleErrorEvent {
     step: 'error';
@@ -259,6 +286,7 @@ export interface ListNameForSaleErrorEvent {
 }
 /**
  * Progress event emitted when the workflow completes successfully
+ * @experimental
  */
 export interface ListNameForSaleCompleteEvent {
     step: 'complete';
@@ -270,8 +298,13 @@ export interface ListNameForSaleCompleteEvent {
 }
 /**
  * Progress events emitted during listNameForSale workflow
+ * @experimental
  */
 export type ListNameForSaleProgressEvent = CreatingIntentProgressEvent | IntentCreatedProgressEvent | TransferringAntProgressEvent | AntTransferredProgressEvent | ListNameForSaleErrorEvent | ListNameForSaleCompleteEvent;
+/**
+ * Write interface for the ArNS marketplace
+ * @experimental
+ */
 export interface AoArNSMarketplaceWrite {
     createIntent(params: CreateIntentParams): Promise<AoMessageResult<MarketplaceIntent>>;
     cancelOrder(orderId: string): Promise<AoMessageResult>;
@@ -352,6 +385,10 @@ export interface AoArNSMarketplaceWrite {
         antId: string;
     }): Promise<AoMessageResult>;
 }
+/**
+ * Read-only client for the ArNS marketplace
+ * @experimental
+ */
 export declare class ArNSMarketplaceRead implements AoArNSMarketplaceRead {
     protected process: AOProcess;
     protected logger: Logger;
@@ -393,6 +430,10 @@ export declare class ArNSMarketplaceRead implements AoArNSMarketplaceRead {
         antIds: string[];
     }>;
 }
+/**
+ * Write client for the ArNS marketplace
+ * @experimental
+ */
 export declare class ArNSMarketplaceWrite extends ArNSMarketplaceRead implements AoArNSMarketplaceWrite {
     protected process: AOProcess;
     protected signer: AoSigner;
@@ -467,6 +508,7 @@ export declare class ArNSMarketplaceWrite extends ArNSMarketplaceRead implements
  * Calculates the listing fee for an order based on the end timestamp.
  * The fee is calculated by rounding up the hours until the end timestamp to the nearest hour.
  *
+ * @experimental
  * @param params - Parameters for calculating the listing fee
  * @param params.listingFeePerHour - The listing fee per hour in mARIO (as a string)
  * @param params.endTimestamp - Unix timestamp when the order expires
@@ -489,6 +531,7 @@ export declare function calculateListingFee({ listingFeePerHour, endTimestamp, }
 /**
  * Calculates the sale tax for an order based on the sale amount.
  *
+ * @experimental
  * @param params - Parameters for calculating the sale tax
  * @param params.saleAmount - The sale amount in mARIO (as a string or number)
  * @param params.saleTaxNumerator - The numerator for sale tax calculation

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

package/package.json

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