@1stdex/first-sdk 1.0.0-rc.1

package/dist/types/views/market/snapshot.d.ts

@@ -0,0 +1,17 @@
+import { CHAIN_IDS } from '../../constants/chain-configs/chain';
+import { DefaultReadContractOptions, MarketSnapshot } from '../../types';
+export declare const getMarketSnapshot: ({ chainId, token0, token1, options, }: {
+    chainId: CHAIN_IDS;
+    token0: `0x${string}`;
+    token1: `0x${string}`;
+    options?: DefaultReadContractOptions & {
+        timestampInSeconds?: number;
+    };
+}) => Promise<MarketSnapshot | null>;
+export declare const getMarketSnapshots: ({ chainId, options, }: {
+    chainId: CHAIN_IDS;
+    options?: DefaultReadContractOptions & {
+        timestampInSeconds?: number;
+    };
+}) => Promise<MarketSnapshot[]>;
+//# sourceMappingURL=snapshot.d.ts.map

package/dist/types/views/market/snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../../../src/views/market/snapshot.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAOzE,eAAO,MAAM,iBAAiB,0CAK3B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,0BAA0B,GAAG;QAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxE,KAAG,QAAQ,cAAc,GAAG,IAAI,CAchC,CAAC;AAEF,eAAO,MAAM,kBAAkB,0BAG5B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,CAAC,EAAE,0BAA0B,GAAG;QAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACxE,KAAG,QAAQ,cAAc,EAAE,CAY3B,CAAC"}

package/dist/types/views/market/token.d.ts

@@ -0,0 +1,24 @@
+import { CHAIN_IDS } from '../../constants/chain-configs/chain';
+/**
+ * Retrieves the quote token address for a given chain and a pair of tokens.
+ *
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @param token0 - token0 address
+ * @param token1 - token1 address
+ * @returns {string} The address of the quote token.
+ *
+ * @example
+ * import { getQuoteToken } from '@clober/v2-sdk'
+ *
+ * const quote = await getQuoteToken({
+ *   chainId: 421614,
+ *   token0: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   token1: '0x0000000000000000000000000000000000000000',
+ * })
+ */
+export declare const getQuoteToken: ({ chainId, token0, token1, }: {
+    chainId: CHAIN_IDS;
+    token0: `0x${string}`;
+    token1: `0x${string}`;
+}) => `0x${string}`;
+//# sourceMappingURL=token.d.ts.map

package/dist/types/views/market/token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../../../src/views/market/token.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAGhE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,iCAIvB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;CACvB,KAAG,KAAK,MAAM,EAEd,CAAC"}

package/dist/types/views/open-order.d.ts

