@gardenfi/orderbook 2.5.2-beta.1 → 2.5.2

package/README.md

@@ -1,35 +1,19 @@
-# @gardenfi/orderbook
+## @gardenfi/orderbook
 
-The `@gardenfi/orderbook` package manages the orderbook for cross-chain atomic swaps. It provides APIs for creating orders, retrieving order information, managing matched orders, and subscribing to real-time order updates. The package handles order lifecycle management, pagination for large order datasets, and supports filtering orders by various criteria including user address, transaction hash, and order status.
+The `@gardenfi/orderbook` package is used to facilitate the creation of orders. It also provides functionality for listening to orders and retrieving orders created by a specific address.
 
-## Installation
+### Installation
 
 ```
-yarn add @gardenfi/orderbook
+npm install @gardenfi/orderbook
 ```
 
-## Usage
+### Usage
 
-```typescript
-import { Orderbook } from '@gardenfi/orderbook';
-import { Url } from '@gardenfi/utils';
+1. Creating an order: ([should create an order with the valid configuration](https://github.com/catalogfi/garden.js/blob/4623a0679d1948755500c7179113112a025e33f8/packages/orderbook/src/lib/orderbook.spec.ts#L61  ))
+2. Getting all orders created by an address: ([should return orders where the user is the maker](https://github.com/catalogfi/garden.js/blob/4623a0679d1948755500c7179113112a025e33f8/packages/orderbook/src/lib/orderbook.spec.ts#L79))
+3. Listening to orders: ([should update when order is created](https://github.com/catalogfi/garden.js/blob/4623a0679d1948755500c7179113112a025e33f8/packages/orderbook/src/lib/orderbook.spec.ts#L94))
 
-// Initialize the orderbook with the API URL
-const orderbook = new Orderbook(new Url('<ORDERBOOK_API>'));
+### Setup
 
-// Get matched orders for a user
-const matchedOrdersResult = await orderbook.getMatchedOrders(
-  '<USER_ADDRESS>', // user address
-  'pending', // status: 'all' | 'pending' | 'fulfilled'
-  {
-    page: 1,
-    per_page: 10,
-  },
-);
-
-if (matchedOrdersResult.ok) {
-  console.log('Matched orders:', matchedOrdersResult.val.data);
-} else {
-  console.error('Error fetching matched orders:', matchedOrdersResult.error);
-}
-```
+Both CommonJs and ES imports are supported so there is not extra setup needed to use the library. To use the orderbook simply import it (using import or require statements) and perform your logic. Make sure to use a signer if you're using the library in an environment where you do not have access to the private keys.

