@gardenfi/orderbook 2.5.3-beta.0 → 2.5.3-beta.2

package/dist/src/lib/constants/asset.types.d.ts

@@ -0,0 +1,37 @@
+import { Network } from '@gardenfi/utils';
+import { Config } from './asset';
+
+export declare enum BlockchainType {
+    bitcoin = "bitcoin",
+    evm = "evm",
+    solana = "solana",
+    starknet = "starknet",
+    sui = "sui"
+}
+export type AssetCommon = {
+    name: string;
+    decimals: number;
+    symbol: string;
+    chain: Chain;
+    logo?: string;
+    atomicSwapAddress: string;
+};
+export type AssetToken = AssetCommon & {
+    tokenAddress: string;
+};
+export type Asset = AssetToken;
+export type Chain = keyof typeof Config;
+export type ChainsByNetwork<T extends Network> = {
+    [K in keyof typeof Config]: (typeof Config)[K]['network'] extends T ? K : never;
+}[keyof typeof Config];
+export type MainnetOnlyChains = ChainsByNetwork<Network.MAINNET>;
+export type TestnetOnlyChains = ChainsByNetwork<Network.TESTNET>;
+export type LocalnetOnlyChains = ChainsByNetwork<Network.LOCALNET>;
+export type ChainsByBlockchainType<T extends BlockchainType> = {
+    [K in keyof typeof Config]: (typeof Config)[K]['type'] extends T ? K : never;
+}[keyof typeof Config];
+export type EVMChains = ChainsByBlockchainType<BlockchainType.evm>;
+export type BitcoinChains = ChainsByBlockchainType<BlockchainType.bitcoin>;
+export type SolanaChains = ChainsByBlockchainType<BlockchainType.solana>;
+export type StarknetChains = ChainsByBlockchainType<BlockchainType.starknet>;
+export type SuiChains = ChainsByBlockchainType<BlockchainType.sui>;

package/dist/src/lib/constants/localnetConstants.d.ts

@@ -0,0 +1,47 @@
+import { Chain as viemChain } from 'viem';
+
+export declare const StarknetLocalnet: viemChain;
+export declare const ArbitrumLocalnet: viemChain;
+export declare const EthereumLocalnet: viemChain;
+export declare const SOLSolanaLocalnetAsset: {
+    name: string;
+    decimals: number;
+    symbol: string;
+    atomicSwapAddress: string;
+    tokenAddress: string;
+};
+export declare const bitcoinRegtestAsset: {
+    name: string;
+    decimals: number;
+    symbol: string;
+    atomicSwapAddress: string;
+    tokenAddress: string;
+};
+export declare const WBTCArbitrumLocalnetAsset: {
+    name: string;
+    decimals: number;
+    symbol: string;
+    atomicSwapAddress: string;
+    tokenAddress: string;
+};
+export declare const WBTCEthereumLocalnetAsset: {
+    name: string;
+    decimals: number;
+    symbol: string;
+    atomicSwapAddress: string;
+    tokenAddress: string;
+};
+export declare const STRKStarknetLocalnetAsset: {
+    name: string;
+    decimals: number;
+    symbol: string;
+    atomicSwapAddress: string;
+    tokenAddress: string;
+};
+export declare const ETHStarknetLocalnetAsset: {
+    name: string;
+    decimals: number;
+    symbol: string;
+    atomicSwapAddress: string;
+    tokenAddress: string;
+};

package/dist/src/lib/constants/utils.d.ts

@@ -0,0 +1,15 @@
+import { Asset } from './asset.types';
+
+/** Strip meta keys network & type from a chain object */
+type StripMeta<T> = Omit<T, 'network' | 'type'>;
+type ChainKeyOf<T extends Record<string, any>> = Extract<keyof T, string>;
+type TokenNoChain = Omit<Asset, 'chain'>;
+/** For a chain object T[C], produce a token map where each token is Asset<C> */
+type WithChainForChainObj<ChainObj extends Record<string, TokenNoChain>> = {
+    readonly [TokenKey in keyof ChainObj]: Asset;
+};
+export type AssetsType<T extends Record<string, any>> = {
+    readonly [C in ChainKeyOf<T>]: WithChainForChainObj<StripMeta<T[C]>>;
+};
+export declare function buildAssetsWithChain<T extends Record<string, any>>(cfg: T): AssetsType<T>;
+export {};

package/dist/src/lib/orderStatus/orderStatus.d.ts

