@alpha-arcade/sdk 0.3.0 → 0.3.1

package/dist/index.d.cts

@@ -147,6 +147,18 @@ type ProposeMatchParams = {
     /** Quantity to match in microunits */
     quantityMatched: number;
 };
+/**
+ * Parameters for matching two existing limit orders (e.g. after an amend).
+ * The taker is the order placed last and pays the fee; the maker is the counterparty.
+ */
+type ProcessMatchParams = {
+    /** Market app ID */
+    marketAppId: number;
+    /** Maker escrow app ID (existing order — was on the book first) */
+    makerEscrowAppId: number;
+    /** Taker escrow app ID (existing order — placed last, pays the fee) */
+    takerEscrowAppId: number;
+};
 /** Parameters for amending (editing) an existing unfilled order */
 type AmendOrderParams = {
     /** Market app ID */
@@ -202,6 +214,15 @@ type ProposeMatchResult = {
     /** Confirmed round number */
     confirmedRound: number;
 };
+/** Result of processing a match between two existing orders */
+type ProcessMatchResult = {
+    /** Whether the match succeeded */
+    success: boolean;
+    /** Transaction IDs */
+    txIds: string[];
+    /** Confirmed round number */
+    confirmedRound: number;
+};
 /** Result of amending an order */
 type AmendOrderResult = {
     /** Whether the amendment succeeded */
@@ -210,6 +231,10 @@ type AmendOrderResult = {
     txIds: string[];
     /** Confirmed round number */
     confirmedRound: number;
+    /** Total quantity matched against counterparty orders (if matching was performed) */
+    matchedQuantity?: number;
+    /** Volume-weighted average fill price in microunits (if any matches) */
+    matchedPrice?: number;
 };
 /** A single entry in the orderbook (one price level, one order) */
 type OrderbookEntry = {
@@ -423,6 +448,17 @@ declare class AlphaClient {
      * @returns Whether the match succeeded
      */
     proposeMatch(params: ProposeMatchParams): Promise<ProposeMatchResult>;
+    /**
+     * Matches two existing limit orders (no create-escrow in the group).
+     *
+     * Calls the market app's process_potential_match(maker, taker). Use this
+     * after amending an order: the amended order is the taker (pays the fee),
+     * the counterparty is the maker.
+     *
+     * @param params - Process match params (marketAppId, makerEscrowAppId, takerEscrowAppId)
+     * @returns Whether the match succeeded
+     */
+    processMatch(params: ProcessMatchParams): Promise<ProcessMatchResult>;
     /**
      * Amends (edits) an existing unfilled order in-place.
      *
@@ -684,4 +720,4 @@ declare const getEscrowGlobalState: (indexerClient: algosdk.Indexer, escrowAppId
  */
 declare const checkAssetOptIn: (algodClient: algosdk.Algodv2, address: string, assetId: number) => Promise<boolean>;
 
-export { type AggregatedOrderbook, type AggregatedOrderbookEntry, type AggregatedOrderbookSide, AlphaClient, type AlphaClientConfig, type AmendOrderParams, type AmendOrderResult, type CancelOrderParams, type CancelOrderResult, type ClaimParams, type ClaimResult, type CounterpartyMatch, type CreateLimitOrderParams, type CreateMarketOrderParams, type CreateOrderResult, DEFAULT_API_BASE_URL, DEFAULT_MARKET_CREATOR_ADDRESS, type EscrowGlobalState, type Market, type MarketGlobalState, type MarketOption, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookEntry, type OrderbookSide, type Position, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletPosition, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };
+export { type AggregatedOrderbook, type AggregatedOrderbookEntry, type AggregatedOrderbookSide, AlphaClient, type AlphaClientConfig, type AmendOrderParams, type AmendOrderResult, type CancelOrderParams, type CancelOrderResult, type ClaimParams, type ClaimResult, type CounterpartyMatch, type CreateLimitOrderParams, type CreateMarketOrderParams, type CreateOrderResult, DEFAULT_API_BASE_URL, DEFAULT_MARKET_CREATOR_ADDRESS, type EscrowGlobalState, type Market, type MarketGlobalState, type MarketOption, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookEntry, type OrderbookSide, type Position, type ProcessMatchParams, type ProcessMatchResult, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletPosition, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };

package/dist/index.d.ts

@@ -147,6 +147,18 @@ type ProposeMatchParams = {
     /** Quantity to match in microunits */
     quantityMatched: number;
 };
+/**
+ * Parameters for matching two existing limit orders (e.g. after an amend).
+ * The taker is the order placed last and pays the fee; the maker is the counterparty.
+ */
+type ProcessMatchParams = {
+    /** Market app ID */
+    marketAppId: number;
+    /** Maker escrow app ID (existing order — was on the book first) */
+    makerEscrowAppId: number;
+    /** Taker escrow app ID (existing order — placed last, pays the fee) */
+    takerEscrowAppId: number;
+};
 /** Parameters for amending (editing) an existing unfilled order */
 type AmendOrderParams = {
     /** Market app ID */
@@ -202,6 +214,15 @@ type ProposeMatchResult = {
     /** Confirmed round number */
     confirmedRound: number;
 };
+/** Result of processing a match between two existing orders */
+type ProcessMatchResult = {
+    /** Whether the match succeeded */
+    success: boolean;
+    /** Transaction IDs */
+    txIds: string[];
+    /** Confirmed round number */
+    confirmedRound: number;
+};
 /** Result of amending an order */
 type AmendOrderResult = {
     /** Whether the amendment succeeded */
@@ -210,6 +231,10 @@ type AmendOrderResult = {
     txIds: string[];
     /** Confirmed round number */
     confirmedRound: number;
+    /** Total quantity matched against counterparty orders (if matching was performed) */
+    matchedQuantity?: number;
+    /** Volume-weighted average fill price in microunits (if any matches) */
+    matchedPrice?: number;
 };
 /** A single entry in the orderbook (one price level, one order) */
 type OrderbookEntry = {
@@ -423,6 +448,17 @@ declare class AlphaClient {
      * @returns Whether the match succeeded
      */
     proposeMatch(params: ProposeMatchParams): Promise<ProposeMatchResult>;
+    /**
+     * Matches two existing limit orders (no create-escrow in the group).
+     *
+     * Calls the market app's process_potential_match(maker, taker). Use this
+     * after amending an order: the amended order is the taker (pays the fee),
+     * the counterparty is the maker.
+     *
+     * @param params - Process match params (marketAppId, makerEscrowAppId, takerEscrowAppId)
+     * @returns Whether the match succeeded
+     */
+    processMatch(params: ProcessMatchParams): Promise<ProcessMatchResult>;
     /**
      * Amends (edits) an existing unfilled order in-place.
      *
@@ -684,4 +720,4 @@ declare const getEscrowGlobalState: (indexerClient: algosdk.Indexer, escrowAppId
  */
 declare const checkAssetOptIn: (algodClient: algosdk.Algodv2, address: string, assetId: number) => Promise<boolean>;
 
-export { type AggregatedOrderbook, type AggregatedOrderbookEntry, type AggregatedOrderbookSide, AlphaClient, type AlphaClientConfig, type AmendOrderParams, type AmendOrderResult, type CancelOrderParams, type CancelOrderResult, type ClaimParams, type ClaimResult, type CounterpartyMatch, type CreateLimitOrderParams, type CreateMarketOrderParams, type CreateOrderResult, DEFAULT_API_BASE_URL, DEFAULT_MARKET_CREATOR_ADDRESS, type EscrowGlobalState, type Market, type MarketGlobalState, type MarketOption, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookEntry, type OrderbookSide, type Position, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletPosition, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };
+export { type AggregatedOrderbook, type AggregatedOrderbookEntry, type AggregatedOrderbookSide, AlphaClient, type AlphaClientConfig, type AmendOrderParams, type AmendOrderResult, type CancelOrderParams, type CancelOrderResult, type ClaimParams, type ClaimResult, type CounterpartyMatch, type CreateLimitOrderParams, type CreateMarketOrderParams, type CreateOrderResult, DEFAULT_API_BASE_URL, DEFAULT_MARKET_CREATOR_ADDRESS, type EscrowGlobalState, type Market, type MarketGlobalState, type MarketOption, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookEntry, type OrderbookSide, type Position, type ProcessMatchParams, type ProcessMatchResult, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletPosition, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };

package/dist/index.js

@@ -2492,6 +2492,89 @@ var proposeMatch = async (config, params) => {
     confirmedRound: Number(result.confirmedRound)
   };
 };
+var processMatch = async (config, params) => {
+  const { algodClient, signer, activeAddress, usdcAssetId } = config;
+  const { marketAppId, makerEscrowAppId, takerEscrowAppId } = params;
+  const [marketState, makerAppInfo, takerAppInfo] = await Promise.all([
+    getMarketGlobalState(algodClient, marketAppId),
+    algodClient.getApplicationByID(makerEscrowAppId).do(),
+    algodClient.getApplicationByID(takerEscrowAppId).do()
+  ]);
+  const marketFeeAddress = marketState.fee_address;
+  const yesAssetId = marketState.yes_asset_id;
+  const noAssetId = marketState.no_asset_id;
+  const makerState = decodeGlobalState(
+    makerAppInfo.params?.globalState ?? makerAppInfo.params?.["global-state"] ?? []
+  );
+  const takerState = decodeGlobalState(
+    takerAppInfo.params?.globalState ?? takerAppInfo.params?.["global-state"] ?? []
+  );
+  const makerOwner = makerState.owner ?? "";
+  const takerOwner = takerState.owner ?? "";
+  const makerRemaining = (makerState.quantity ?? 0) - (makerState.quantity_filled ?? 0);
+  const takerRemaining = (takerState.quantity ?? 0) - (takerState.quantity_filled ?? 0);
+  const matchedQuantity = Math.min(makerRemaining, takerRemaining);
+  if (matchedQuantity <= 0) {
+    throw new Error("processMatch: no quantity left to match on maker or taker escrow.");
+  }
+  const signerAccount = { signer, addr: activeAddress };
+  const makerEscrowClient = new EscrowAppClient(
+    { resolveBy: "id", id: makerEscrowAppId, sender: signerAccount },
+    algodClient
+  );
+  const takerEscrowClient = new EscrowAppClient(
+    { resolveBy: "id", id: takerEscrowAppId, sender: signerAccount },
+    algodClient
+  );
+  const marketClient = new MarketAppClient(
+    { resolveBy: "id", id: marketAppId, sender: signerAccount },
+    algodClient
+  );
+  const atc = new AtomicTransactionComposer();
+  const assets = [usdcAssetId, yesAssetId, noAssetId];
+  const sendParamsWithFee = { skipSending: true, fee: algokit4.microAlgos(3e3) };
+  const sendParamsNoop = { skipSending: true, fee: algokit4.microAlgos(1e3) };
+  const matchMakerTxn = await makerEscrowClient.matchMaker(
+    { taker: takerEscrowAppId, matchQuantity: matchedQuantity },
+    {
+      assets,
+      apps: [marketAppId],
+      accounts: [takerOwner, marketFeeAddress],
+      sendParams: sendParamsWithFee
+    }
+  );
+  atc.addTransaction({ txn: matchMakerTxn.transaction, signer });
+  const matchTakerTxn = await takerEscrowClient.matchTaker(
+    { maker: makerEscrowAppId },
+    {
+      assets,
+      apps: [marketAppId],
+      accounts: [makerOwner, marketFeeAddress],
+      sendParams: sendParamsWithFee
+    }
+  );
+  atc.addTransaction({ txn: matchTakerTxn.transaction, signer });
+  const processMatchTxn = await marketClient.processPotentialMatch(
+    { maker: makerEscrowAppId, taker: takerEscrowAppId },
+    {
+      assets,
+      accounts: [makerOwner, takerOwner, marketFeeAddress],
+      sendParams: sendParamsNoop
+    }
+  );
+  atc.addTransaction({ txn: processMatchTxn.transaction, signer });
+  const doNoopTxn = await marketClient.doNoop(
+    { callNumber: 1 },
+    { sendParams: sendParamsNoop }
+  );
+  atc.addTransaction({ txn: doNoopTxn.transaction, signer });
+  const result = await atc.execute(algodClient, 4);
+  return {
+    success: true,
+    txIds: result.txIDs,
+    confirmedRound: Number(result.confirmedRound)
+  };
+};
 var amendOrder = async (config, params) => {
   const { algodClient, signer, activeAddress, usdcAssetId } = config;
   const { marketAppId, escrowAppId, price, quantity, slippage = 0 } = params;
@@ -2548,10 +2631,47 @@ var amendOrder = async (config, params) => {
   );
   atc.addTransaction({ txn: amendCall.transaction, signer });
   const result = await atc.execute(algodClient, 4);
+  const allTxIds = [...result.txIDs];
+  let lastConfirmedRound = Number(result.confirmedRound);
+  const orderbook = await getOrderbook(config, marketAppId);
+  let matchingOrders = calculateMatchingOrders(orderbook, isBuy, position === 1, quantity, price, slippage);
+  matchingOrders = matchingOrders.filter((m) => m.escrowAppId !== escrowAppId);
+  if (matchingOrders.length > 0) {
+    let quantityLeft = quantity;
+    const matchedQuantities = [];
+    const matchedPrices = [];
+    for (const m of matchingOrders) {
+      if (quantityLeft <= 0) break;
+      try {
+        const matchResult = await processMatch(config, {
+          marketAppId,
+          makerEscrowAppId: m.escrowAppId,
+          takerEscrowAppId: escrowAppId
+        });
+        allTxIds.push(...matchResult.txIds);
+        lastConfirmedRound = matchResult.confirmedRound;
+        const q = Math.min(m.quantity, quantityLeft);
+        matchedQuantities.push(q);
+        matchedPrices.push((m.price ?? price) * q);
+        quantityLeft -= q;
+      } catch (err) {
+        console.log(`Error matching order: ${JSON.stringify(err)}`);
+        break;
+      }
+    }
+    const totalMatchedQuantity = matchedQuantities.reduce((a, b) => a + b, 0);
+    const matchedPrice = totalMatchedQuantity > 0 ? Math.round(matchedPrices.reduce((a, b) => a + b, 0) / totalMatchedQuantity) : void 0;
+    return {
+      success: true,
+      txIds: allTxIds,
+      confirmedRound: lastConfirmedRound,
+      ...totalMatchedQuantity > 0 && { matchedQuantity: totalMatchedQuantity, matchedPrice }
+    };
+  }
   return {
     success: true,
-    txIds: result.txIDs,
-    confirmedRound: Number(result.confirmedRound)
+    txIds: allTxIds,
+    confirmedRound: lastConfirmedRound
   };
 };
 var splitShares = async (config, params) => {
@@ -3034,6 +3154,19 @@ var AlphaClient = class {
   async proposeMatch(params) {
     return proposeMatch(this.config, params);
   }
+  /**
+   * Matches two existing limit orders (no create-escrow in the group).
+   *
+   * Calls the market app's process_potential_match(maker, taker). Use this
+   * after amending an order: the amended order is the taker (pays the fee),
+   * the counterparty is the maker.
+   *
+   * @param params - Process match params (marketAppId, makerEscrowAppId, takerEscrowAppId)
+   * @returns Whether the match succeeded
+   */
+  async processMatch(params) {
+    return processMatch(this.config, params);
+  }
   /**
    * Amends (edits) an existing unfilled order in-place.
    *