@clober/v2-sdk 0.0.2-a → 0.0.2

package/dist/types/signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../src/signature.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EAIT,iBAAiB,EAGlB,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,SAAS,EAAa,MAAM,mBAAmB,CAAA;AAIxD,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAkDxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,eAAe,YACjB,SAAS,WACT,SAAS,GAAG,iBAAiB,SAC/B,KAAK,MAAM,EAAE,UACZ,MAAM,YACJ;IACR,MAAM,EAAE,MAAM,CAAA;CACf,KACA,QAAQ,eAAe,CAyFzB,CAAA"}

package/dist/types/type.d.ts

@@ -0,0 +1,34 @@
+import { Account } from 'viem';
+import { CHAIN_IDS } from './constants/chain';
+import { Currency } from './model/currency';
+import { Depth } from './model/depth';
+export { CHAIN_IDS } from './constants/chain';
+export { Currency } from './model/currency';
+export { Depth } from './model/depth';
+export { OpenOrder } from './model/open-order';
+export type Market = {
+    chainId: CHAIN_IDS;
+    quote: Currency;
+    base: Currency;
+    makerFee: number;
+    takerFee: number;
+    bids: Depth[];
+    bidBookOpen: boolean;
+    asks: Depth[];
+    askBookOpen: boolean;
+};
+export type Transaction = {
+    data: `0x${string}`;
+    gas: bigint;
+    gasPrice: bigint;
+    value: bigint;
+    to: `0x${string}`;
+    from: `0x${string}` | Account | undefined;
+};
+export type PermitSignature = {
+    deadline: bigint;
+    v: number;
+    r: `0x${string}`;
+    s: `0x${string}`;
+};
+//# sourceMappingURL=type.d.ts.map

package/dist/types/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAE9B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AAErC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,MAAM,MAAM,MAAM,GAAG;IACnB,OAAO,EAAE,SAAS,CAAA;IAClB,KAAK,EAAE,QAAQ,CAAA;IACf,IAAI,EAAE,QAAQ,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,KAAK,EAAE,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;IACpB,IAAI,EAAE,KAAK,EAAE,CAAA;IACb,WAAW,EAAE,OAAO,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,KAAK,MAAM,EAAE,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,KAAK,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,GAAG,SAAS,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;IAChB,CAAC,EAAE,KAAK,MAAM,EAAE,CAAA;CACjB,CAAA"}

package/dist/types/utils/approval.d.ts

@@ -0,0 +1,3 @@
+import { CHAIN_IDS } from '../constants/chain';
+export declare function fetchIsApprovedForAll(chainId: CHAIN_IDS, owner: `0x${string}`, rpcUrl?: string): Promise<boolean>;
+//# sourceMappingURL=approval.d.ts.map

package/dist/types/utils/approval.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"approval.d.ts","sourceRoot":"","sources":["../../../src/utils/approval.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,oBAAoB,CAAA;AA8BzD,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,SAAS,EAClB,KAAK,EAAE,KAAK,MAAM,EAAE,EACpB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC,CAWlB"}

package/dist/types/utils/book-id.d.ts

@@ -0,0 +1,2 @@
+export declare const toBookId: (inputToken: `0x${string}`, outputToken: `0x${string}`, unit: bigint) => bigint;
+//# sourceMappingURL=book-id.d.ts.map

package/dist/types/utils/book-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"book-id.d.ts","sourceRoot":"","sources":["../../../src/utils/book-id.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,QAAQ,eACP,KAAK,MAAM,EAAE,eACZ,KAAK,MAAM,EAAE,QACpB,MAAM,WAuBb,CAAA"}

package/dist/types/utils/build-transaction.d.ts

@@ -0,0 +1,5 @@
+import { SimulateContractParameters, WriteContractParameters } from 'viem';
+import { CHAIN_IDS } from '../constants/chain';
+import { Transaction } from '../type';
+export declare const buildTransaction: (chainId: CHAIN_IDS, args: WriteContractParameters | SimulateContractParameters, rpcUrl?: string) => Promise<Transaction>;
+//# sourceMappingURL=build-transaction.d.ts.map

package/dist/types/utils/build-transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-transaction.d.ts","sourceRoot":"","sources":["../../../src/utils/build-transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,0BAA0B,EAC1B,uBAAuB,EACxB,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,SAAS,EAAa,MAAM,oBAAoB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC,eAAO,MAAM,gBAAgB,YAClB,SAAS,QACZ,uBAAuB,GAAG,0BAA0B,WACjD,MAAM,KACd,QAAQ,WAAW,CAuBrB,CAAA"}

