@alpha-arcade/sdk 0.2.9 → 0.2.10

package/dist/index.d.cts

@@ -146,6 +146,19 @@ type ProposeMatchParams = {
     /** Quantity to match in microunits */
     quantityMatched: number;
 };
+/** Parameters for amending (editing) an existing unfilled order */
+type AmendOrderParams = {
+    /** Market app ID */
+    marketAppId: number;
+    /** The escrow app ID of the order to amend */
+    escrowAppId: number;
+    /** New price in microunits (e.g. 500000 = $0.50) */
+    price: number;
+    /** New quantity in microunits (e.g. 1000000 = 1 share) */
+    quantity: number;
+    /** New slippage in microunits (default 0) */
+    slippage?: number;
+};
 /** A counterparty order to match against */
 type CounterpartyMatch = {
     /** Escrow app ID of the counterparty order */
@@ -188,6 +201,15 @@ type ProposeMatchResult = {
     /** Confirmed round number */
     confirmedRound: number;
 };
+/** Result of amending an order */
+type AmendOrderResult = {
+    /** Whether the amendment succeeded */
+    success: boolean;
+    /** Transaction IDs */
+    txIds: string[];
+    /** Confirmed round number */
+    confirmedRound: number;
+};
 /** A single entry in the orderbook (one price level, one order) */
 type OrderbookEntry = {
     /** Price in microunits (e.g. 500000 = $0.50) */
@@ -400,6 +422,19 @@ declare class AlphaClient {
      * @returns Whether the match succeeded
      */
     proposeMatch(params: ProposeMatchParams): Promise<ProposeMatchResult>;
+    /**
+     * Amends (edits) an existing unfilled order in-place.
+     *
+     * Cheaper and faster than cancel + recreate. The escrow contract adjusts
+     * collateral automatically — sends you a refund if the new value is lower,
+     * or requires extra funds if higher.
+     *
+     * Only works on orders with zero quantity filled.
+     *
+     * @param params - Amend parameters (marketAppId, escrowAppId, price, quantity, slippage?)
+     * @returns Whether the amendment succeeded
+     */
+    amendOrder(params: AmendOrderParams): Promise<AmendOrderResult>;
     /**
      * Splits USDC into equal amounts of YES and NO outcome tokens.
      *
@@ -647,4 +682,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 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 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

@@ -146,6 +146,19 @@ type ProposeMatchParams = {
     /** Quantity to match in microunits */
     quantityMatched: number;
 };
+/** Parameters for amending (editing) an existing unfilled order */
+type AmendOrderParams = {
+    /** Market app ID */
+    marketAppId: number;
+    /** The escrow app ID of the order to amend */
+    escrowAppId: number;
+    /** New price in microunits (e.g. 500000 = $0.50) */
+    price: number;
+    /** New quantity in microunits (e.g. 1000000 = 1 share) */
+    quantity: number;
+    /** New slippage in microunits (default 0) */
+    slippage?: number;
+};
 /** A counterparty order to match against */
 type CounterpartyMatch = {
     /** Escrow app ID of the counterparty order */
@@ -188,6 +201,15 @@ type ProposeMatchResult = {
     /** Confirmed round number */
     confirmedRound: number;
 };
+/** Result of amending an order */
+type AmendOrderResult = {
+    /** Whether the amendment succeeded */
+    success: boolean;
+    /** Transaction IDs */
+    txIds: string[];
+    /** Confirmed round number */
+    confirmedRound: number;
+};
 /** A single entry in the orderbook (one price level, one order) */
 type OrderbookEntry = {
     /** Price in microunits (e.g. 500000 = $0.50) */
@@ -400,6 +422,19 @@ declare class AlphaClient {
      * @returns Whether the match succeeded
      */
     proposeMatch(params: ProposeMatchParams): Promise<ProposeMatchResult>;
+    /**
+     * Amends (edits) an existing unfilled order in-place.
+     *
+     * Cheaper and faster than cancel + recreate. The escrow contract adjusts
+     * collateral automatically — sends you a refund if the new value is lower,
+     * or requires extra funds if higher.
+     *
+     * Only works on orders with zero quantity filled.
+     *
+     * @param params - Amend parameters (marketAppId, escrowAppId, price, quantity, slippage?)
+     * @returns Whether the amendment succeeded
+     */
+    amendOrder(params: AmendOrderParams): Promise<AmendOrderResult>;
     /**
      * Splits USDC into equal amounts of YES and NO outcome tokens.
      *
@@ -647,4 +682,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 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 ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletPosition, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };