@gardenfi/orderbook 0.1.10 → 0.2.0-beta.0

package/dist/index5.js

@@ -1,9 +1,61 @@
-const n = (e) => {
-  const r = e.status * 100 + e.initiatorAtomicSwap.swapStatus * 10 + e.followerAtomicSwap.swapStatus;
-  return r === 200 ? "user can initiate" : r === 222 ? "user can redeem" : /\d3\d/.test(`${r}`) ? "user can refund" : r === 220 ? "counterparty can initiate" : r === 224 || r === 226 ? "counterparty can redeem" : /\d\d3/.test(`${r}`) ? "counterparty can refund" : "no action can be performed";
+import { Chains as e } from "./index3.js";
+const a = {
+  id: 31338,
+  name: "Arbitrum Localnet",
+  nativeCurrency: {
+    name: "Ethereum",
+    symbol: "ETH",
+    decimals: 18
+  },
+  rpcUrls: {
+    default: {
+      http: ["http://localhost:8546/"]
+    }
+  },
+  testnet: !0
+}, s = {
+  id: 31337,
+  name: "Ethereum Localnet",
+  nativeCurrency: {
+    name: "Ethereum",
+    symbol: "ETH",
+    decimals: 18
+  },
+  rpcUrls: {
+    default: {
+      http: ["http://localhost:8545/"]
+    }
+  },
+  testnet: !0
+}, r = {
+  name: "Bitcoin Regtest",
+  decimals: 8,
+  symbol: "BTC",
+  chain: e.bitcoin_regtest,
+  atomicSwapAddress: "primary",
+  tokenAddress: "primary",
+  isToken: !0
+}, n = {
+  name: "WBTC Arbitrum Localnet",
+  decimals: 8,
+  symbol: "WBTC",
+  chain: e.arbitrum_localnet,
+  atomicSwapAddress: "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9",
+  tokenAddress: "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512",
+  isToken: !0
+}, c = {
+  name: "WBTC Ethereum Localnet",
+  decimals: 8,
+  symbol: "WBTC",
+  chain: e.ethereum_localnet,
+  atomicSwapAddress: "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512",
+  tokenAddress: "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+  isToken: !0
 };
-var t = /* @__PURE__ */ ((e) => (e.UserCanInitiate = "user can initiate", e.UserCanRedeem = "user can redeem", e.UserCanRefund = "user can refund", e.CounterpartyCanInitiate = "counterparty can initiate", e.CounterpartyCanRedeem = "counterparty can redeem", e.CounterpartyCanRefund = "counterparty can refund", e.NoAction = "no action can be performed", e))(t || {});
 export {
-  t as Actions,
-  n as parseStatus
+  a as ArbitrumLocalnet,
+  s as EthereumLocalnet,
+  n as WBTCArbitrumLocalnetAsset,
+  c as WBTCEthereumLocalnetAsset,
+  r as bitcoinRegtestAsset
 };

package/dist/index6.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t="https://api.garden.finance",e="https://orderbook-testnet.garden.finance";exports.MAINNET_ORDERBOOK_API=t;exports.TESTNET_ORDERBOOK_API=e;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={INVALID_SEND_AMOUNT:"invalid send amount",INVALID_RECEIVE_AMOUNT:"invalid receive amount",UNSUPPORTED_CHAIN:"unsupported chain",SAME_ASSET:"cannot create orderpair with the same assets",INVALID_AS_ADDRESS:"invalid atomic swap address",INVALID_TOKEN:"invalid token address",INVALID_AMOUNTS:"invalid amounts",RECEIVE_AMOUNT_GREATER:"receive amount is greater than send amount"};exports.OrderbookErrors=e;

package/dist/index6.js

@@ -1,5 +1,13 @@
-const t = "https://api.garden.finance", n = "https://orderbook-testnet.garden.finance";
+const a = {
+  INVALID_SEND_AMOUNT: "invalid send amount",
+  INVALID_RECEIVE_AMOUNT: "invalid receive amount",
+  UNSUPPORTED_CHAIN: "unsupported chain",
+  SAME_ASSET: "cannot create orderpair with the same assets",
+  INVALID_AS_ADDRESS: "invalid atomic swap address",
+  INVALID_TOKEN: "invalid token address",
+  INVALID_AMOUNTS: "invalid amounts",
+  RECEIVE_AMOUNT_GREATER: "receive amount is greater than send amount"
+};
 export {
-  t as MAINNET_ORDERBOOK_API,
-  n as TESTNET_ORDERBOOK_API
+  a as OrderbookErrors
 };

package/dist/index7.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("@catalogfi/utils"),k=require("ws"),i=typeof window<"u"&&window.WebSocket||typeof global<"u"&&global.WebSocket||typeof WebSocket<"u"&&WebSocket||k.WebSocket,o={OpenOrder:"rest.OpenOrder",UpdatedOrders:"rest.UpdatedOrders",UpdatedOrder:"rest.UpdatedOrder",WebsocketError:"rest.WebsocketError",Ping:"ping"},r=3001;class l{constructor(e){this.unsubscribe=()=>{var s;return(s=this.socket)==null?void 0:s.close()},this.url=e}subscribe(e,s){this.socket=new u(this.url),this.socket.onMsg((d,t)=>{t.type===o.UpdatedOrders?s(t.msg.orders):t.type===o.UpdatedOrder?s([t.msg.order]):t.type===o.WebsocketError&&d.close(r)}),this.socket.send("subscribe::"+e),this.socket.onClose(()=>{this.subscribe(e,s)})}}class u{constructor(e){this.socket=new i(e)}onMsg(e){this.socket.onmessage=s=>{this.pingTimeout&&clearTimeout(this.pingTimeout),this.pingTimeout=setTimeout(()=>{this.socket.close(r)},30*1e3),e(this,n.safeParseJson(s.data))}}onClose(e){this.socket.onclose=s=>{s.code===r&&e(s.reason)}}send(e){this.socket.readyState===i.OPEN?this.socket.send(e):this.socket.onopen=()=>{this.socket.send(e)}}close(e){clearTimeout(this.pingTimeout),this.socket.close(e)}}exports.OrdersSocket=l;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="https://api.garden.finance";exports.MAINNET_ORDERBOOK_API=e;

package/dist/index7.js

@@ -1,52 +1,4 @@
-import { safeParseJson as n } from "@catalogfi/utils";
-import { WebSocket as k } from "ws";
-const i = typeof window < "u" && window.WebSocket || typeof global < "u" && global.WebSocket || typeof WebSocket < "u" && WebSocket || k, o = {
-  OpenOrder: "rest.OpenOrder",
-  UpdatedOrders: "rest.UpdatedOrders",
-  UpdatedOrder: "rest.UpdatedOrder",
-  WebsocketError: "rest.WebsocketError",
-  Ping: "ping"
-}, r = 3001;
-class a {
-  constructor(e) {
-    this.unsubscribe = () => {
-      var s;
-      return (s = this.socket) == null ? void 0 : s.close();
-    }, this.url = e;
-  }
-  subscribe(e, s) {
-    this.socket = new p(this.url), this.socket.onMsg((d, t) => {
-      t.type === o.UpdatedOrders ? s(t.msg.orders) : t.type === o.UpdatedOrder ? s([t.msg.order]) : t.type === o.WebsocketError && d.close(r);
-    }), this.socket.send("subscribe::" + e), this.socket.onClose(() => {
-      this.subscribe(e, s);
-    });
-  }
-}
-class p {
-  constructor(e) {
-    this.socket = new i(e);
-  }
-  onMsg(e) {
-    this.socket.onmessage = (s) => {
-      this.pingTimeout && clearTimeout(this.pingTimeout), this.pingTimeout = setTimeout(() => {
-        this.socket.close(r);
-      }, 30 * 1e3), e(this, n(s.data));
-    };
-  }
-  onClose(e) {
-    this.socket.onclose = (s) => {
-      s.code === r && e(s.reason);
-    };
-  }
-  send(e) {
-    this.socket.readyState === i.OPEN ? this.socket.send(e) : this.socket.onopen = () => {
-      this.socket.send(e);
-    };
-  }
-  close(e) {
-    clearTimeout(this.pingTimeout), this.socket.close(e);
-  }
-}
+const n = "https://api.garden.finance";
 export {
-  a as OrdersSocket
+  n as MAINNET_ORDERBOOK_API
 };

package/dist/index8.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("siwe"),a=require("@catalogfi/utils"),o=require("./index10.cjs"),h=require("./index11.cjs"),d=require("./index6.cjs"),u=require("./index12.cjs");class m{constructor(t,i,e){this.signingStatement="I'm signing in to Catalog",this.url=new u.Url("/",t??d.MAINNET_ORDERBOOK_API),this.signer=i,this.domain=(e==null?void 0:e.domain)||"catalog.fi",this.domain.startsWith("https://")&&(this.domain=this.domain.split("https://")[1]),this.store=(e==null?void 0:e.store)??new h.MemoryStorage}verifyToken(t,i){const e=w(t);if(!e)return!1;try{const r=Math.floor(Date.now()/1e3)+120;return e.exp>r&&e.userWallet.toLowerCase()===i.toLowerCase()}catch{return!1}}async getToken(){const t=this.store.getItem(o.StoreKeys.AUTH_TOKEN);if(t&&this.verifyToken(t,this.signer.address))return t;const{message:i,signature:e}=await this.signStatement(),{token:r}=await a.Fetcher.post(this.url.endpoint("verify"),{body:JSON.stringify({message:i,signature:e})});if(!this.verifyToken(r,await this.signer.getAddress()))throw new Error("Token verification failed");return this.store.setItem(o.StoreKeys.AUTH_TOKEN,r),r}async signStatement(){if(!this.signer.provider)throw new Error("signer does not have a provider");const t=new Date,i=new Date(t.getTime()+300*1e3),{nonce:e}=await a.Fetcher.get(this.url.endpoint("nonce")),r=await this.signer.provider.getNetwork(),n=new c.SiweMessage({domain:this.domain,address:await this.signer.getAddress(),statement:this.signingStatement,nonce:e,uri:"https://"+this.domain,version:"1",chainId:+r.chainId.toString(),expirationTime:i.toISOString()}).prepareMessage(),g=await this.signer.signMessage(n);return{message:n,signature:g}}}const w=s=>{try{if(s.split(".").length<3)return;const t=s.split(".")[1];return t?JSON.parse(Buffer.from(t,"base64").toString("latin1")):void 0}catch{return}};exports.Siwe=m;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=(n,o,t)=>{const r=n.endpoint(o);return t&&Object.entries(t).forEach(([c,e])=>{e!==void 0&&r.searchParams.append(c,e.toString())}),r};exports.ConstructUrl=i;

package/dist/index8.js

@@ -1,68 +1,9 @@
-import { SiweMessage as h } from "siwe";
-import { Fetcher as o } from "@catalogfi/utils";
-import { StoreKeys as a } from "./index10.js";
-import { MemoryStorage as m } from "./index11.js";
-import { MAINNET_ORDERBOOK_API as c } from "./index6.js";
-import { Url as d } from "./index12.js";
-class v {
-  constructor(e, r, t) {
-    this.signingStatement = "I'm signing in to Catalog", this.url = new d("/", e ?? c), this.signer = r, this.domain = (t == null ? void 0 : t.domain) || "catalog.fi", this.domain.startsWith("https://") && (this.domain = this.domain.split("https://")[1]), this.store = (t == null ? void 0 : t.store) ?? new m();
-  }
-  verifyToken(e, r) {
-    const t = f(e);
-    if (!t) return !1;
-    try {
-      const i = Math.floor(Date.now() / 1e3) + 120;
-      return t.exp > i && t.userWallet.toLowerCase() === r.toLowerCase();
-    } catch {
-      return !1;
-    }
-  }
-  async getToken() {
-    const e = this.store.getItem(a.AUTH_TOKEN);
-    if (e && this.verifyToken(e, this.signer.address))
-      return e;
-    const { message: r, signature: t } = await this.signStatement(), { token: i } = await o.post(
-      this.url.endpoint("verify"),
-      {
-        body: JSON.stringify({
-          message: r,
-          signature: t
-        })
-      }
-    );
-    if (!this.verifyToken(i, await this.signer.getAddress()))
-      throw new Error("Token verification failed");
-    return this.store.setItem(a.AUTH_TOKEN, i), i;
-  }
-  async signStatement() {
-    if (!this.signer.provider)
-      throw new Error("signer does not have a provider");
-    const e = /* @__PURE__ */ new Date(), r = new Date(e.getTime() + 300 * 1e3), { nonce: t } = await o.get(this.url.endpoint("nonce")), i = await this.signer.provider.getNetwork(), n = new h({
-      domain: this.domain,
-      address: await this.signer.getAddress(),
-      statement: this.signingStatement,
-      nonce: t,
-      uri: "https://" + this.domain,
-      version: "1",
-      chainId: +i.chainId.toString(),
-      expirationTime: r.toISOString()
-    }).prepareMessage(), g = await this.signer.signMessage(n);
-    return {
-      message: n,
-      signature: g
-    };
-  }
-}
-const f = (s) => {
-  try {
-    if (s.split(".").length < 3) return;
-    const e = s.split(".")[1];
-    return e ? JSON.parse(Buffer.from(e, "base64").toString("latin1")) : void 0;
-  } catch {
-    return;
-  }
+const i = (o, e, t) => {
+  const r = o.endpoint(e);
+  return t && Object.entries(t).forEach(([c, n]) => {
+    n !== void 0 && r.searchParams.append(c, n.toString());
+  }), r;
 };
 export {
-  v as Siwe
+  i as ConstructUrl
 };

package/dist/src/index.d.ts

@@ -1,7 +1,7 @@
-export { Orderbook } from './lib/orderbook';
-export type { Order, Orders, AtomicSwap, IOrderbook, } from './lib/orderbook.types';
-export { chainToId, idToChain, orderPairGenerator } from './lib/orderpair';
-export type { Chain, EvmChain, Asset, ChainData } from './lib/asset';
-export { Chains, Assets, ChainsData, isMainnet } from './lib/asset';
-export { parseStatus, Actions } from './lib/utils';
-export { MAINNET_ORDERBOOK_API, TESTNET_ORDERBOOK_API } from './lib/api';
+export { Orderbook } from './lib/orderbook/orderbook';
+export type * from './lib/orderbook/orderbook.types';
+export type { Chain, EvmChain, Asset } from './lib/asset';
+export { Chains, isMainnet, isBitcoin, isEVM } from './lib/asset';
+export { OrdersProvider } from './lib/orders/ordersProvider';
+export type { IOrderProvider } from './lib/orders/orders.types';
+export { WBTCArbitrumLocalnetAsset, WBTCEthereumLocalnetAsset, ArbitrumLocalnet, EthereumLocalnet, bitcoinRegtestAsset, } from './lib/constants';

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

@@ -1,119 +1,43 @@
-export declare const Chains: {
-    readonly ethereum_sepolia: "ethereum_sepolia";
-    readonly ethereum: "ethereum";
-    readonly bitcoin: "bitcoin";
-    readonly bitcoin_testnet: "bitcoin_testnet";
-    readonly bitcoin_regtest: "bitcoin_regtest";
-    readonly ethereum_arbitrum: "ethereum_arbitrum";
-    readonly ethereum_arbitrumlocalnet: "ethereum_arbitrumlocalnet";
-    readonly ethereum_localnet: "ethereum_localnet";
-};
-export type Chain = keyof typeof Chains;
-export type EvmChain = keyof Omit<typeof Chains, "bitcoin" | "bitcoin_testnet" | "bitcoin_regtest">;
 export type AssetCommon = {
     name: string;
-    symbol: string;
     decimals: number;
+    symbol: string;
     chain: Chain;
-    isToken: boolean;
-    thumbnail: string;
+    logo?: string;
+    atomicSwapAddress: string;
 };
-export type AssetNative = AssetCommon;
 export type AssetToken = AssetCommon & {
-    address: string;
+    tokenAddress: string;
     isToken: true;
 };
-export type Asset = AssetToken | AssetNative;
-export declare const Assets: {
-    ethereum: {
-        WBTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            chain: "ethereum";
-            isToken: boolean;
-            thumbnail: string;
-            address: string;
-        };
-    };
-    ethereum_sepolia: {
-        WBTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            chain: "ethereum_sepolia";
-            isToken: boolean;
-            thumbnail: string;
-            address: string;
-        };
-    };
-    ethereum_arbitrumlocalnet: {
-        WBTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            chain: "ethereum_arbitrumlocalnet";
-            isToken: boolean;
-            thumbnail: string;
-            address: string;
-        };
-    };
-    ethereum_localnet: {
-        WBTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            chain: "ethereum_localnet";
-            isToken: boolean;
-            thumbnail: string;
-            address: string;
-        };
-    };
-    bitcoin: {
-        BTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            thumbnail: string;
-            chain: "bitcoin";
-            isToken: boolean;
-        };
-    };
-    bitcoin_testnet: {
-        BTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            thumbnail: string;
-            chain: "bitcoin_testnet";
-            isToken: boolean;
-        };
-    };
-    bitcoin_regtest: {
-        BTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            thumbnail: string;
-            chain: "bitcoin_regtest";
-            isToken: boolean;
-        };
-    };
-    ethereum_arbitrum: {
-        WBTC: {
-            name: string;
-            symbol: string;
-            decimals: number;
-            chain: "ethereum_arbitrum";
-            isToken: boolean;
-            thumbnail: string;
-            address: string;
-        };
+export type Asset = AssetToken;
+export declare enum NetworkType {
+    mainnet = "mainnet",
+    testnet = "testnet",
+    localnet = "localnet"
+}
+export type Network = {
+    [networkName: string]: {
+        chainId: number;
+        fillerAddresses: string[];
+        networkLogo: string;
+        explorer: string;
+        networkType: NetworkType;
+        assets?: Asset[];
     };
 };
-export type SupportedContracts = Partial<Record<Chain, string>>;
-export type ChainData = {
-    nativeAsset: Asset;
+export declare const Chains: {
+    readonly bitcoin: "bitcoin";
+    readonly bitcoin_testnet: "bitcoin_testnet";
+    readonly bitcoin_regtest: "bitcoin_regtest";
+    readonly ethereum: "ethereum";
+    readonly ethereum_arbitrum: "ethereum_arbitrum";
+    readonly ethereum_sepolia: "ethereum_sepolia";
+    readonly arbitrum_localnet: "arbitrum_localnet";
+    readonly ethereum_localnet: "ethereum_localnet";
 };
-export declare const ChainsData: Record<Chain, ChainData>;
-export declare const isMainnet: (chain: Chain) => chain is "ethereum" | "bitcoin" | "ethereum_arbitrum";
+export type Chain = keyof typeof Chains;
+export type EvmChain = keyof Omit<typeof Chains, 'bitcoin' | 'bitcoin_testnet' | 'bitcoin_regtest'>;
+export declare const isMainnet: (chain: Chain) => chain is "bitcoin" | "ethereum" | "ethereum_arbitrum";
+export declare const isBitcoin: (chain: Chain) => chain is "bitcoin" | "bitcoin_testnet" | "bitcoin_regtest";
+export declare const isEVM: (chain: Chain) => chain is "ethereum" | "ethereum_arbitrum" | "ethereum_sepolia" | "arbitrum_localnet" | "ethereum_localnet";

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

@@ -0,0 +1,8 @@
+import { Chain } from 'viem';
+import { Asset } from './asset';
+
+export declare const ArbitrumLocalnet: Chain;
+export declare const EthereumLocalnet: Chain;
+export declare const bitcoinRegtestAsset: Asset;
+export declare const WBTCArbitrumLocalnetAsset: Asset;
+export declare const WBTCEthereumLocalnetAsset: Asset;

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

@@ -2,7 +2,9 @@ export declare const OrderbookErrors: {
     INVALID_SEND_AMOUNT: string;
     INVALID_RECEIVE_AMOUNT: string;
     UNSUPPORTED_CHAIN: string;
-};
-export declare const OrderpairErrors: {
     SAME_ASSET: string;
+    INVALID_AS_ADDRESS: string;
+    INVALID_TOKEN: string;
+    INVALID_AMOUNTS: string;
+    RECEIVE_AMOUNT_GREATER: string;
 };

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

@@ -0,0 +1,44 @@
+import { AsyncResult } from '@catalogfi/utils';
+import { CreateOrder, CreateOrderConfig, IOrderbook, MatchedOrder, OrderbookConfig, PaginatedData, PaginationConfig } from './orderbook.types';
+import { OrdersProvider } from '../orders/ordersProvider';
+
+/**
+ * A class that allows you to create and manage orders with the orderbook url.
+ * @class
+ * @extends {OrdersProvider}
+ * @implements {IOrderbook}
+ */
+export declare class Orderbook extends OrdersProvider implements IOrderbook {
+    private Url;
+    private auth;
+    private walletClient;
+    /**
+     * Creates an instance of Orderbook. Does not login to the orderbook.
+     * @constructor
+     * @param {OrderbookConfig} orderbookConfig - The configuration object for the orderbook.
+     */
+    constructor(orderbookConfig: OrderbookConfig);
+    /**
+     * Initializes the orderbook as well as logs in the orderbook (fetches the auth token).
+     * @param {OrderbookConfig} orderbookConfig - The configuration object for the orderbook.
+     */
+    static init(orderbookConfig: OrderbookConfig): Promise<Orderbook>;
+    /**
+     * Creates an order
+     * @param {CreateOrderConfig} createOrderConfig - The configuration for the creating the order.
+     * @returns {string} The create order ID.
+     */
+    createOrder(createOrderConfig: CreateOrderConfig): AsyncResult<string, string>;
+    fetchOrders<T extends boolean>(matched: T, pending?: boolean, paginationConfig?: PaginationConfig): AsyncResult<PaginatedData<T extends true ? MatchedOrder : CreateOrder>, string>;
+    /**
+     * Wrapper for the subscribeOrders method in the OrdersProvider class to abstract the address parameter.
+     * @param matched - Whether to get matched or unmatched orders
+     * @param interval - The interval to poll for updates
+     * @param cb - The callback to be called when the orders are updated
+     * @param paginationConfig - The configuration for the pagination
+     * @returns {() => void} A function to unsubscribe from the order updates
+     */
+    subscribeToOrders<T extends boolean>(matched: T, interval: number, cb: (orders: PaginatedData<T extends true ? MatchedOrder : CreateOrder>) => Promise<void>, pending?: boolean, paginationConfig?: PaginationConfig): Promise<() => void>;
+    getUserOrdersCount(): AsyncResult<number, string>;
+    private validateConfig;
+}

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

@@ -0,0 +1,200 @@
+import { WalletClient } from 'viem';
+import { AsyncResult } from '@catalogfi/utils';
+import { APIResponse, IStore } from '@gardenfi/utils';
+import { Asset, Chain } from '../asset';
+import { IOrderProvider } from '../orders/orders.types';
+
+/**
+ * Configuration for creating an order
+ */
+export interface CreateOrderConfig {
+    /**
+     * The asset the user wants to send.
+     */
+    fromAsset: Asset;
+    /**
+     * The asset the user wants to receive.
+     */
+    toAsset: Asset;
+    /**
+     * The address from the which the user is sending funds from.
+     */
+    sendAddress: string;
+    /**
+     * The address at which the user wants to receive funds.
+     */
+    receiveAddress: string;
+    /**
+     * The input amount the user wants to send in it's lowest denomination
+     */
+    sendAmount: string;
+    /**
+     * The amount you receive amount
+     */
+    receiveAmount: string;
+    /**
+     * The hash of the secret the user wants to use for the swap.
+     */
+    secretHash: string;
+    /**
+     * The time lock for the swap. (current blocknumber + 48 hours)
+     * @NOTE 7200 blocks per day in ethereum.
+     * @NOTE 144 blocks per day in bitcoin.
+     */
+    timelock: number;
+    /**
+     * The nonce for the order.
+     * This is used for secret generation.
+     */
+    nonce: string;
+    /**
+     * The address of the user's btc wallet. The funds will be sent to this address in case of a redeem or refund.
+     * @NOTE This is only required if the destination chain is bitcoin.
+     */
+    btcInputAddress?: string;
+    /**
+     * The min number of confirmations required for the user before redeeming in the destination chain.
+     * @default 0
+     */
+    minDestinationConfirmations?: number;
+}
+/**
+ * Additional configuration options for the orderbook
+ *
+ */
+export type OrderbookOpts = {
+    /**
+     * The domain of your dApp. Optional.
+     */
+    domain?: string;
+    /**
+     * The store used for storing the auth token. Optional.
+     */
+    store?: IStore;
+};
+/**
+ * Interface for the configuration of an Orderbook.
+ */
+export interface OrderbookConfig {
+    url?: string;
+    walletClient: WalletClient;
+    opts?: OrderbookOpts;
+}
+/**
+ * Configuration for the orders you want to receive
+ */
+export type OrderConfig = {
+    isPending: boolean;
+    pagination?: {
+        page?: number;
+        /**
+         * default is 10
+         */
+        per_page?: number;
+    };
+};
+export interface IOrderbook extends IOrderProvider {
+    /**
+     * Creates an order
+     * @param {CreateOrderConfig} orderConfig - The configuration for the creating the order.
+     * @returns {number} The create order ID.
+     */
+    createOrder(orderConfig: CreateOrderConfig): AsyncResult<string, string>;
+    /**
+     * Wrapper for the getOrder method in the OrdersProvider class to abstract the address parameter.
+     * @param matched - Whether to get matched or unmatched orders
+     * @param paginationConfig - The pagination configuration
+     * @param pending - Whether to get pending orders
+     * @returns {AsyncResult<PaginatedData<T extends true ? MatchedOrder : CreateOrder>, string>}
+     */
+    fetchOrders<T extends boolean>(matched: T, pending?: boolean, paginationConfig?: PaginationConfig): AsyncResult<PaginatedData<T extends true ? MatchedOrder : CreateOrder>, string>;
+    /**
+     * Wrapper for the subscribeOrders method in the OrdersProvider class to abstract the address parameter.
+     * @param matched - Whether to get matched or unmatched orders
+     * @param interval - The interval to poll for updates
+     * @param cb - The callback to be called when the orders are updated
+     * @param paginationConfig - The configuration for the pagination
+     * @returns {() => void} A function to unsubscribe from the order updates
+     */
+    subscribeToOrders<T extends boolean>(matched: T, interval: number, cb: (orders: PaginatedData<T extends true ? MatchedOrder : CreateOrder>) => Promise<void>, pending?: boolean, paginationConfig?: PaginationConfig): Promise<() => void>;
+    /**
+     * Get the current orders count associated with the provided address. Used to calculate nonce for secret generation.
+     * @returns {AsyncResult<number, string>} A promise that resolves to the orders count.
+     */
+    getUserOrdersCount(): AsyncResult<number, string>;
+}
+export type DecodedAuthToken = {
+    userWallet: string;
+    exp: number;
+    iat: number;
+};
+export type Orders = {
+    unmatched: PaginatedData<CreateOrder[]>;
+    matched: PaginatedData<MatchedOrder[]>;
+};
+export type CreateOrderRequest = {
+    source_chain: string;
+    destination_chain: string;
+    source_asset: string;
+    destination_asset: string;
+    initiator_source_address: string;
+    initiator_destination_address: string;
+    source_amount: string;
+    destination_amount: string;
+    fee: string;
+    nonce: string;
+    min_destination_confirmations: number;
+    timelock: number;
+    secret_hash: string;
+    additional_data?: {
+        bitcoin_optional_recipient: string;
+    };
+};
+export type CreateOrder = CreateOrderRequest & {
+    created_at: string;
+    updated_at: string;
+    deleted_at: string | null;
+    create_id: string;
+    block_number: string;
+};
+export type Swap = {
+    created_at: string;
+    updated_at: string;
+    deleted_at: string | null;
+    swap_id: string;
+    chain: Chain;
+    asset: string;
+    initiator: string;
+    redeemer: string;
+    timelock: number;
+    filled_amount: string;
+    amount: string;
+    secret_hash: string;
+    secret: string;
+    initiate_tx_hash: string;
+    redeem_tx_hash: string;
+    refund_tx_hash: string;
+    initiate_block_number: string | null;
+    redeem_block_number: string | null;
+    refund_block_number: string | null;
+};
+export type MatchedOrder = {
+    created_at: string;
+    updated_at: string;
+    deleted_at: string | null;
+    source_swap: Swap;
+    destination_swap: Swap;
+    create_order: CreateOrder;
+};
+export type PaginatedData<T> = {
+    data: T[];
+    page: number;
+    total_pages: number;
+    total_items: number;
+    per_page: number;
+};
+export type CreateOrderResponse = APIResponse<string>;
+export type PaginationConfig = {
+    page?: number;
+    per_page?: number;
+};