@alpha-arcade/sdk 0.4.0 → 0.4.2

package/dist/index.d.cts

@@ -276,6 +276,11 @@ type AggregatedOrderbook = {
     yes: AggregatedOrderbookSide;
     no: AggregatedOrderbookSide;
 };
+/**
+ * Full processed market orderbook keyed by marketAppId.
+ * Matches the REST `/get-full-orderbook` response and `orderbook_changed.orderbook`.
+ */
+type FullOrderbookSnapshot = Record<string, WsOrderbookApp>;
 /** Parameters for split shares */
 type SplitSharesParams = {
     /** Market app ID */
@@ -410,7 +415,7 @@ type OrderbookChangedEvent = {
     type: 'orderbook_changed';
     ts: number;
     marketId: string;
-    orderbook: Record<string, WsOrderbookApp>;
+    orderbook: FullOrderbookSnapshot;
 };
 /** Payload for markets_changed events (incremental diffs) */
 type MarketsChangedEvent = {
@@ -439,7 +444,7 @@ type WebSocketStreamEvent = MarketsChangedEvent | MarketChangedEvent | Orderbook
  * Provides methods for:
  * - **Trading**: Create limit/market orders, cancel orders, propose matches
  * - **Positions**: Split/merge shares, claim resolved tokens, view positions
- * - **Orderbook**: Read on-chain orderbook for any market
+ * - **Orderbook**: Read on-chain orderbooks or fetch full API-backed market snapshots
  * - **Markets**: Fetch live markets from the Alpha API
  *
  * @example
@@ -593,6 +598,17 @@ declare class AlphaClient {
      * @returns Orderbook with yes and no sides, each having bids and asks
      */
     getOrderbook(marketAppId: number): Promise<Orderbook>;
+    /**
+     * Fetches the full processed orderbook snapshot for a market from the Alpha REST API.
+     *
+     * Returns the same shape as websocket `orderbook_changed.orderbook`: a record keyed by
+     * `marketAppId`, where each value includes aggregated bids/asks plus detailed yes/no orders.
+     * Requires `apiKey`.
+     *
+     * @param marketId - The Alpha market UUID
+     * @returns Full processed market orderbook keyed by marketAppId
+     */
+    getFullOrderbookFromApi(marketId: string): Promise<FullOrderbookSnapshot>;
     /**
      * Gets open orders for a specific wallet on a market.
      *
@@ -878,4 +894,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, AlphaWebSocket, type AlphaWebSocketConfig, 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, DEFAULT_WSS_BASE_URL, type EscrowGlobalState, type Market, type MarketChangedEvent, type MarketGlobalState, type MarketOption, type MarketsChangedEvent, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookChangedEvent, type OrderbookEntry, type OrderbookSide, type Position, type ProcessMatchParams, type ProcessMatchResult, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletOrdersChangedEvent, type WalletPosition, type WebSocketStreamEvent, type WsOrderbookAggregatedEntry, type WsOrderbookApp, type WsOrderbookDetailEntry, type WsOrderbookDetailSide, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };
+export { type AggregatedOrderbook, type AggregatedOrderbookEntry, type AggregatedOrderbookSide, AlphaClient, type AlphaClientConfig, AlphaWebSocket, type AlphaWebSocketConfig, 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, DEFAULT_WSS_BASE_URL, type EscrowGlobalState, type FullOrderbookSnapshot, type Market, type MarketChangedEvent, type MarketGlobalState, type MarketOption, type MarketsChangedEvent, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookChangedEvent, type OrderbookEntry, type OrderbookSide, type Position, type ProcessMatchParams, type ProcessMatchResult, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletOrdersChangedEvent, type WalletPosition, type WebSocketStreamEvent, type WsOrderbookAggregatedEntry, type WsOrderbookApp, type WsOrderbookDetailEntry, type WsOrderbookDetailSide, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };

package/dist/index.d.ts

@@ -276,6 +276,11 @@ type AggregatedOrderbook = {
     yes: AggregatedOrderbookSide;
     no: AggregatedOrderbookSide;
 };
+/**
+ * Full processed market orderbook keyed by marketAppId.
+ * Matches the REST `/get-full-orderbook` response and `orderbook_changed.orderbook`.
+ */
+type FullOrderbookSnapshot = Record<string, WsOrderbookApp>;
 /** Parameters for split shares */
 type SplitSharesParams = {
     /** Market app ID */
@@ -410,7 +415,7 @@ type OrderbookChangedEvent = {
     type: 'orderbook_changed';
     ts: number;
     marketId: string;
-    orderbook: Record<string, WsOrderbookApp>;
+    orderbook: FullOrderbookSnapshot;
 };
 /** Payload for markets_changed events (incremental diffs) */
 type MarketsChangedEvent = {
@@ -439,7 +444,7 @@ type WebSocketStreamEvent = MarketsChangedEvent | MarketChangedEvent | Orderbook
  * Provides methods for:
  * - **Trading**: Create limit/market orders, cancel orders, propose matches
  * - **Positions**: Split/merge shares, claim resolved tokens, view positions
- * - **Orderbook**: Read on-chain orderbook for any market
+ * - **Orderbook**: Read on-chain orderbooks or fetch full API-backed market snapshots
  * - **Markets**: Fetch live markets from the Alpha API
  *
  * @example
@@ -593,6 +598,17 @@ declare class AlphaClient {
      * @returns Orderbook with yes and no sides, each having bids and asks
      */
     getOrderbook(marketAppId: number): Promise<Orderbook>;
+    /**
+     * Fetches the full processed orderbook snapshot for a market from the Alpha REST API.
+     *
+     * Returns the same shape as websocket `orderbook_changed.orderbook`: a record keyed by
+     * `marketAppId`, where each value includes aggregated bids/asks plus detailed yes/no orders.
+     * Requires `apiKey`.
+     *
+     * @param marketId - The Alpha market UUID
+     * @returns Full processed market orderbook keyed by marketAppId
+     */
+    getFullOrderbookFromApi(marketId: string): Promise<FullOrderbookSnapshot>;
     /**
      * Gets open orders for a specific wallet on a market.
      *
@@ -878,4 +894,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, AlphaWebSocket, type AlphaWebSocketConfig, 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, DEFAULT_WSS_BASE_URL, type EscrowGlobalState, type Market, type MarketChangedEvent, type MarketGlobalState, type MarketOption, type MarketsChangedEvent, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookChangedEvent, type OrderbookEntry, type OrderbookSide, type Position, type ProcessMatchParams, type ProcessMatchResult, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletOrdersChangedEvent, type WalletPosition, type WebSocketStreamEvent, type WsOrderbookAggregatedEntry, type WsOrderbookApp, type WsOrderbookDetailEntry, type WsOrderbookDetailSide, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };
+export { type AggregatedOrderbook, type AggregatedOrderbookEntry, type AggregatedOrderbookSide, AlphaClient, type AlphaClientConfig, AlphaWebSocket, type AlphaWebSocketConfig, 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, DEFAULT_WSS_BASE_URL, type EscrowGlobalState, type FullOrderbookSnapshot, type Market, type MarketChangedEvent, type MarketGlobalState, type MarketOption, type MarketsChangedEvent, type MergeSharesParams, type OpenOrder, type OrderSide, type Orderbook, type OrderbookChangedEvent, type OrderbookEntry, type OrderbookSide, type Position, type ProcessMatchParams, type ProcessMatchResult, type ProposeMatchParams, type ProposeMatchResult, type SplitMergeResult, type SplitSharesParams, type WalletOrdersChangedEvent, type WalletPosition, type WebSocketStreamEvent, type WsOrderbookAggregatedEntry, type WsOrderbookApp, type WsOrderbookDetailEntry, type WsOrderbookDetailSide, calculateFee, calculateFeeFromTotal, calculateMatchingOrders, checkAssetOptIn, decodeGlobalState, getEscrowGlobalState, getLiveMarketsFromApi, getMarketFromApi, getMarketGlobalState, getMarketOnChain, getMarketsOnChain };

package/dist/index.js

@@ -2244,6 +2244,18 @@ var getWalletOrdersFromApi = async (config, walletAddress) => {
   }
   return allOrders;
 };
+var getFullOrderbookFromApi = async (config, marketId) => {
+  if (!config.apiKey) {
+    throw new Error("apiKey is required for API-based orderbook fetching. Retrieve an API key from the Alpha Arcade platform via the Account page and pass it to the client.");
+  }
+  const baseUrl = config.apiBaseUrl ?? DEFAULT_API_BASE_URL;
+  const url = `${baseUrl}/get-full-orderbook?marketId=${encodeURIComponent(marketId)}`;
+  const response = await fetch(url, { headers: { "x-api-key": config.apiKey } });
+  if (!response.ok) {
+    throw new Error(`Alpha API error: ${response.status} ${response.statusText}`);
+  }
+  return response.json();
+};
 
 // src/modules/trading.ts
 var extractEscrowAppId = async (algodClient, indexerClient, targetTxId) => {
@@ -3250,6 +3262,19 @@ var AlphaClient = class {
   async getOrderbook(marketAppId) {
     return getOrderbook(this.config, marketAppId);
   }
+  /**
+   * Fetches the full processed orderbook snapshot for a market from the Alpha REST API.
+   *
+   * Returns the same shape as websocket `orderbook_changed.orderbook`: a record keyed by
+   * `marketAppId`, where each value includes aggregated bids/asks plus detailed yes/no orders.
+   * Requires `apiKey`.
+   *
+   * @param marketId - The Alpha market UUID
+   * @returns Full processed market orderbook keyed by marketAppId
+   */
+  async getFullOrderbookFromApi(marketId) {
+    return getFullOrderbookFromApi(this.config, marketId);
+  }
   /**
    * Gets open orders for a specific wallet on a market.
    *
@@ -3424,7 +3449,7 @@ var AlphaWebSocket = class {
   }
   /** Query a server property (e.g. "heartbeat", "limits") */
   getProperty(property) {
-    return this.sendRequest({ method: "GET_PROPERTY", property });
+    return this.sendRequest({ method: "GET_PROPERTY", params: [property] });
   }
   // ============================================
   // Lifecycle
@@ -3524,9 +3549,10 @@ var AlphaWebSocket = class {
       this.send({ method: "PONG" });
       return;
     }
-    if (msg.requestId && this.pendingRequests.has(msg.requestId)) {
-      const req = this.pendingRequests.get(msg.requestId);
-      this.pendingRequests.delete(msg.requestId);
+    const responseId = typeof msg.id === "string" ? msg.id : typeof msg.requestId === "string" ? msg.requestId : null;
+    if (responseId && this.pendingRequests.has(responseId)) {
+      const req = this.pendingRequests.get(responseId);
+      this.pendingRequests.delete(responseId);
       clearTimeout(req.timer);
       req.resolve(msg);
       return;
@@ -3543,10 +3569,10 @@ var AlphaWebSocket = class {
     }
   }
   sendSubscribe(stream, params) {
-    this.send({ method: "SUBSCRIBE", stream, ...params });
+    this.send({ method: "SUBSCRIBE", params: [{ stream, ...params }] });
   }
   sendUnsubscribe(stream, params) {
-    this.send({ method: "UNSUBSCRIBE", stream, ...params });
+    this.send({ method: "UNSUBSCRIBE", params: [{ stream, ...params }] });
   }
   sendRequest(payload, timeoutMs = 1e4) {
     const requestId = crypto.randomUUID();
@@ -3558,10 +3584,10 @@ var AlphaWebSocket = class {
       this.pendingRequests.set(requestId, { resolve, reject, timer });
       if (!this.connected) {
         this.connect().then(() => {
-          this.send({ ...payload, requestId });
+          this.send({ ...payload, id: requestId });
         }).catch(reject);
       } else {
-        this.send({ ...payload, requestId });
+        this.send({ ...payload, id: requestId });
       }
     });
   }
@@ -3576,7 +3602,7 @@ var AlphaWebSocket = class {
   startHeartbeat() {
     this.stopHeartbeat();
     this.heartbeatTimer = setInterval(() => {
-      this.send({ type: "ping" });
+      this.send({ method: "PING" });
     }, this.heartbeatIntervalMs);
   }
   stopHeartbeat() {