@@ -0,0 +1,41 @@
+import { CHAIN_IDS } from '../constants/chain-configs/chain';
+import { OpenOrder } from '../entities/open-order/types';
+/**
+ * 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 {@link DefaultReadContractOptions} options.
+ * @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({
+ *   chainId: 421614,
+ *   id: '46223845323662364279893361453861711542636620039907198451770258805035840307200'
+ * })
+ */
+export declare const getOpenOrder: ({ chainId, id, }: {
+    chainId: CHAIN_IDS;
+    id: 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 {@link DefaultReadContractOptions} options.
+ * @returns {Promise<OpenOrder[]>} Promise resolving to an array of open orders.
+ * @example
+ * import { getOpenOrders } from '@clober/v2-sdk'
+ *
+ * const openOrders = await getOpenOrders({
+ *   chainId: 421614,
+ *   userAddress: '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49'
+ * })
+ */
+export declare const getOpenOrders: ({ chainId, userAddress, }: {
+    chainId: CHAIN_IDS;
+    userAddress: `0x${string}`;
+}) => Promise<OpenOrder[]>;
+//# sourceMappingURL=open-order.d.ts.map

package/dist/types/views/open-order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-order.d.ts","sourceRoot":"","sources":["../../../src/views/open-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAMzD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,qBAGtB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;CACZ,KAAG,QAAQ,SAAS,CAEpB,CAAC;AACF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,8BAGvB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;CAC5B,KAAG,QAAQ,SAAS,EAAE,CAEtB,CAAC"}

package/dist/types/views/subgraph.d.ts

@@ -0,0 +1,52 @@
+import { CHAIN_IDS } from '../constants/chain-configs/chain';
+/**
+ * Get subgraph endpoint by chain id
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @returns Subgraph endpoint
+ *
+ * @example
+ * import { getSubgraphEndpoint } from '@clober/v2-sdk'
+ *
+ * const endpoint = await getSubgraphEndpoint({
+ *   chainId: 421614,
+ * })
+ */
+export declare const getSubgraphEndpoint: ({ chainId }: {
+    chainId: CHAIN_IDS;
+}) => string;
+/**
+ * Get subgraph block number by chain id
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @returns Contract addresses
+ *
+ * @example
+ * import { getContractAddresses } from '@clober/v2-sdk'
+ *
+ * const blockNumber = await getSubgraphBlockNumber({
+ *   chainId: 421614,
+ * })
+ */
+export declare const getSubgraphBlockNumber: ({ chainId, }: {
+    chainId: CHAIN_IDS;
+}) => Promise<number>;
+/**
+ * Get subgraph block number by chain id
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @returns Contract addresses
+ *
+ * @example
+ * import { getContractAddresses } from '@clober/v2-sdk'
+ *
+ * const blockNumber = await getSubgraphBlock({
+ *   chainId: 421614,
+ * })
+ */
+export declare const getSubgraphBlock: ({ chainId }: {
+    chainId: CHAIN_IDS;
+}) => Promise<{
+    blockNumber: number;
+    hash: string;
+    timestamp: number;
+    parentHash: string;
+}>;
+//# sourceMappingURL=subgraph.d.ts.map

package/dist/types/views/subgraph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subgraph.d.ts","sourceRoot":"","sources":["../../../src/views/subgraph.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAG7D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,gBAAiB;IAAE,OAAO,EAAE,SAAS,CAAA;CAAE,WAEtE,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,iBAEhC;IACD,OAAO,EAAE,SAAS,CAAC;CACpB,oBAoBA,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,gBAAuB;IAAE,OAAO,EAAE,SAAS,CAAA;CAAE;;;;;EA8BzE,CAAC"}

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

@@ -0,0 +1,77 @@
+import { CHAIN_IDS } from '../constants/chain-configs/chain';
+import { Currency } from '../entities/currency/types';
+/**
+ * Calculates and returns the neighboring price ticks and their corresponding prices for a given input price.
+ *
+ * @param {CHAIN_IDS} chainId - chain id from {@link CHAIN_IDS}
+ * @param {string} price - The input price to calculate the neighborhood for, as a string.
+ * @param {Currency} currency0 - token0 currency {@link Currency}.
+ * @param {Currency} currency1 - token1 currency {@link Currency}.
+ *
+ * @returns {Object} An object containing the normal and inverted price neighborhoods. Each neighborhood includes:
+ *   - up: The tick and price for one tick above the current price.
+ *   - now: The tick and price for the current price.
+ *   - down: The tick and price for one tick below the current price.
+ */
+export declare const getPriceNeighborhood: ({ chainId, price, currency0, currency1, }: {
+    chainId: CHAIN_IDS;
+    price: string;
+    currency0: Currency;
+    currency1: Currency;
+}) => {
+    normal: {
+        nextUp: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        up: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        now: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        down: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        nextDown: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+    };
+    inverted: {
+        nextUp: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        up: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        now: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        down: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+        nextDown: {
+            tick: bigint;
+            price: string;
+            marketPrice: string;
+        };
+    };
+};
+//# sourceMappingURL=tick.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tick.d.ts","sourceRoot":"","sources":["../../../src/views/tick.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAKtD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,oBAAoB,8CAK9B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,EAAE,QAAQ,CAAC;CACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2JA,CAAC"}

package/dist/types/views/vault.d.ts

@@ -0,0 +1,25 @@
+import { CHAIN_IDS } from '../constants/chain-configs/chain';
+import { Vault } from '../entities/vault/types';
+/**
+ * Get the vault for a currency.
+ *
+ * @param chainId The chain ID of the blockchain.
+ * @param tokenAddress The address of the token/currency.
+ * @param options Optional RPC URL.
+ * @returns A Promise resolving to a Vault object.
+ * @example
+ * import { getVault } from '@clober/v2-sdk'
+ *
+ * const vault = await getVault({
+ *   chainId: 421614,
+ *   tokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'
+ * })
+ */
+export declare const getVault: ({ chainId, tokenAddress, options, }: {
+    chainId: CHAIN_IDS;
+    tokenAddress: `0x${string}`;
+    options?: {
+        rpcUrl?: string;
+    };
+}) => Promise<Vault>;
+//# sourceMappingURL=vault.d.ts.map

package/dist/types/views/vault.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../../src/views/vault.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,kCAAkC,CAAC;AAGxE,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAEhD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,QAAQ,wCAIlB;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,KAAG,QAAQ,KAAK,CAgBhB,CAAC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@1stdex/first-sdk",
+  "version": "1.0.0-rc.1",
+  "description": "🛠 An SDK for building applications on top of Clober V2",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/first-dex/first-sdk.git"
+  },
+  "scripts": {
+    "lint": "eslint --ext .ts src --fix",
+    "docs": "typedoc --out docs src/index.ts --sort kind",
+    "anvil": "npx tsx test/start-anvil.ts",
+    "anvil:dump": "anvil --chain-id 31337 --accounts 10 --auto-impersonate --gas-price 0 --port 8545 --dump-state test/anvil-state.json",
+    "test": "vitest --root test --config vitest.config.ts --max-concurrency=0",
+    "test:subgraph": "ENABLE_SUBGRAPH=true vitest --root test --config vitest.config.ts --max-concurrency=0",
+    "clean": "rm -rf dist",
+    "build": "npm run clean && npm install . && npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir ./dist/cjs --removeComments && printf '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
+    "build:esm": "tsc --project tsconfig.build.json --module es2015 --outDir ./dist/esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./dist/esm/package.json",
+    "build:types": "tsc --project tsconfig.build.json --module esnext --outDir ./dist/types --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap"
+  },
+  "keywords": [],
+  "author": "Clober<official@clober.io>",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^24.7.2",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
+    "@viem/anvil": "^0.0.9",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.49.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "prettier": "^3.0.3",
+    "typedoc": "^0.25.12",
+    "typescript": "^5.4.3",
+    "vitest": "^1.4.0"
+  },
+  "dependencies": {
+    "axios": "^1.7.7",
+    "bignumber.js": "^9.1.2",
+    "viem": "^2.23.12"
+  }
+}