package/dist/types/utils/decimals.d.ts

@@ -0,0 +1,3 @@
+export declare const baseToQuote: (tick: bigint, base: bigint, roundingUp: boolean) => bigint;
+export declare const quoteToBase: (tick: bigint, quote: bigint, roundingUp: boolean) => bigint;
+//# sourceMappingURL=decimals.d.ts.map

package/dist/types/utils/decimals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decimals.d.ts","sourceRoot":"","sources":["../../../src/utils/decimals.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW,SAChB,MAAM,QACN,MAAM,cACA,OAAO,KAClB,MAGF,CAAA;AAED,eAAO,MAAM,WAAW,SAChB,MAAM,SACL,MAAM,cACD,OAAO,KAClB,MAGF,CAAA"}

package/dist/types/utils/market.d.ts

@@ -0,0 +1,7 @@
+import { CHAIN_IDS } from '../constants/chain';
+export declare const getMarketId: (chainId: CHAIN_IDS, tokenAddresses: `0x${string}`[]) => {
+    baseTokenAddress: `0x${string}`;
+    quoteTokenAddress: `0x${string}`;
+    marketId: string;
+};
+//# sourceMappingURL=market.d.ts.map

package/dist/types/utils/market.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"market.d.ts","sourceRoot":"","sources":["../../../src/utils/market.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,eAAO,MAAM,WAAW,YACb,SAAS,kBACF,KAAK,MAAM,EAAE,EAAE,KAC9B;IACD,gBAAgB,EAAE,KAAK,MAAM,EAAE,CAAA;IAC/B,iBAAiB,EAAE,KAAK,MAAM,EAAE,CAAA;IAChC,QAAQ,EAAE,MAAM,CAAA;CA8DjB,CAAA"}

package/dist/types/utils/math.d.ts

@@ -0,0 +1,3 @@
+export declare const divide: (x: bigint, y: bigint, roundUp: boolean) => bigint;
+export declare const lnWad: (x: bigint) => bigint;
+//# sourceMappingURL=math.d.ts.map

package/dist/types/utils/math.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../../src/utils/math.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM,MAAO,MAAM,KAAK,MAAM,WAAW,OAAO,KAAG,MAU/D,CAAA;AAED,eAAO,MAAM,KAAK,MAAO,MAAM,KAAG,MAwGjC,CAAA"}

package/dist/types/utils/prices.d.ts

@@ -0,0 +1,3 @@
+export declare const formatPrice: (price: bigint, quoteDecimals: number, baseDecimals: number) => number;
+export declare const parsePrice: (price: number, quoteDecimals: number, baseDecimals: number) => bigint;
+//# sourceMappingURL=prices.d.ts.map

package/dist/types/utils/prices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prices.d.ts","sourceRoot":"","sources":["../../../src/utils/prices.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,WAAW,UACf,MAAM,iBACE,MAAM,gBACP,MAAM,KACnB,MAMF,CAAA;AAED,eAAO,MAAM,UAAU,UACd,MAAM,iBACE,MAAM,gBACP,MAAM,KACnB,MAQF,CAAA"}

package/dist/types/utils/tick.d.ts

@@ -0,0 +1,4 @@
+export declare const invertPrice: (price: bigint) => bigint;
+export declare const fromPrice: (price: bigint) => bigint;
+export declare const toPrice: (tick: bigint) => bigint;
+//# sourceMappingURL=tick.d.ts.map

package/dist/types/utils/tick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tick.d.ts","sourceRoot":"","sources":["../../../src/utils/tick.ts"],"names":[],"mappings":"AAwBA,eAAO,MAAM,WAAW,UAAW,MAAM,KAAG,MAE3C,CAAA;AAED,eAAO,MAAM,SAAS,UAAW,MAAM,KAAG,MAMzC,CAAA;AAED,eAAO,MAAM,OAAO,SAAU,MAAM,KAAG,MAmEtC,CAAA"}

package/dist/types/utils/time.d.ts

@@ -0,0 +1,2 @@
+export declare const getDeadlineTimestampInSeconds: () => bigint;
+//# sourceMappingURL=time.d.ts.map

package/dist/types/utils/time.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time.d.ts","sourceRoot":"","sources":["../../../src/utils/time.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,6BAA6B,QAAO,MAEhD,CAAA"}

package/dist/types/utils/unit.d.ts

@@ -0,0 +1,4 @@
+import { Currency } from '../model/currency';
+import { CHAIN_IDS } from '../constants/chain';
+export declare const calculateUnit: (chainId: CHAIN_IDS, quote: Currency, rpcUrl?: string) => Promise<bigint>;
+//# sourceMappingURL=unit.d.ts.map

package/dist/types/utils/unit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unit.d.ts","sourceRoot":"","sources":["../../../src/utils/unit.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAa,MAAM,oBAAoB,CAAA;AAkBzD,eAAO,MAAM,aAAa,YACf,SAAS,SACX,QAAQ,WACN,MAAM,oBAkBhB,CAAA"}

package/dist/types/view.d.ts

@@ -0,0 +1,129 @@
+import { CHAIN_IDS } from './constants/chain';
+import { Market } from './type';
+import { OpenOrder } from './model/open-order';
+/**
+ * Get market information by chain id and token addresses
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @param token0 - token0 address
+ * @param token1 - token1 address
+ * @param options
+ * @param options.rpcUrl - RPC URL of the blockchain
+ * @returns A market {@link Market}
+ *
+ * @example
+ * import { getMarket } from '@clober/v2-sdk'
+ *
+ * const market = await getMarket(
+ *   421614,
+ *  '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *  '0x0000000000000000000000000000000000000000',
+ * )
+ */
+export declare const getMarket: (chainId: CHAIN_IDS, token0: `0x${string}`, token1: `0x${string}`, options?: {
+    rpcUrl?: string;
+}) => Promise<Market>;
+/**
+ * Calculates the expected output for a given input amount, based on the provided market data.
+ *
+ * @param chainId The chain ID of the blockchain.
+ * @param inputToken The address of the input token.
+ * @param outputToken The address of the output token.
+ * @param amountIn The amount of expected input amount. (ex 1.2 ETH -> 1.2)
+ * @param options
+ * @param options.limitPrice The maximum limit price to spend.
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns A Promise resolving to an object containing the taken amount, spend amount and result of the calculation.
+ * @example
+ * import { getExpectedOutput } from '@clober/v2-sdk'
+ *
+ * const { takenAmount, spendAmount } = await getExpectedOutput(
+ *   421614,
+ *  '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *  '0x0000000000000000000000000000000000000000',
+ *  '1000.123', // spend 1000.123 USDC
+ * )
+ */
+export declare const getExpectedOutput: (chainId: CHAIN_IDS, inputToken: `0x${string}`, outputToken: `0x${string}`, amountIn: string, options?: {
+    limitPrice?: string;
+    rpcUrl?: string;
+}) => Promise<{
+    takenAmount: string;
+    spendAmount: string;
+    result: {
+        bookId: bigint;
+        takenAmount: bigint;
+        spendAmount: bigint;
+    }[];
+}>;
+/**
+ * Calculates the expected input for a given output amount, based on the provided market data.
+ *
+ * @param chainId The chain ID of the blockchain.
+ * @param inputToken The address of the input token.
+ * @param outputToken The address of the output token.
+ * @param amountOut The amount of expected output amount. (ex 1.2 ETH -> 1.2)
+ * @param options
+ * @param options.limitPrice The maximum limit price to take.
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns A Promise resolving to an object containing the taken amount, spend amount and result of the calculation.
+ * @example
+ * import { getExpectedInput } from '@clober/v2-sdk'
+ *
+ * const { takenAmount, spendAmount } = await getExpectedInput(
+ *   421614,
+ *  '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *  '0x0000000000000000000000000000000000000000',
+ *  '0.1', // take 0.1 ETH
+ * )
+ */
+export declare const getExpectedInput: (chainId: CHAIN_IDS, inputToken: `0x${string}`, outputToken: `0x${string}`, amountOut: string, options?: {
+    limitPrice?: string;
+    rpcUrl?: string;
+}) => Promise<{
+    takenAmount: string;
+    spendAmount: string;
+    result: {
+        bookId: bigint;
+        takenAmount: bigint;
+        spendAmount: bigint;
+    }[];
+}>;
+/**
+ * Retrieves the open order with the specified ID on the given chain.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {string} id The ID of the open order.
+ * @param options
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns {Promise<OpenOrder>} Promise resolving to the open order object, or undefined if not found.
+ * @example
+ * import { getOpenOrder } from '@clober/v2-sdk'
+ *
+ * const openOrder = await getOpenOrder(
+ *   421614,
+ *  '46223845323662364279893361453861711542636620039907198451770258805035840307200'
+ * )
+ */
+export declare const getOpenOrder: (chainId: CHAIN_IDS, id: string, options?: {
+    rpcUrl?: string;
+}) => Promise<OpenOrder>;
+/**
+ * Retrieves open orders for the specified user on the given chain.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {`0x${string}`} userAddress The Ethereum address of the user.
+ * @param options
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns {Promise<OpenOrder[]>} Promise resolving to an array of open orders.
+ * @example
+ * import { getOpenOrders } from '@clober/v2-sdk'
+ *
+ * const openOrders = await getOpenOrders(
+ *   421614,
+ *  '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49'
+ * )
+ */
+export declare const getOpenOrders: (chainId: CHAIN_IDS, userAddress: `0x${string}`, options?: {
+    rpcUrl?: string;
+}) => Promise<OpenOrder[]>;
+//# sourceMappingURL=view.d.ts.map