@@ -0,0 +1,14 @@
+import { OrderStatus } from '../constants/asset';
+import { Order } from '../orderbook/orderbook.types';
+
+export declare const ParseOrderStatus: (order: Order) => OrderStatus;
+export declare const isDeadlinePassed: (date: Date, tillHours?: number) => boolean;
+export declare const isCompleted: (order: Order) => boolean;
+export declare enum OrderAction {
+    Initiate = "Initiate",
+    PostRefundSACP = "PostRefundSACP",
+    Redeem = "Redeem",
+    Refund = "Refund",
+    Idle = "Idle"
+}
+export declare const parseAction: (order: Order) => OrderAction.Redeem | OrderAction.Idle;

package/dist/src/lib/orderbook/orderbook.d.ts

@@ -1,5 +1,6 @@
-import { IOrderbook, CreateOrderResponse, Order, PaginatedData, CreateOrderRequest, GetOrderQueryParams } from './orderbook.types';
+import { IOrderbook, CreateOrderResponse, PaginatedData, CreateOrderRequest, GetOrderQueryParams, OrderWithStatus } from './orderbook.types';
 import { AsyncResult, IAuth, Url, Request } from '@gardenfi/utils';
+import { BlockchainType } from '../constants/asset.types';
 
 /**
  * A class that allows you to create and manage orders with the orderbook url.
@@ -9,9 +10,9 @@ import { AsyncResult, IAuth, Url, Request } from '@gardenfi/utils';
 export declare class Orderbook implements IOrderbook {
     private url;
     constructor(url: Url);
-    createOrder(order: CreateOrderRequest, auth: IAuth): AsyncResult<CreateOrderResponse, string>;
-    getOrder(id: string, request?: Request): AsyncResult<Order, string>;
-    getOrders(queryParams: GetOrderQueryParams, request?: Request): AsyncResult<PaginatedData<Order>, string>;
+    createOrder<T extends BlockchainType>(order: CreateOrderRequest, auth: IAuth): AsyncResult<CreateOrderResponse<T>, string>;
+    getOrder(id: string, request?: Request): AsyncResult<OrderWithStatus, string>;
+    getOrders(queryParams: GetOrderQueryParams, request?: Request): AsyncResult<PaginatedData<OrderWithStatus>, string>;
     /**
      * Subscribe to orders
      * @param account - The account of the order
@@ -21,5 +22,5 @@ export declare class Orderbook implements IOrderbook {
      * @param paginationConfig - The pagination configuration
      * @returns {Promise<() => void>} A promise that resolves to the unsubscribe function.
      */
-    subscribeOrders(queryParams: GetOrderQueryParams, cb: (orders: PaginatedData<Order>) => Promise<void>, interval?: number, request?: Request): Promise<() => void>;
+    subscribeOrders(queryParams: GetOrderQueryParams, cb: (orders: PaginatedData<OrderWithStatus>) => Promise<void>, interval?: number, request?: Request): Promise<() => void>;
 }

package/dist/src/lib/orderbook/orderbook.types.d.ts

@@ -1,5 +1,6 @@
 import { AsyncResult, IAuth, Request } from '@gardenfi/utils';
-import { BlockchainType, Chain, OrderLifecycle } from '../asset';
+import { OrderLifecycle, OrderStatus } from '../constants/asset';
+import { BlockchainType, Chain } from '../constants/asset.types';
 import { Calldata, RawArgs, TypedData } from 'starknet';
 import { ChainAsset } from '../chainAsset/chainAsset';
 
