pepay-streams-sdk 0.1.0

package/dist/marketplace/index.d.mts

@@ -0,0 +1,225 @@
+import { PublicClient, WalletClient, Address, Hex } from 'viem';
+import { d as CreateInstantOrderParams, T as TransactionResult, e as CreateVestedOrderParams, f as CreateTradableOrderParams, O as OrderInfo, g as OrderQuote } from '../index-BTG0TRJt.mjs';
+
+/**
+ * Marketplace Module
+ *
+ * Provides methods for P2P vesting marketplace:
+ * - Create orders (INSTANT, VESTED, TRADABLE)
+ * - Fill orders
+ * - Cancel orders
+ * - Order queries
+ */
+
+/**
+ * Marketplace module for P2P trading of token positions
+ */
+declare class MarketplaceModule {
+    private readonly publicClient;
+    private readonly walletClient;
+    private readonly diamondAddress;
+    constructor(publicClient: PublicClient, walletClient: WalletClient | undefined, diamondAddress: Address);
+    /**
+     * Create an INSTANT order
+     *
+     * Seller deposits tokens upfront, buyer pays and receives immediately.
+     *
+     * @example
+     * ```typescript
+     * // Approve first
+     * await sdk.approve(sellToken, amount);
+     *
+     * const result = await sdk.marketplace.createInstantOrder({
+     *   sellToken: '0x...',
+     *   sellAmount: parseEther('1000'),
+     *   payToken: zeroAddress, // Native ETH
+     *   pricePerToken: parseEther('0.001'), // 0.001 ETH per token
+     *   expiryTTL: 7 * 24 * 60 * 60, // 7 days
+     * });
+     * ```
+     */
+    createInstantOrder(params: CreateInstantOrderParams): Promise<TransactionResult>;
+    /**
+     * Create a VESTED order
+     *
+     * Seller deposits tokens that vest over time for the buyer.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.marketplace.createVestedOrder({
+     *   sellToken: '0x...',
+     *   sellAmount: parseEther('10000'),
+     *   payToken: '0x...', // USDC
+     *   pricePerToken: 1000000n, // 1 USDC (6 decimals)
+     *   vestingDuration: 365 * 24 * 60 * 60, // 1 year
+     *   cliffDuration: 30 * 24 * 60 * 60, // 30 day cliff
+     *   startMode: 'upon_fill', // Vesting starts when order is filled
+     * });
+     * ```
+     */
+    createVestedOrder(params: CreateVestedOrderParams): Promise<TransactionResult>;
+    /**
+     * Create a TRADABLE order
+     *
+     * List an unvested campaign position for sale. No upfront deposit -
+     * the position is transferred when the order is filled.
+     *
+     * @example
+     * ```typescript
+     * // Must have a position in a VestedAirdrop campaign with trading enabled
+     * const result = await sdk.marketplace.createTradableOrder({
+     *   campaignId: 10n,
+     *   pricePerToken: parseEther('0.05'), // 0.05 ETH per token
+     *   payToken: zeroAddress, // Native ETH
+     *   expiryTTL: 30 * 24 * 60 * 60, // 30 days
+     * });
+     * console.log('Order created, tx:', result.hash);
+     * ```
+     */
+    createTradableOrder(params: CreateTradableOrderParams): Promise<TransactionResult>;
+    /**
+     * Fill an order (buy)
+     *
+     * For native payment orders, send ETH as value.
+     * For token payment orders, approve the Diamond first.
+     *
+     * @example
+     * ```typescript
+     * // Get quote first
+     * const quote = await sdk.marketplace.getQuote(orderId);
+     *
+     * // Fill with native ETH
+     * const result = await sdk.marketplace.fillOrder(orderId, {
+     *   value: quote.totalPrice,
+     * });
+     *
+     * // Or fill with ERC20 (approve first)
+     * await sdk.approve(payToken, quote.totalPrice);
+     * await sdk.marketplace.fillOrder(orderId);
+     * ```
+     */
+    fillOrder(orderId: bigint, options?: {
+        value?: bigint;
+    }): Promise<TransactionResult>;
+    /**
+     * Fill an order using Permit2 (gasless token approval)
+     */
+    fillOrderWithPermit(params: {
+        orderId: bigint;
+        permit2Payload: Hex;
+    }): Promise<TransactionResult>;
+    /**
+     * Cancel an order (seller only)
+     *
+     * Returns deposited tokens to seller.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.marketplace.cancelOrder(orderId);
+     * ```
+     */
+    cancelOrder(orderId: bigint): Promise<TransactionResult>;
+    /**
+     * Expire an order (anyone can call after expiry)
+     *
+     * Returns deposited tokens to seller.
+     */
+    expireOrder(orderId: bigint): Promise<TransactionResult>;
+    /**
+     * Get order information by ID
+     *
+     * @example
+     * ```typescript
+     * const order = await sdk.marketplace.getOrder(1n);
+     * console.log('Seller:', order.seller);
+     * console.log('Price:', formatEther(order.totalPrice));
+     * console.log('Status:', order.status);
+     * ```
+     */
+    getOrder(orderId: bigint): Promise<OrderInfo>;
+    /**
+     * Get order quote (price breakdown)
+     *
+     * @example
+     * ```typescript
+     * const quote = await sdk.marketplace.getQuote(orderId);
+     * console.log('Total price:', formatEther(quote.totalPrice));
+     * console.log('Protocol fee:', formatEther(quote.protocolFee));
+     * ```
+     */
+    getQuote(orderId: bigint): Promise<OrderQuote>;
+    /**
+     * Get detailed quote for filling an order
+     */
+    getQuoteFill(orderId: bigint): Promise<{
+        payToken: Address;
+        price: bigint;
+        feeBps: number;
+        feeAmount: bigint;
+        feeReceiver: Address;
+        proceeds: bigint;
+        seller: Address;
+        sellToken: Address;
+        sellAmount: bigint;
+        deliveryKind: number;
+        escrowFlushedToRouting: boolean;
+    }>;
+    /**
+     * Get next order ID (also indicates total orders created)
+     */
+    getNextOrderId(): Promise<bigint>;
+    /**
+     * Get orders by seller with pagination
+     */
+    getOrdersBySeller(seller: Address, offset?: number, limit?: number): Promise<OrderInfo[]>;
+    /**
+     * Get orders for a campaign
+     */
+    getOrdersForCampaign(campaignId: bigint): Promise<{
+        activeOrderId: bigint;
+        historicalOrderIds: bigint[];
+    }>;
+    /**
+     * Get active order for a campaign
+     */
+    getActiveOrderForCampaign(campaignId: bigint): Promise<bigint>;
+    /**
+     * Preview available amount to sell for a campaign
+     */
+    previewAvailableToSell(campaignId: bigint): Promise<{
+        futureUnlockable: bigint;
+        claimableNow: bigint;
+        asOf: number;
+    }>;
+    /**
+     * Get all open orders
+     */
+    getOpenOrders(limit?: number): Promise<OrderInfo[]>;
+    /**
+     * Check if trading is allowed for a campaign
+     */
+    isTradingEnabled(campaignId: bigint): Promise<boolean>;
+    /**
+     * Lock trading for a campaign (creator only)
+     *
+     * Prevents new orders from being created for this campaign.
+     */
+    lockTrading(campaignId: bigint): Promise<TransactionResult>;
+    /**
+     * Unlock trading for a campaign (creator only)
+     */
+    unlockTrading(campaignId: bigint): Promise<TransactionResult>;
+    /**
+     * Calculate total price for a given amount at price per token
+     */
+    calculateTotalPrice(amount: bigint, pricePerToken: bigint): bigint;
+    /**
+     * Check if payment is in native token (ETH/BNB/etc)
+     */
+    isNativePayment(payToken: Address): boolean;
+    private requireWallet;
+    private parseOrderInfo;
+    private createTransactionResult;
+}
+
+export { MarketplaceModule, MarketplaceModule as default };

