Merge pull request #17 from compolabs/feat/1113-new-orderbook-contract

[1113] New orderbook contract

.github/workflows/publish.yml

@@ -5,25 +5,34 @@ on:
       - main
 jobs:
   build:
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout Code
       - uses: actions/checkout@v4
-      # Setup .npmrc file to publish to npm
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Set up Node.js
       - uses: actions/setup-node@v4
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
-        run: npm install
-
-      - name: Build package
-        run: npm run build
+        run: pnpm install
 
       - name: Lint and Test
-        run: npm run lint
+        run: pnpm run lint
+
+      - name: Build package
+        run: pnpm run build
 
       - name: Publish to npm
-        run: npm publish --access=public
+        run: pnpm publish --access=public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -26,3 +26,5 @@ dist-ssr
 dist
 coverage
 .env
+
+package-lock.json

README.md

@@ -40,16 +40,16 @@ const spark = new Spark({
 Below is a list of all the available methods in the spark-orderbook-ts-sdk. These methods enable interaction with spot market:
 
 1. **setActiveWallet(wallet?: WalletLocked | WalletUnlocked)** - Updates the active wallet used in the library.
-2. **createSpotOrder(baseToken: Asset, quoteToken: Asset, size: string, price: string)** - Creates a spot order with the specified parameters.
-3. **cancelSpotOrder(orderId: string)** - Cancels a specified spot order.
-4. **matchSpotOrders(sellOrderId: string, buyOrderId: string)** - Matches a sell order with a buy order.
+2. **createOrder(baseToken: Asset, quoteToken: Asset, size: string, price: string)** - Creates an order with the specified parameters.
+3. **cancelOrder(orderId: string)** - Cancels a specified order.
+4. **matchOrders(sellOrderId: string, buyOrderId: string)** - Matches a sell order with a buy order.
 5. **mintToken(token: Asset, amount: string)** - Mints the specified amount of a token.
-6. **fetchSpotMarkets(limit: number)** - Retrieves a list of spot markets up to the specified limit.
-7. **fetchSpotMarketPrice(baseToken: Asset)** - Fetches the current market price for a given spot market token.
-8. **fetchSpotOrders(params: FetchOrdersParams)** - Fetches spot orders based on the specified parameters.
-9. **fetchSpotTrades(params: FetchTradesParams)** - Retrieves trades for spot markets based on provided parameters.
-10. **fetchSpotVolume()** - Retrieves the trading volume for spot markets.
-11. **fetchSpotOrderById(orderId: string)** - Retrieves details of a specific spot order by its ID.
+6. **fetchMarkets(limit: number)** - Retrieves a list of markets up to the specified limit.
+7. **fetchMarketPrice(baseToken: Asset)** - Fetches the current market price for a given market token.
+8. **fetchOrders(params: FetchOrdersParams)** - Fetches orders based on the specified parameters.
+9. **fetchTrades(params: FetchTradesParams)** - Retrieves trades for markets based on provided parameters.
+10. **fetchVolume()** - Retrieves the trading volume for markets.
+11. **fetchOrderById(orderId: string)** - Retrieves details of a specific order by its ID.
 12. **fetchWalletBalance(asset: Asset)** - Fetches the balance of a specified asset in the wallet.
 13. **getProviderWallet()** - Retrieves the wallet associated with the provider.
 14. **getProvider()** - Retrieves the provider used by the library.

examples/index.ts

@@ -19,4 +19,4 @@ const spark = new SparkOrderbook({
   wallet,
 });
 
-spark.fetchSpotMarkets(1).then(console.log);
+spark.fetchMarkets(1).then(console.log);