@ar.io/sdk 3.24.0 → 4.0.0-alpha.1

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

@@ -1,568 +0,0 @@
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { AOProcess, AoSigner, Logger } from '../node/index.js';
-import { AoMessageResult, WalletAddress } from '../types/common.js';
-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';
-    quantity?: string;
-    price?: string;
-    expirationTime?: string;
-    minimumPrice?: string;
-    decreaseInterval?: string;
-}
-/**
- * Intent structure - matches Lua Intent type
- * @experimental
- */
-export interface MarketplaceIntent {
-    intentId: string;
-    initiator: string;
-    action: string;
-    status: 'pending' | 'active' | 'settling' | 'completed' | 'resolved' | 'failed';
-    createdAt: number;
-    ttl?: number;
-    resolvedAt?: number;
-    completedAt?: number;
-    failureReason?: string;
-    orderParams: MarketplaceOrderIntentParams;
-    antProcessId: string;
-}
-/**
- * Fee information structure for calculating order costs
- * @experimental
- */
-export interface MarketplaceFeeInfo {
-    listingFeePerHour: string;
-    saleTaxNumerator: number;
-    saleTaxDenominator: number;
-}
-/**
- * Intent statistics structure
- * @experimental
- */
-export interface MarketplaceIntentStats {
-    total: number;
-    byStatus: Record<string, number>;
-    byType: Record<string, number>;
-    byAction: Record<string, number>;
-}
-/**
- * Activity information structure
- * @experimental
- */
-export interface MarketplaceActivityInfo {
-    totalOrders: number;
-    activeOrders: number;
-    readyForSettlement: number;
-    executedOrders: number;
-    cancelledOrders: number;
-    expiredOrders: number;
-    listedOrders: number;
-}
-/**
- * Marketplace information structure
- * @experimental
- */
-export interface MarketplaceInfo {
-    totalPairs: number;
-    accruedFees: string;
-    arioTokenProcess: string;
-}
-/**
- * Info response structure from the marketplace
- * @experimental
- */
-export interface InfoResponse {
-    name: string;
-    processId: string;
-    activity: MarketplaceActivityInfo;
-    intents: MarketplaceIntentStats;
-    ucm: MarketplaceInfo;
-    whitelistedModules: string[];
-    fees: MarketplaceFeeInfo;
-}
-/**
- * Parameters for creating an intent (Create-Order action is assumed)
- * @experimental
- */
-export interface CreateIntentParams {
-    antId: string;
-    orderType: string;
-    quantity: string;
-    price: string;
-    expirationTime: string;
-    minimumPrice?: string;
-    decreaseInterval?: string;
-}
-/**
- * Parameters for paginated intent queries
- * @experimental
- */
-export interface GetPaginatedIntentsParams {
-    cursor?: string;
-    limit?: number;
-    sortBy?: string;
-    sortOrder?: 'asc' | 'desc';
-    filters?: Record<string, string>;
-}
-/**
- * Parameters for creating an order using internal ARIO balance
- * @experimental
- */
-export interface CreateOrderParams {
-    swapToken: string;
-    quantity: string;
-    orderType?: 'fixed' | 'dutch' | 'english';
-    price?: string;
-    expirationTime?: string;
-    minimumPrice?: string;
-    decreaseInterval?: string;
-    transferDenomination?: string;
-}
-/**
- * Parameters for getting orders with flexible selectors
- * @experimental
- */
-export interface GetOrdersParams extends GetPaginatedIntentsParams {
-    status?: 'all' | 'listed' | 'completed' | 'active' | 'ready-for-settlement' | 'executed' | 'cancelled' | 'expired';
-    ids?: string[];
-    dominantToken?: string;
-    swapToken?: string;
-}
-/**
- * Individual order structure returned from Get-Orders and Get-Order handlers
- * @experimental
- */
-export interface Order {
-    id: string;
-    creator: string;
-    quantity: string;
-    originalQuantity: string;
-    token: string;
-    dominantToken: string;
-    swapToken: string;
-    dateCreated: number;
-    price?: string;
-    expirationTime?: number;
-    orderType: 'fixed' | 'dutch' | 'english';
-    status: 'active' | 'executed' | 'cancelled' | 'ready-for-settlement' | 'expired';
-    minimumPrice?: string;
-    decreaseInterval?: string;
-    decreaseStep?: string;
-    sender?: string;
-    receiver?: string;
-    endedAt?: number;
-    bids?: Record<string, boolean>;
-}
-/**
- * Marketplace balance information for a wallet address
- * @experimental
- */
-export interface MarketplaceBalance {
-    address: WalletAddress;
-    balance: string;
-    lockedBalance: string;
-    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>>;
-    getIntent(intentId: string): Promise<MarketplaceIntent>;
-    getIntentByANTId(antId: string): Promise<MarketplaceIntent>;
-    getPaginatedOrders(params: GetOrdersParams): Promise<PaginationResult<Order>>;
-    getOrder(orderId: string): Promise<Order>;
-    getOrderByANTId(antId: string): Promise<Order>;
-    getPaginatedMarketplaceBalances(params: PaginationParams<MarketplaceBalance>): Promise<PaginationResult<MarketplaceBalance>>;
-    getMarketplaceBalance({ address, }: {
-        address: WalletAddress;
-    }): Promise<MarketplaceBalance>;
-    /**
-     * Get all user assets including intents, orders, balances, and ANT IDs
-     * @param params - Parameters including address and ARIO process ID
-     * @returns User assets including intents, orders, balances, and ANT IDs
-     */
-    getUserAssets({ address, arioProcessId, }: {
-        address: WalletAddress;
-        arioProcessId: string;
-    }): Promise<{
-        intents: MarketplaceIntent[];
-        orders: Order[];
-        balances: MarketplaceBalance;
-        antIds: string[];
-    }>;
-}
-/**
- * Common fields for create-intent progress events
- * @experimental
- */
-export interface CreateIntentEventData {
-    name: string;
-    antId: string;
-    orderType: 'fixed' | 'dutch' | 'english';
-    price: string;
-    expirationTime: number;
-}
-/**
- * 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';
-    intent: MarketplaceIntent;
-}
-/**
- * Common fields for transfer-ant progress events
- * @experimental
- */
-export interface TransferAntEventData {
-    name: string;
-    antId: string;
-    intentId: string;
-    marketplaceProcessId: string;
-}
-/**
- * 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';
-    transferResult: AoMessageResult<Record<string, string | number | boolean | null>>;
-}
-/**
- * Progress event emitted when an error occurs during the workflow
- * @experimental
- */
-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
- * @experimental
- */
-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
- * @experimental
- */
-export type ListNameForSaleProgressEvent = CreatingIntentProgressEvent | IntentCreatedProgressEvent | TransferringAntProgressEvent | AntTransferredProgressEvent | ListNameForSaleErrorEvent | ListNameForSaleCompleteEvent;
-/**
- * Timeout and retry options for listNameForSale status checks and polling.
- * Used when checking for intent (e.g. getIntentByANTId), transfer confirmation, and order listing.
- * @experimental
- */
-export interface ListNameForSaleTimeoutOptions {
-    /** Max retries when polling for intent, transfer confirmation, or order listing. Default 5. */
-    maxRetries?: number;
-    /** Base interval in ms for exponential backoff between status polls / retries. Wait time is base * 2^attempt. Default 1000. */
-    statusPollIntervalMs?: number;
-}
-/**
- * Write interface for the ArNS marketplace
- * @experimental
- */
-export interface AoArNSMarketplaceWrite {
-    createIntent(params: CreateIntentParams): Promise<AoMessageResult<MarketplaceIntent>>;
-    cancelOrder(orderId: string): Promise<AoMessageResult>;
-    settleAuction(params: {
-        orderId: string;
-        dominantToken?: string;
-        swapToken?: string;
-    }): Promise<AoMessageResult>;
-    depositArIO(params: {
-        amount: string;
-    }): Promise<AoMessageResult>;
-    withdrawArIO(params: {
-        amount: string;
-    }): Promise<AoMessageResult>;
-    /**
-     * Push ANT intent resolution to the marketplace
-     * @param intentId - The intent ID to push resolution for
-     * @returns Message result
-     */
-    pushANTIntentResolution(intentId: string): Promise<AoMessageResult>;
-    /**
-     * List a name for sale on the marketplace
-     * @param params - Parameters including name, expiration time, price, type, wallet address, and optional auction parameters
-     * @param timeoutOptions - Optional retries and wait times for intent, transfer, and order listing status polling
-     * @returns Result containing intent, order, ANT transfer result, and any error
-     */
-    listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, onProgress, }: {
-        name: string;
-        expirationTime: number;
-        price: string;
-        type: 'fixed' | 'dutch' | 'english';
-        walletAddress: WalletAddress;
-        minimumPrice?: string;
-        decreaseInterval?: string;
-        onProgress?: (event: ListNameForSaleProgressEvent) => void;
-    }, timeoutOptions?: ListNameForSaleTimeoutOptions): Promise<{
-        intent: MarketplaceIntent;
-        order: Order | null;
-        antTransferResult: AoMessageResult<Record<string, string | number | boolean | null>> | null;
-        error: Error | null;
-    }>;
-    /**
-     * Create an order using internal ARIO balance
-     * @param params - Order creation parameters
-     * @returns Message result with the created order
-     */
-    createOrder(params: CreateOrderParams): Promise<AoMessageResult<Order>>;
-    /**
-     * Buy a fixed price ANT
-     * @param params - Parameters including ANT ID
-     * @returns Message result with the order
-     */
-    buyFixedPriceANT(params: {
-        antId: string;
-    }): Promise<AoMessageResult<Order>>;
-    /**
-     * Buy a Dutch auction ANT
-     * @param params - Parameters including ANT ID
-     * @returns Message result with the order
-     */
-    buyDutchAuctionANT(params: {
-        antId: string;
-    }): Promise<AoMessageResult<Order>>;
-    /**
-     * Place a bid on an English auction
-     * @param params - Parameters including ANT ID and bid amount
-     * @returns Message result
-     */
-    bidOnANTEnglishAuction(params: {
-        antId: string;
-        bidAmount: string;
-    }): Promise<AoMessageResult>;
-    /**
-     * Settle an expired English auction
-     * @param params - Parameters including ANT ID
-     * @returns Message result
-     */
-    settleANTEnglishAuction(params: {
-        antId: string;
-    }): Promise<AoMessageResult>;
-}
-/**
- * Read-only client for the ArNS marketplace
- * @experimental
- */
-export declare class ArNSMarketplaceRead implements AoArNSMarketplaceRead {
-    protected process: AOProcess;
-    protected logger: Logger;
-    constructor({ process, logger, }: {
-        process: AOProcess;
-        logger?: Logger;
-    });
-    getInfo(): Promise<InfoResponse>;
-    getPaginatedIntents({ cursor, limit, sortBy, sortOrder, filters, }?: GetPaginatedIntentsParams): Promise<PaginationResult<MarketplaceIntent>>;
-    getIntent(intentId: string): Promise<MarketplaceIntent>;
-    getIntentByANTId(antId: string): Promise<MarketplaceIntent>;
-    /**
-     * Get orders with flexible selectors
-     * @param params - Parameters for filtering and pagination
-     * @returns Orders matching the criteria
-     */
-    getPaginatedOrders(params?: GetOrdersParams): Promise<PaginationResult<Order>>;
-    /**
-     * Get a single order by ID
-     * @param orderId - The order ID to fetch
-     * @returns The order if found
-     */
-    getOrder(orderId: string): Promise<Order>;
-    getOrderByANTId(antId: string): Promise<Order>;
-    getPaginatedMarketplaceBalances(params: PaginationParams<MarketplaceBalance>): Promise<PaginationResult<MarketplaceBalance>>;
-    /**
-     * Get ARIO balance for an address in the marketplace
-     */
-    getMarketplaceBalance({ address, }: {
-        address: WalletAddress;
-    }): Promise<MarketplaceBalance>;
-    getUserAssets({ address, arioProcessId, }: {
-        address: WalletAddress;
-        arioProcessId: string;
-    }): Promise<{
-        intents: MarketplaceIntent[];
-        orders: Order[];
-        balances: MarketplaceBalance;
-        antIds: string[];
-    }>;
-}
-/**
- * Write client for the ArNS marketplace
- * @experimental
- */
-export declare class ArNSMarketplaceWrite extends ArNSMarketplaceRead implements AoArNSMarketplaceWrite {
-    protected process: AOProcess;
-    protected signer: AoSigner;
-    protected ario: AoARIOWrite;
-    constructor({ process, signer, ario, logger, }: {
-        process: AOProcess;
-        signer: AoSigner;
-        ario: AoARIOWrite;
-        logger?: Logger;
-    });
-    /**
-     * Deposit ARIO to the marketplace (simulates Credit-Notice from ARIO token process)
-     * Returns the message ID for verification
-     */
-    depositArIO(params: {
-        amount: string;
-    }): Promise<AoMessageResult>;
-    /**
-     * Withdraw ARIO from the marketplace back to user
-     */
-    withdrawArIO(params: {
-        amount: string;
-    }): Promise<AoMessageResult>;
-    createIntent({ antId, orderType, quantity, price, expirationTime, minimumPrice, decreaseInterval, }: CreateIntentParams): Promise<AoMessageResult<MarketplaceIntent>>;
-    pushANTIntentResolution(intentId: string): Promise<AoMessageResult>;
-    settleAuction(params: {
-        orderId: string;
-        dominantToken?: string;
-        swapToken?: string;
-    }): Promise<AoMessageResult>;
-    listNameForSale({ name, expirationTime, price, type, walletAddress, minimumPrice, decreaseInterval, onProgress, }: {
-        name: string;
-        expirationTime: number;
-        price: string;
-        type: 'fixed' | 'dutch' | 'english';
-        walletAddress: WalletAddress;
-        minimumPrice?: string;
-        decreaseInterval?: string;
-        onProgress?: (event: ListNameForSaleProgressEvent) => void;
-    }, timeoutOptions?: ListNameForSaleTimeoutOptions): Promise<{
-        intent: MarketplaceIntent;
-        order: Order | null;
-        antTransferResult: AoMessageResult<Record<string, string | number | boolean | null>> | null;
-        error: Error | null;
-    }>;
-    cancelOrder(orderId: string): Promise<AoMessageResult>;
-    createOrder({ swapToken, quantity, orderType, price, expirationTime, minimumPrice, decreaseInterval, transferDenomination, }: CreateOrderParams): Promise<AoMessageResult<Order>>;
-    buyFixedPriceANT(params: {
-        antId: string;
-    }): Promise<AoMessageResult<Order>>;
-    buyDutchAuctionANT(params: {
-        antId: string;
-    }): Promise<AoMessageResult<Order>>;
-    /**
-     * Place a bid on an English auction
-     * Note: This requires you to have sufficient ARIO balance in the marketplace
-     */
-    bidOnANTEnglishAuction(params: {
-        antId: string;
-        bidAmount: string;
-    }): Promise<AoMessageResult>;
-    /**
-     * Settle an expired English auction
-     * Can be called by anyone after the auction expires
-     * The highest bidder wins the ANT
-     */
-    settleANTEnglishAuction(params: {
-        antId: string;
-    }): Promise<AoMessageResult>;
-}
-/**
- * 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
- * @returns The listing fee in mARIO as a BigInt
- *
- * @example
- * ```typescript
- * const info = await marketplace.getInfo();
- * const endTimestamp = Date.now() + 24 * 60 * 60 * 1000; // 24 hours from now
- * const listingFee = calculateListingFee({
- *   listingFeePerHour: info.fees.listingFeePerHour,
- *   endTimestamp,
- * });
- * ```
- */
-export declare function calculateListingFee({ listingFeePerHour, endTimestamp, }: {
-    listingFeePerHour: string;
-    endTimestamp: number;
-}): bigint;
-/**
- * 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
- * @param params.saleTaxDenominator - The denominator for sale tax calculation
- * @returns The sale tax in mARIO as a BigInt
- *
- * @example
- * ```typescript
- * const info = await marketplace.getInfo();
- * const saleAmount = 100000000000; // 100 ARIO in mARIO
- * const tax = calculateSaleTax({
- *   saleAmount,
- *   saleTaxNumerator: info.fees.saleTaxNumerator,
- *   saleTaxDenominator: info.fees.saleTaxDenominator,
- * });
- * ```
- */
-export declare function calculateSaleTax({ saleAmount, saleTaxNumerator, saleTaxDenominator, }: {
-    saleAmount: string | number;
-    saleTaxNumerator: number;
-    saleTaxDenominator: number;
-}): bigint;

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