package/dist/marketplace/index.d.ts

@@ -0,0 +1,225 @@
+import { PublicClient, WalletClient, Address, Hex } from 'viem';
+import { d as CreateInstantOrderParams, T as TransactionResult, e as CreateVestedOrderParams, f as CreateTradableOrderParams, O as OrderInfo, g as OrderQuote } from '../index-BTG0TRJt.js';
+
+/**
+ * Marketplace Module
+ *
+ * Provides methods for P2P vesting marketplace:
+ * - Create orders (INSTANT, VESTED, TRADABLE)
+ * - Fill orders
+ * - Cancel orders
+ * - Order queries
+ */
+
+/**
+ * Marketplace module for P2P trading of token positions
+ */
+declare class MarketplaceModule {
+    private readonly publicClient;
+    private readonly walletClient;
+    private readonly diamondAddress;
+    constructor(publicClient: PublicClient, walletClient: WalletClient | undefined, diamondAddress: Address);
+    /**
+     * Create an INSTANT order
+     *
+     * Seller deposits tokens upfront, buyer pays and receives immediately.
+     *
+     * @example
+     * ```typescript
+     * // Approve first
+     * await sdk.approve(sellToken, amount);
+     *
+     * const result = await sdk.marketplace.createInstantOrder({
+     *   sellToken: '0x...',
+     *   sellAmount: parseEther('1000'),
+     *   payToken: zeroAddress, // Native ETH
+     *   pricePerToken: parseEther('0.001'), // 0.001 ETH per token
+     *   expiryTTL: 7 * 24 * 60 * 60, // 7 days
+     * });
+     * ```
+     */
+    createInstantOrder(params: CreateInstantOrderParams): Promise<TransactionResult>;
+    /**
+     * Create a VESTED order
+     *
+     * Seller deposits tokens that vest over time for the buyer.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.marketplace.createVestedOrder({
+     *   sellToken: '0x...',
+     *   sellAmount: parseEther('10000'),
+     *   payToken: '0x...', // USDC
+     *   pricePerToken: 1000000n, // 1 USDC (6 decimals)
+     *   vestingDuration: 365 * 24 * 60 * 60, // 1 year
+     *   cliffDuration: 30 * 24 * 60 * 60, // 30 day cliff
+     *   startMode: 'upon_fill', // Vesting starts when order is filled
+     * });
+     * ```
+     */
+    createVestedOrder(params: CreateVestedOrderParams): Promise<TransactionResult>;
+    /**
+     * Create a TRADABLE order
+     *
+     * List an unvested campaign position for sale. No upfront deposit -
+     * the position is transferred when the order is filled.
+     *
+     * @example
+     * ```typescript
+     * // Must have a position in a VestedAirdrop campaign with trading enabled
+     * const result = await sdk.marketplace.createTradableOrder({
+     *   campaignId: 10n,
+     *   pricePerToken: parseEther('0.05'), // 0.05 ETH per token
+     *   payToken: zeroAddress, // Native ETH
+     *   expiryTTL: 30 * 24 * 60 * 60, // 30 days
+     * });
+     * console.log('Order created, tx:', result.hash);
+     * ```
+     */
+    createTradableOrder(params: CreateTradableOrderParams): Promise<TransactionResult>;
+    /**
+     * Fill an order (buy)
+     *
+     * For native payment orders, send ETH as value.
+     * For token payment orders, approve the Diamond first.
+     *
+     * @example
+     * ```typescript
+     * // Get quote first
+     * const quote = await sdk.marketplace.getQuote(orderId);
+     *
+     * // Fill with native ETH
+     * const result = await sdk.marketplace.fillOrder(orderId, {
+     *   value: quote.totalPrice,
+     * });
+     *
+     * // Or fill with ERC20 (approve first)
+     * await sdk.approve(payToken, quote.totalPrice);
+     * await sdk.marketplace.fillOrder(orderId);
+     * ```
+     */
+    fillOrder(orderId: bigint, options?: {
+        value?: bigint;
+    }): Promise<TransactionResult>;
+    /**
+     * Fill an order using Permit2 (gasless token approval)
+     */
+    fillOrderWithPermit(params: {
+        orderId: bigint;
+        permit2Payload: Hex;
+    }): Promise<TransactionResult>;
+    /**
+     * Cancel an order (seller only)
+     *
+     * Returns deposited tokens to seller.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.marketplace.cancelOrder(orderId);
+     * ```
+     */
+    cancelOrder(orderId: bigint): Promise<TransactionResult>;
+    /**
+     * Expire an order (anyone can call after expiry)
+     *
+     * Returns deposited tokens to seller.
+     */
+    expireOrder(orderId: bigint): Promise<TransactionResult>;
+    /**
+     * Get order information by ID
+     *
+     * @example
+     * ```typescript
+     * const order = await sdk.marketplace.getOrder(1n);
+     * console.log('Seller:', order.seller);
+     * console.log('Price:', formatEther(order.totalPrice));
+     * console.log('Status:', order.status);
+     * ```
+     */
+    getOrder(orderId: bigint): Promise<OrderInfo>;
+    /**
+     * Get order quote (price breakdown)
+     *
+     * @example
+     * ```typescript
+     * const quote = await sdk.marketplace.getQuote(orderId);
+     * console.log('Total price:', formatEther(quote.totalPrice));
+     * console.log('Protocol fee:', formatEther(quote.protocolFee));
+     * ```
+     */
+    getQuote(orderId: bigint): Promise<OrderQuote>;
+    /**
+     * Get detailed quote for filling an order
+     */
+    getQuoteFill(orderId: bigint): Promise<{
+        payToken: Address;
+        price: bigint;
+        feeBps: number;
+        feeAmount: bigint;
+        feeReceiver: Address;
+        proceeds: bigint;
+        seller: Address;
+        sellToken: Address;
+        sellAmount: bigint;
+        deliveryKind: number;
+        escrowFlushedToRouting: boolean;
+    }>;
+    /**
+     * Get next order ID (also indicates total orders created)
+     */
+    getNextOrderId(): Promise<bigint>;
+    /**
+     * Get orders by seller with pagination
+     */
+    getOrdersBySeller(seller: Address, offset?: number, limit?: number): Promise<OrderInfo[]>;
+    /**
+     * Get orders for a campaign
+     */
+    getOrdersForCampaign(campaignId: bigint): Promise<{
+        activeOrderId: bigint;
+        historicalOrderIds: bigint[];
+    }>;
+    /**
+     * Get active order for a campaign
+     */
+    getActiveOrderForCampaign(campaignId: bigint): Promise<bigint>;
+    /**
+     * Preview available amount to sell for a campaign
+     */
+    previewAvailableToSell(campaignId: bigint): Promise<{
+        futureUnlockable: bigint;
+        claimableNow: bigint;
+        asOf: number;
+    }>;
+    /**
+     * Get all open orders
+     */
+    getOpenOrders(limit?: number): Promise<OrderInfo[]>;
+    /**
+     * Check if trading is allowed for a campaign
+     */
+    isTradingEnabled(campaignId: bigint): Promise<boolean>;
+    /**
+     * Lock trading for a campaign (creator only)
+     *
+     * Prevents new orders from being created for this campaign.
+     */
+    lockTrading(campaignId: bigint): Promise<TransactionResult>;
+    /**
+     * Unlock trading for a campaign (creator only)
+     */
+    unlockTrading(campaignId: bigint): Promise<TransactionResult>;
+    /**
+     * Calculate total price for a given amount at price per token
+     */
+    calculateTotalPrice(amount: bigint, pricePerToken: bigint): bigint;
+    /**
+     * Check if payment is in native token (ETH/BNB/etc)
+     */
+    isNativePayment(payToken: Address): boolean;
+    private requireWallet;
+    private parseOrderInfo;
+    private createTransactionResult;
+}
+
+export { MarketplaceModule, MarketplaceModule as default };