@cowprotocol/cow-sdk 0.0.8-RC.0 → 0.0.9

package/README.md

@@ -1,13 +1,14 @@
 <p align="center">
-  <img width="400" src="https://raw.githubusercontent.com/gnosis/cow-sdk/main/docs/images/CoW.png">
+  <img width="400" src="https://raw.githubusercontent.com/cowprotocol/cow-sdk/main/docs/images/CoW.png">
 </p>
 
 # CoW protocol SDK
-[![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
 
+[![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)
+[![Coverage Status](https://coveralls.io/repos/github/cowprotocol/cow-sdk/badge.svg?branch=main)](https://coveralls.io/github/cowprotocol/cow-sdk?branch=main)
 
 > ⚠️⚠️ THE SDK IS IN Beta ⚠️⚠️
-> It is being currently develop and is a work in progress, also it's API is subjected to change. 
+> It is being currently develop and is a work in progress, also it's API is subjected to change.
 > If you experience any problems, please open an issue in Github trying to describe your problem.
 
 ### Getting started
@@ -34,17 +35,18 @@ The SDK will expose the CoW API operations (`cowSdk.cowApi`) and some convenient
 const trades = await cowSdk.cowApi.getOrders({
   owner: '0x00000000005ef87f8ca7014309ece7260bbcdaeb', // Trader
   limit: 5,
-  offset: 0
+  offset: 0,
 })
 console.log(trades)
 ```
 
 Let's see a full example on how to submit an order to CowSwap.
 
-> ⚠️ Before starting, the protocol requires you to approve the sell token before the order can be considered. 
+> ⚠️ Before starting, the protocol requires you to approve the sell token before the order can be considered.
 > For more details see https://docs.cow.fi/tutorials/how-to-submit-orders-via-the-api/1.-set-allowance-for-the-sell-token
 
 In this example, we will:
+
 - 1. **Instantiate the SDK and a wallet**: Used for signing orders
 - 2. **Get a price/fee quote from the API**: Get current market price and required protocol fee to settle your trade.
 - 3. **Sign the order using your wallet**: Only signed orders are considered by the protocol.
@@ -64,7 +66,7 @@ const cowSdk = new CowSdk(4, { signer: wallet })
 const quoteResponse = await cowSdk.cowApi.getQuote({
   kind: OrderKind.SELL, // Sell order (could also be BUY)
   sellToken: '0xc778417e063141139fce010982780140aa0cd5ab', // WETH
-  buyToken: '0x4dbcdf9b62e891a7cec5a2568c3f4faf9e8abe2b',  // USDC
+  buyToken: '0x4dbcdf9b62e891a7cec5a2568c3f4faf9e8abe2b', // USDC
   amount: '1000000000000000000', // 1 WETH
   userAddress: '0x1811be0994930fe9480eaede25165608b093ad7a', // Trader
   validTo: 2524608000,
@@ -99,14 +101,14 @@ console.log(`https://explorer.cow.fi/rinkeby/orders/${orderId}`)
 SDK also includes a Metadata API to interact with AppData documents and IPFS CIDs
 
 ```js
- const chainId = 4 // Rinkeby
- const cowSdk = new CowSdk(chainId)
- let hash = '0xa6c81f4ca727252a05b108f1742a07430f28d474d2a3492d8f325746824d22e5'
- 
- // Decode AppData document given a CID hash
- const appDataDoc = await cowSdk.metadataApi.decodeAppData(hash)
- console.log(appDataDoc)
-  /* {
+const chainId = 4 // Rinkeby
+const cowSdk = new CowSdk(chainId)
+let hash = '0xa6c81f4ca727252a05b108f1742a07430f28d474d2a3492d8f325746824d22e5'
+
+// Decode AppData document given a CID hash
+const appDataDoc = await cowSdk.metadataApi.decodeAppData(hash)
+console.log(appDataDoc)
+/* {
       "appCode": "CowSwap",
       "metadata": {
           "referrer": {
@@ -117,17 +119,87 @@ SDK also includes a Metadata API to interact with AppData documents and IPFS CID
       "version": "0.1.0"
   } */
 
-  const cid = 'QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs'
-  
-  // Decode CID hash to AppData Hex 
-  const decodedAppDataHex  = await cowSdk.metadataApi.cidToAppDataHex(cid)
-  console.log(decodedAppDataHex) //0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80
+const cid = 'QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs'
+
+// Decode CID hash to AppData Hex
+const decodedAppDataHex = await cowSdk.metadataApi.cidToAppDataHex(cid)
+console.log(decodedAppDataHex) //0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80
+
+hash = '0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80'
+
+// Decode AppData Hex to CID
+const decodedAppDataHex = await cowSdk.metadataApi.appDataHexToCid(hash)
+console.log(decodedAppDataHex) //QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs
+
+/*Create an AppData Document with empty metadata and default appCode
+  generateAppDataDoc receives as parameters: 
+    - metadata: MetadataDoc (Default: {})
+    - appCode: string (Default: 'Cowswap')
+*/
+const appDataDoc = cowSdk.metadataApi.generateAppDataDoc({})
+/* {
+      version: '0.1.0',
+      appCode: 'CowSwap',
+      metadata: {},
+    } 
+*/
+
+// Create an AppData Document with custom metadata and appCode
+const appDataDoc = cowSdk.metadataApi.generateAppDataDoc(
+  {
+    referrer: {
+      address: '0x1f5B740436Fc5935622e92aa3b46818906F416E9',
+      version: '0.1.0',
+    },
+  },
+  'CowApp'
+)
+/* {
+      version: '0.1.0',
+      appCode: 'CowApp',
+      metadata: {
+        referrer: {
+          address: '0x1f5B740436Fc5935622e92aa3b46818906F416E9',
+          version: '0.1.0',
+        },
+      },
+    } 
+*/
+
+// Upload AppDataDoc to IPFS (Pinata)
+const cowSdk = new CowSdk(4, {
+  ipfs: { pinataApiKey: 'YOUR_PINATA_API_KEY', pinataApiSecret: 'YOUR_PINATA_API_SECRET' },
+})
+
+await cowSdk.metadataApi.uploadMetadataDocToIpfs(appDataDoc)
+/* 0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80 */
+```
+
+#### Querying the Cow Subgraph
 
-  hash = '0x5ddb2c8207c10b96fac92cb934ef9ba004bc007a073c9e5b13edc422f209ed80'
+You can query the Cow Subgraph either by running some common queries exposed by the `CowSubgraphApi` or by building your own ones:
 
-  // Decode AppData Hex to CID
-  const decodedAppDataHex  = await cowSdk.metadataApi.appDataHexToCid(hash)
-  console.log(decodedAppDataHex) //QmUf2TrpSANVXdgcYfAAACe6kg551cY3rAemB7xfEMjYvs
+```js
+const chainId = 1 // Mainnet
+const cowSdk = new CowSdk(chainId)
+
+// Get Cow Protocol totals
+const { totals } = await cowSdk.cowSubgraphApi.getTotals()
+const { tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth } = totals
+console.log({ tokens, orders, traders, settlements, volumeUsd, volumeEth, feesUsd, feesEth })
+
+// Get the last 5 batches
+const query = `
+query LastBatches($n: Int!) {
+  settlements(orderBy: timestamp, orderDirection: desc, first: $n) {
+    txHash
+    timestamp
+  }
+}
+`
+const variables = { n: 5 }
+const response = await cowSdk.cowSubgraphApi.runQuery(query, variables)
+console.log(response.data.settlements)
 ```
 
 ### Install Dependencies

package/dist/CowSdk.d.ts

@@ -1,6 +1,6 @@
 import { Signer } from 'ethers';
 import { LogLevelDesc } from 'loglevel';
-import { CowApi, MetadataApi } from './api';
+import { CowApi, CowSubgraphApi, MetadataApi } from './api';
 import { SupportedChainId as ChainId } from './constants/chains';
 import { validateAppDataDocument } from './utils/appData';
 import { Context, CowContext } from './utils/context';
@@ -12,6 +12,7 @@ export declare class CowSdk<T extends ChainId> {
     context: Context;
     cowApi: CowApi;
     metadataApi: MetadataApi;
+    cowSubgraphApi: CowSubgraphApi;
     constructor(chainId: T, cowContext?: CowContext, options?: Options);
     updateChainId: (chainId: ChainId) => void;
     validateAppDataDocument: typeof validateAppDataDocument;