package/dist/types/view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAI/B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,YACX,SAAS,UACV,KAAK,MAAM,EAAE,UACb,KAAK,MAAM,EAAE,YACX;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC5B,QAAQ,MAAM,CAgBhB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,iBAAiB,YACnB,SAAS,cACN,KAAK,MAAM,EAAE,eACZ,KAAK,MAAM,EAAE,YAChB,MAAM,YACN;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KACjD,QAAQ;IACT,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CACvE,CA+CA,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB,YAClB,SAAS,cACN,KAAK,MAAM,EAAE,eACZ,KAAK,MAAM,EAAE,aACf,MAAM,YACP;IAAE,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KACjD,QAAQ;IACT,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CACvE,CA+CA,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,YAAY,YACd,SAAS,MACd,MAAM,YACA;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC5B,QAAQ,SAAS,CAEnB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa,YACf,SAAS,eACL,KAAK,MAAM,EAAE,YAChB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC5B,QAAQ,SAAS,EAAE,CAErB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clober/v2-sdk",
-  "version": "0.0.2-a",
+  "version": "0.0.2",
   "description": "🛠 An SDK for building applications on top of Clober V2",
   "files": [
     "dist"
@@ -22,10 +22,11 @@
   },
   "scripts": {
     "lint": "eslint --ext .ts src --fix",
-    "docs": "typedoc --out docs src/index.ts --sort kind",
+    "docs": "npm run build-graph && typedoc --out docs src/index.ts --sort kind",
     "test": "vitest --root test --config vitest.config.ts --max-concurrency=0",
-    "clean": "rm -rf dist && rm -rf .graphclient",
-    "build": "npm run clean && npm run build:cjs && npm run build:esm+types",
+    "clean": "rm -rf dist && rm -rf src/.graphclient",
+    "build": "npm run clean && npm run build-graph && npm run build:cjs && npm run build:esm+types",
+    "build-graph": "graphclient build --dir src",
     "build:cjs": "tsc --project tsconfig.build.json --module commonjs --verbatimModuleSyntax false --outDir ./dist/cjs && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
     "build:esm+types": "tsc --project tsconfig.build.json --module es2020 --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types && echo > ./dist/esm/package.json '{\"type\":\"module\"}'"
   },
@@ -33,6 +34,7 @@
   "author": "Clober<official@clober.io>",
   "license": "MIT",
   "devDependencies": {
+    "@graphprotocol/client-cli": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^6.6.0",
     "@typescript-eslint/parser": "^6.6.0",
     "@viem/anvil": "^0.0.9",
@@ -47,6 +49,12 @@
     "vitest": "^1.4.0"
   },
   "dependencies": {
+    "@graphql-mesh/cache-localforage": "^0.97.5",
+    "@graphql-mesh/graphql": "^0.97.5",
+    "@graphql-mesh/http": "^0.98.8",
+    "@graphql-mesh/merger-bare": "^0.97.6",
+    "@graphql-mesh/utils": "^0.97.5",
+    "@whatwg-node/fetch": "^0.9.17",
     "bignumber.js": "^9.1.2",
     "viem": "^2.9.6"
   }