@@ -16,14 +17,14 @@ export interface IOrderbook {
      * @param id - The create Id of the order
      * @returns {AsyncResult<Order, string>} A promise that resolves to the order.
      */
-    getOrder(id: string, request?: Request): AsyncResult<Order, string>;
+    getOrder(id: string, request?: Request): AsyncResult<OrderWithStatus, string>;
     /**
      * Get all orders from the orderbook based on the provided filters.
      * @param {GetOrdersFilters} filters - Object containing filter parameters like: `address`, `tx_hash`, `from_chain`, `to_chain`, `status` and any additional key-value pairs for query parameters.
      * @param paginationConfig - The configuration for the pagination.
      * @returns {AsyncResult<PaginatedData<Order>, string>} A promise that resolves to the orders.
      */
-    getOrders(queryParams: GetOrderQueryParams, request?: Request): AsyncResult<PaginatedData<Order>, string>;
+    getOrders(queryParams: GetOrderQueryParams, request?: Request): AsyncResult<PaginatedData<OrderWithStatus>, string>;
     /**
      * A wrapper around getOrders that polls for every provided interval and returns orders based on the provided filters.
      * @param {GetOrdersFilters} filters - The filters to get the orders for.
@@ -32,26 +33,28 @@ export interface IOrderbook {
      * @param {PaginationConfig} paginationConfig - The configuration for the pagination.
      * @returns {Promise<() => void>} A promise that resolves to a function to unsubscribe from the orders.
      */
-    subscribeOrders(queryParams: GetOrderQueryParams, cb: (orders: PaginatedData<Order>) => Promise<void>, interval?: number, request?: Request): Promise<() => void>;
+    subscribeOrders(queryParams: GetOrderQueryParams, cb: (orders: PaginatedData<OrderWithStatus>) => Promise<void>, interval?: number, request?: Request): Promise<() => void>;
 }
 export type GetOrdersFilters = {
     address?: string;
     tx_hash?: string;
     from_chain?: Chain;
     to_chain?: Chain;
+    from_owner?: string;
+    to_owner?: string;
     status?: OrderLifecycle | OrderLifecycle[];
     [key: string]: string | string[] | number | undefined;
 };
 export type GetOrderQueryParams = GetOrdersFilters & PaginationConfig;
 export type CreateOrderRequest = {
     source: {
-        asset: ChainAsset;
+        asset: string;
         owner: string;
         delegate: string | null;
         amount: string;
     };
     destination: {
-        asset: ChainAsset;
+        asset: string;
         owner: string;
         delegate: string | null;
         amount: string;
@@ -101,6 +104,9 @@ export type Order = {
     integrator: string;
     version: string;
 };
+export type OrderWithStatus = Order & {
+    status: OrderStatus;
+};
 export type AssetHTLCInfo = {
     id: string;
     htlc: {
@@ -159,7 +165,7 @@ export type BitcoinOrderResponse = BaseCreateOrderResponse & {
     amount: number;
 };
 type WithTypedData<T, D> = T & {
-    typed_data: D;
+    typed_data: D | null;
 };
 type EvmTypedData = {
     domain: Record<string, unknown>;
@@ -177,19 +183,19 @@ export type StarknetOrderResponse = WithTypedData<BaseCreateOrderResponse & {
 }, TypedData>;
 export type SolanaOrderResponse = BaseCreateOrderResponse & {
     versioned_tx: string;
+    versioned_tx_gasless: string | null;
 };
 export type SuiOrderResponse = BaseCreateOrderResponse & {
     ptb_bytes: number[];
 };
-export type CreateOrderResponse = ({
-    type: BlockchainType.evm;
-} & EvmOrderResponse) | ({
-    type: BlockchainType.bitcoin;
-} & BitcoinOrderResponse) | ({
-    type: BlockchainType.starknet;
-} & StarknetOrderResponse) | ({
-    type: BlockchainType.solana;
-} & SolanaOrderResponse) | ({
-    type: BlockchainType.sui;
-} & SuiOrderResponse);
+type OrderResponseMap = {
+    [BlockchainType.evm]: EvmOrderResponse;
+    [BlockchainType.bitcoin]: BitcoinOrderResponse;
+    [BlockchainType.starknet]: StarknetOrderResponse;
+    [BlockchainType.solana]: SolanaOrderResponse;
+    [BlockchainType.sui]: SuiOrderResponse;
+};
+export type CreateOrderResponse<T extends BlockchainType = BlockchainType> = {
+    type: T;
+} & OrderResponseMap[T];
 export {};

package/dist/src/lib/utils.d.ts

@@ -1,6 +1,6 @@
 import { Url } from '@gardenfi/utils';
 import { BaseCreateOrderResponse, CreateOrderResponse, Order, StarknetOrderResponse, EvmOrderResponse, BitcoinOrderResponse, SolanaOrderResponse, SuiOrderResponse } from './orderbook/orderbook.types';
-import { BlockchainType } from './asset';
+import { BlockchainType } from './constants/asset.types';
 
 /**
  * Constructs a URL with the given base URL, endpoint and parameters (query params)
@@ -40,7 +40,7 @@ export declare const isOrder: OrderResponseTypeGuard<Order>;
  * Discriminated union type guard that determines the specific order response type
  * and returns the appropriate typed response
  */
-export declare function discriminateOrderResponse(response: BaseCreateOrderResponse): CreateOrderResponse | null;
+export declare function discriminateOrderResponse(response: BaseCreateOrderResponse): CreateOrderResponse<BlockchainType.evm> | CreateOrderResponse<BlockchainType.starknet> | CreateOrderResponse<BlockchainType.bitcoin> | CreateOrderResponse<BlockchainType.solana> | CreateOrderResponse<BlockchainType.sui> | null;
 /**
  * Utility function to get the blockchain type from an order response
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gardenfi/orderbook",
-  "version": "2.5.3-beta.0",
+  "version": "2.5.3-beta.2",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",