package/dist/index3.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var l=(e=>(e.Bitcoin="Bitcoin",e.EVM="EVM",e.Solana="Solana",e.Starknet="Starknet",e.Sui="Sui",e))(l||{}),u=(e=>(e.mainnet="mainnet",e.testnet="testnet",e.localnet="localnet",e))(u||{});const t={bitcoin:"bitcoin",bitcoin_testnet:"bitcoin_testnet",bitcoin_regtest:"bitcoin_regtest",ethereum:"ethereum",base:"base",arbitrum:"arbitrum",ethereum_sepolia:"ethereum_sepolia",arbitrum_localnet:"arbitrum_localnet",arbitrum_sepolia:"arbitrum_sepolia",ethereum_localnet:"ethereum_localnet",base_sepolia:"base_sepolia",solana:"solana",solana_testnet:"solana_testnet",solana_localnet:"solana_localnet",bera_testnet:"bera_testnet",citrea_testnet:"citrea_testnet",bera:"bera",monad_testnet:"monad_testnet",starknet:"starknet",starknet_sepolia:"starknet_sepolia",starknet_devnet:"starknet_devnet",hyperliquid_testnet:"hyperliquid_testnet",hyperliquid:"hyperliquid",unichain:"unichain",corn:"corn",botanix:"botanix",bnbchain:"bnbchain",bnbchain_testnet:"bnbchain_testnet",sui:"sui",sui_testnet:"sui_testnet",core:"core"},k=e=>!(e===t.ethereum_sepolia||e===t.bitcoin_testnet||e===t.bitcoin_regtest||e===t.arbitrum_localnet||e===t.ethereum_localnet||e===t.arbitrum_sepolia||e===t.base_sepolia||e===t.solana_testnet||e===t.solana_localnet||e===t.bera_testnet||e===t.citrea_testnet||e===t.monad_testnet||e===t.starknet_devnet||e===t.starknet_sepolia||e===t.hyperliquid_testnet||e===t.bnbchain_testnet||e===t.sui_testnet),r=e=>e===t.bitcoin||e===t.bitcoin_testnet||e===t.bitcoin_regtest,s=e=>e===t.ethereum||e===t.arbitrum||e===t.ethereum_sepolia||e===t.ethereum_localnet||e===t.arbitrum_localnet||e===t.arbitrum_sepolia||e===t.base_sepolia||e===t.base||e===t.bera_testnet||e===t.citrea_testnet||e===t.bera||e===t.monad_testnet||e===t.hyperliquid_testnet||e===t.hyperliquid||e===t.unichain||e===t.corn||e===t.botanix||e===t.bnbchain||e===t.bnbchain_testnet||e===t.core,o=e=>e===t.solana||e===t.solana_testnet||e===t.solana_localnet,i=e=>e===t.starknet||e===t.starknet_devnet||e===t.starknet_sepolia,a=e=>e===t.sui||e===t.sui_testnet,p=e=>{if(r(e))return"Bitcoin";if(s(e))return"EVM";if(o(e))return"Solana";if(i(e))return"Starknet";if(a(e))return"Sui";throw new Error("Invalid or unsupported chain")},_="0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",b=(e,n)=>s(e)&&n.toLowerCase()===_.toLowerCase(),m=(e,n)=>o(e)&&n.toLowerCase()==="primary",d=(e,n)=>a(e)&&n.toLowerCase()==="0x2::sui::sui",c=e=>b(e.chain,e.tokenAddress)||m(e.chain,e.tokenAddress)||r(e.chain)||d(e.chain,e.tokenAddress)||!i(e.chain);exports.BlockchainType=l;exports.Chains=t;exports.NativeTokenAddress=_;exports.NetworkType=u;exports.getBlockchainType=p;exports.isBitcoin=r;exports.isEVM=s;exports.isEvmNativeToken=b;exports.isMainnet=k;exports.isNativeToken=c;exports.isSolana=o;exports.isSolanaNativeToken=m;exports.isStarknet=i;exports.isSui=a;exports.isSuiNativeToken=d;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});var l=(e=>(e.Bitcoin="Bitcoin",e.EVM="EVM",e.Solana="Solana",e.Starknet="Starknet",e.Sui="Sui",e))(l||{}),u=(e=>(e.mainnet="mainnet",e.testnet="testnet",e.localnet="localnet",e))(u||{});const t={bitcoin:"bitcoin",bitcoin_testnet:"bitcoin_testnet",bitcoin_regtest:"bitcoin_regtest",ethereum:"ethereum",base:"base",arbitrum:"arbitrum",ethereum_sepolia:"ethereum_sepolia",arbitrum_localnet:"arbitrum_localnet",arbitrum_sepolia:"arbitrum_sepolia",ethereum_localnet:"ethereum_localnet",base_sepolia:"base_sepolia",solana:"solana",solana_testnet:"solana_testnet",solana_localnet:"solana_localnet",bera_testnet:"bera_testnet",citrea_testnet:"citrea_testnet",bera:"bera",monad_testnet:"monad_testnet",starknet:"starknet",starknet_sepolia:"starknet_sepolia",starknet_devnet:"starknet_devnet",hyperliquid_testnet:"hyperliquid_testnet",hyperliquid:"hyperliquid",unichain:"unichain",corn:"corn",botanix:"botanix",bnbchain:"bnbchain",bnbchain_testnet:"bnbchain_testnet",sui:"sui",sui_testnet:"sui_testnet"},k=e=>!(e===t.ethereum_sepolia||e===t.bitcoin_testnet||e===t.bitcoin_regtest||e===t.arbitrum_localnet||e===t.ethereum_localnet||e===t.arbitrum_sepolia||e===t.base_sepolia||e===t.solana_testnet||e===t.solana_localnet||e===t.bera_testnet||e===t.citrea_testnet||e===t.monad_testnet||e===t.starknet_devnet||e===t.starknet_sepolia||e===t.hyperliquid_testnet||e===t.bnbchain_testnet||e===t.sui_testnet),r=e=>e===t.bitcoin||e===t.bitcoin_testnet||e===t.bitcoin_regtest,s=e=>e===t.ethereum||e===t.arbitrum||e===t.ethereum_sepolia||e===t.ethereum_localnet||e===t.arbitrum_localnet||e===t.arbitrum_sepolia||e===t.base_sepolia||e===t.base||e===t.bera_testnet||e===t.citrea_testnet||e===t.bera||e===t.monad_testnet||e===t.hyperliquid_testnet||e===t.hyperliquid||e===t.unichain||e===t.corn||e===t.botanix||e===t.bnbchain||e===t.bnbchain_testnet,i=e=>e===t.solana||e===t.solana_testnet||e===t.solana_localnet,o=e=>e===t.starknet||e===t.starknet_devnet||e===t.starknet_sepolia,a=e=>e===t.sui||e===t.sui_testnet,p=e=>{if(r(e))return"Bitcoin";if(s(e))return"EVM";if(i(e))return"Solana";if(o(e))return"Starknet";if(a(e))return"Sui";throw new Error("Invalid or unsupported chain")},_="0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",b=(e,n)=>s(e)&&n.toLowerCase()===_.toLowerCase(),m=(e,n)=>i(e)&&n.toLowerCase()==="primary",d=(e,n)=>a(e)&&n.toLowerCase()==="0x2::sui::sui",E=e=>b(e.chain,e.tokenAddress)||m(e.chain,e.tokenAddress)||r(e.chain)||d(e.chain,e.tokenAddress)||!o(e.chain);exports.BlockchainType=l;exports.Chains=t;exports.NativeTokenAddress=_;exports.NetworkType=u;exports.getBlockchainType=p;exports.isBitcoin=r;exports.isEVM=s;exports.isEvmNativeToken=b;exports.isMainnet=k;exports.isNativeToken=E;exports.isSolana=i;exports.isSolanaNativeToken=m;exports.isStarknet=o;exports.isSui=a;exports.isSuiNativeToken=d;