@@ -1,61 +0,0 @@
-import { AoMessageResult, TransactionId, TurboArNSSigner } from '../types/common.js';
-import { AoTokenCostParams } from '../types/io.js';
-import { mARIOToken } from '../types/token.js';
-import { ILogger } from './logger.js';
-export interface TurboUnauthenticatedConfig {
-    paymentUrl?: string;
-    logger?: ILogger;
-}
-export interface TurboAuthenticatedConfig extends TurboUnauthenticatedConfig {
-    signer: TurboArNSSigner;
-}
-export declare const defaultHeaders: Record<string, string>;
-export declare function signedRequestHeadersFromSigner({ signer, nonce, }: {
-    signer: TurboArNSSigner;
-    nonce?: string;
-}): Promise<Record<string, string>>;
-export type ArNSPurchaseReceipt = AoTokenCostParams & {
-    wincQty: string;
-    mARIOQty: string;
-    usdArRate: number;
-    createdDate: string;
-};
-export interface ArNSPaymentProvider {
-    /** Returns the cost of the action in the Payment Provider's native currency (winc for Turbo) */
-    getPrice(params: AoTokenCostParams): Promise<number>;
-    getArNSPriceDetails(params: AoTokenCostParams): Promise<{
-        winc: string;
-        mARIO: mARIOToken;
-    }>;
-}
-export interface TurboInitiateArNSPurchaseParams extends AoTokenCostParams {
-    processId?: TransactionId;
-    paidBy?: string | string[];
-    referrer?: string;
-}
-export interface ArNSAuthenticatedPaymentProvider extends ArNSPaymentProvider {
-    initiateArNSPurchase(params: TurboInitiateArNSPurchaseParams): Promise<AoMessageResult<ArNSPurchaseReceipt>>;
-}
-export declare class TurboArNSPaymentFactory {
-    static init(): TurboArNSPaymentProviderUnauthenticated;
-    static init({ paymentUrl, logger, }: TurboUnauthenticatedConfig & {
-        signer?: TurboArNSSigner;
-    }): TurboArNSPaymentProviderUnauthenticated;
-    static init({ signer, paymentUrl, logger, }: TurboAuthenticatedConfig): TurboArNSPaymentProviderAuthenticated;
-}
-export declare class TurboArNSPaymentProviderUnauthenticated implements ArNSPaymentProvider {
-    protected readonly paymentUrl: string;
-    protected readonly logger: ILogger;
-    constructor({ paymentUrl, logger, }: TurboUnauthenticatedConfig);
-    getArNSPriceDetails({ intent, name, quantity, type, years, }: AoTokenCostParams): Promise<{
-        winc: string;
-        mARIO: mARIOToken;
-    }>;
-    getPrice(params: AoTokenCostParams): Promise<number>;
-}
-export declare class TurboArNSPaymentProviderAuthenticated extends TurboArNSPaymentProviderUnauthenticated implements ArNSAuthenticatedPaymentProvider {
-    private readonly signer;
-    constructor({ signer, ...restConfig }: TurboAuthenticatedConfig);
-    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/node/index.d.ts

@@ -1,20 +0,0 @@
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export { ArweaveSigner, ArconnectSigner } from '@dha-team/arbundles';
-export * from '../types/index.js';
-export * from '../common/index.js';
-export * from '../constants.js';
-export * from '../utils/index.js';