package/dist/index3.js

@@ -29,9 +29,8 @@ const t = {
   bnbchain: "bnbchain",
   bnbchain_testnet: "bnbchain_testnet",
   sui: "sui",
-  sui_testnet: "sui_testnet",
-  core: "core"
-}, p = (e) => !(e === t.ethereum_sepolia || e === t.bitcoin_testnet || e === t.bitcoin_regtest || e === t.arbitrum_localnet || e === t.ethereum_localnet || e === t.arbitrum_sepolia || e === t.base_sepolia || e === t.solana_testnet || e === t.solana_localnet || e === t.bera_testnet || e === t.citrea_testnet || e === t.monad_testnet || e === t.starknet_devnet || e === t.starknet_sepolia || e === t.hyperliquid_testnet || e === t.bnbchain_testnet || e === t.sui_testnet), r = (e) => e === t.bitcoin || e === t.bitcoin_testnet || e === t.bitcoin_regtest, s = (e) => e === t.ethereum || e === t.arbitrum || e === t.ethereum_sepolia || e === t.ethereum_localnet || e === t.arbitrum_localnet || e === t.arbitrum_sepolia || e === t.base_sepolia || e === t.base || e === t.bera_testnet || e === t.citrea_testnet || e === t.bera || e === t.monad_testnet || e === t.hyperliquid_testnet || e === t.hyperliquid || e === t.unichain || e === t.corn || e === t.botanix || e === t.bnbchain || e === t.bnbchain_testnet || e === t.core, o = (e) => e === t.solana || e === t.solana_testnet || e === t.solana_localnet, a = (e) => e === t.starknet || e === t.starknet_devnet || e === t.starknet_sepolia, i = (e) => e === t.sui || e === t.sui_testnet, E = (e) => {
+  sui_testnet: "sui_testnet"
+}, p = (e) => !(e === t.ethereum_sepolia || e === t.bitcoin_testnet || e === t.bitcoin_regtest || e === t.arbitrum_localnet || e === t.ethereum_localnet || e === t.arbitrum_sepolia || e === t.base_sepolia || e === t.solana_testnet || e === t.solana_localnet || e === t.bera_testnet || e === t.citrea_testnet || e === t.monad_testnet || e === t.starknet_devnet || e === t.starknet_sepolia || e === t.hyperliquid_testnet || e === t.bnbchain_testnet || e === t.sui_testnet), r = (e) => e === t.bitcoin || e === t.bitcoin_testnet || e === t.bitcoin_regtest, s = (e) => e === t.ethereum || e === t.arbitrum || e === t.ethereum_sepolia || e === t.ethereum_localnet || e === t.arbitrum_localnet || e === t.arbitrum_sepolia || e === t.base_sepolia || e === t.base || e === t.bera_testnet || e === t.citrea_testnet || e === t.bera || e === t.monad_testnet || e === t.hyperliquid_testnet || e === t.hyperliquid || e === t.unichain || e === t.corn || e === t.botanix || e === t.bnbchain || e === t.bnbchain_testnet, o = (e) => e === t.solana || e === t.solana_testnet || e === t.solana_localnet, a = (e) => e === t.starknet || e === t.starknet_devnet || e === t.starknet_sepolia, i = (e) => e === t.sui || e === t.sui_testnet, E = (e) => {
   if (r(e)) return "Bitcoin";
   if (s(e)) return "EVM";
   if (o(e)) return "Solana";

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

@@ -63,13 +63,12 @@ export declare const Chains: {
     readonly bnbchain_testnet: "bnbchain_testnet";
     readonly sui: "sui";
     readonly sui_testnet: "sui_testnet";
-    readonly core: "core";
 };
 export type Chain = keyof typeof Chains;
 export type EvmChain = keyof Omit<typeof Chains, 'bitcoin' | 'bitcoin_testnet' | 'bitcoin_regtest' | 'solana' | 'solana_testnet' | 'solana_localnet' | 'starknet' | 'starknet_devnet' | 'starknet_sepolia' | 'sui' | 'sui_testnet'>;
-export declare const isMainnet: (chain: Chain) => chain is "bitcoin" | "ethereum" | "base" | "arbitrum" | "solana" | "bera" | "starknet" | "hyperliquid" | "unichain" | "corn" | "botanix" | "bnbchain" | "sui" | "core";
+export declare const isMainnet: (chain: Chain) => chain is "bitcoin" | "ethereum" | "base" | "arbitrum" | "solana" | "bera" | "starknet" | "hyperliquid" | "unichain" | "corn" | "botanix" | "bnbchain" | "sui";
 export declare const isBitcoin: (chain: Chain) => chain is "bitcoin" | "bitcoin_testnet" | "bitcoin_regtest";
-export declare const isEVM: (chain: Chain) => chain is "ethereum" | "base" | "arbitrum" | "ethereum_sepolia" | "arbitrum_localnet" | "arbitrum_sepolia" | "ethereum_localnet" | "base_sepolia" | "bera_testnet" | "citrea_testnet" | "bera" | "monad_testnet" | "hyperliquid_testnet" | "hyperliquid" | "unichain" | "corn" | "botanix" | "bnbchain" | "bnbchain_testnet" | "core";
+export declare const isEVM: (chain: Chain) => chain is "ethereum" | "base" | "arbitrum" | "ethereum_sepolia" | "arbitrum_localnet" | "arbitrum_sepolia" | "ethereum_localnet" | "base_sepolia" | "bera_testnet" | "citrea_testnet" | "bera" | "monad_testnet" | "hyperliquid_testnet" | "hyperliquid" | "unichain" | "corn" | "botanix" | "bnbchain" | "bnbchain_testnet";
 export declare const isSolana: (chain: Chain) => chain is "solana" | "solana_testnet" | "solana_localnet";
 export declare const isStarknet: (chain: Chain) => chain is "starknet" | "starknet_sepolia" | "starknet_devnet";
 export declare const isSui: (chain: Chain) => chain is "sui" | "sui_testnet";

package/package.json

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