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

package/dist/esm/views/subgraph.js

@@ -0,0 +1,54 @@
+import { Subgraph, SUBGRAPH_URL } from '../constants/chain-configs/subgraph';
+/**
+ * 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 const getSubgraphEndpoint = ({ chainId }) => {
+    return SUBGRAPH_URL[chainId];
+};
+/**
+ * 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 const getSubgraphBlockNumber = async ({ chainId, }) => {
+    const { data: { _meta: { block: { number: blockNumber }, }, }, } = await Subgraph.get(chainId, 'getLatestBlockNumber', 'query getLatestBlockNumber { _meta { block { number } } }', {});
+    return blockNumber;
+};
+/**
+ * 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 const getSubgraphBlock = async ({ chainId }) => {
+    const { data: { _meta: { block: { number: blockNumber, hash, timestamp, parentHash }, }, }, } = await Subgraph.get(chainId, 'getLatestBlock', 'query getLatestBlock { _meta { block { number hash timestamp parentHash } } }', {});
+    return {
+        blockNumber,
+        hash,
+        timestamp,
+        parentHash,
+    };
+};
+//# sourceMappingURL=subgraph.js.map

package/dist/esm/views/subgraph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subgraph.js","sourceRoot":"","sources":["../../../src/views/subgraph.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AAE7E;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,EAAE,OAAO,EAA0B,EAAE,EAAE;IACzE,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,EAAE,EAC3C,OAAO,GAGR,EAAE,EAAE;IACH,MAAM,EACJ,IAAI,EAAE,EACJ,KAAK,EAAE,EACL,KAAK,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,GAC/B,GACF,GACF,GAAG,MAAM,QAAQ,CAAC,GAAG,CAOpB,OAAO,EACP,sBAAsB,EACtB,2DAA2D,EAC3D,EAAE,CACH,CAAC;IACF,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,EAAE,OAAO,EAA0B,EAAE,EAAE;IAC5E,MAAM,EACJ,IAAI,EAAE,EACJ,KAAK,EAAE,EACL,KAAK,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,UAAU,EAAE,GAC5D,GACF,GACF,GAAG,MAAM,QAAQ,CAAC,GAAG,CAYpB,OAAO,EACP,gBAAgB,EAChB,+EAA+E,EAC/E,EAAE,CACH,CAAC;IACF,OAAO;QACL,WAAW;QACX,IAAI;QACJ,SAAS;QACT,UAAU;KACX,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/views/tick.js

@@ -0,0 +1,89 @@
+import { isAddressEqual } from 'viem';
+import { formatPrice, invertTick, parsePrice, toPrice } from '../utils';
+import { getQuoteToken } from './index';
+/**
+ * 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 const getPriceNeighborhood = ({ chainId, price, currency0, currency1, }) => {
+    const quoteTokenAddress = getQuoteToken({
+        chainId,
+        token0: currency0.address,
+        token1: currency1.address,
+    });
+    const quoteCurrency = isAddressEqual(quoteTokenAddress, currency0.address)
+        ? currency0
+        : currency1;
+    const baseCurrency = isAddressEqual(quoteTokenAddress, currency0.address)
+        ? currency1
+        : currency0;
+    const { roundingDownTick, roundingUpTick } = parsePrice(Number(price), quoteCurrency.decimals, baseCurrency.decimals);
+    const bidBookTick = roundingDownTick;
+    const askBookTick = invertTick(roundingUpTick);
+    return {
+        normal: {
+            nextUp: {
+                tick: bidBookTick + 2n,
+                price: formatPrice(toPrice(bidBookTick + 2n), quoteCurrency.decimals, baseCurrency.decimals),
+                marketPrice: formatPrice(toPrice(bidBookTick + 2n), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            up: {
+                tick: bidBookTick + 1n,
+                price: formatPrice(toPrice(bidBookTick + 1n), quoteCurrency.decimals, baseCurrency.decimals),
+                marketPrice: formatPrice(toPrice(bidBookTick + 1n), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            now: {
+                tick: bidBookTick,
+                price: formatPrice(toPrice(bidBookTick), quoteCurrency.decimals, baseCurrency.decimals),
+                marketPrice: formatPrice(toPrice(bidBookTick), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            down: {
+                tick: bidBookTick - 1n,
+                price: formatPrice(toPrice(bidBookTick - 1n), quoteCurrency.decimals, baseCurrency.decimals),
+                marketPrice: formatPrice(toPrice(bidBookTick - 1n), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            nextDown: {
+                tick: bidBookTick - 2n,
+                price: formatPrice(toPrice(bidBookTick - 2n), quoteCurrency.decimals, baseCurrency.decimals),
+                marketPrice: formatPrice(toPrice(bidBookTick - 2n), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+        },
+        inverted: {
+            nextUp: {
+                tick: askBookTick + 2n,
+                price: formatPrice(toPrice(askBookTick + 2n), baseCurrency.decimals, quoteCurrency.decimals),
+                marketPrice: formatPrice(toPrice(invertTick(askBookTick + 2n)), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            up: {
+                tick: askBookTick + 1n,
+                price: formatPrice(toPrice(askBookTick + 1n), baseCurrency.decimals, quoteCurrency.decimals),
+                marketPrice: formatPrice(toPrice(invertTick(askBookTick + 1n)), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            now: {
+                tick: askBookTick,
+                price: formatPrice(toPrice(askBookTick), baseCurrency.decimals, quoteCurrency.decimals),
+                marketPrice: formatPrice(toPrice(invertTick(askBookTick)), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            down: {
+                tick: askBookTick - 1n,
+                price: formatPrice(toPrice(askBookTick - 1n), baseCurrency.decimals, quoteCurrency.decimals),
+                marketPrice: formatPrice(toPrice(invertTick(askBookTick - 1n)), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+            nextDown: {
+                tick: askBookTick - 2n,
+                price: formatPrice(toPrice(askBookTick - 2n), baseCurrency.decimals, quoteCurrency.decimals),
+                marketPrice: formatPrice(toPrice(invertTick(askBookTick - 2n)), quoteCurrency.decimals, baseCurrency.decimals),
+            },
+        },
+    };
+};
+//# sourceMappingURL=tick.js.map

package/dist/esm/views/tick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tick.js","sourceRoot":"","sources":["../../../src/views/tick.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAItC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAExE,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EACnC,OAAO,EACP,KAAK,EACL,SAAS,EACT,SAAS,GAMV,EAAE,EAAE;IACH,MAAM,iBAAiB,GAAG,aAAa,CAAC;QACtC,OAAO;QACP,MAAM,EAAE,SAAS,CAAC,OAAO;QACzB,MAAM,EAAE,SAAS,CAAC,OAAO;KAC1B,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,cAAc,CAAC,iBAAiB,EAAE,SAAS,CAAC,OAAO,CAAC;QACxE,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,YAAY,GAAG,cAAc,CAAC,iBAAiB,EAAE,SAAS,CAAC,OAAO,CAAC;QACvE,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,UAAU,CACrD,MAAM,CAAC,KAAK,CAAC,EACb,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB,CAAC;IACF,MAAM,WAAW,GAAG,gBAAgB,CAAC;IACrC,MAAM,WAAW,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAC/C,OAAO;QACL,MAAM,EAAE;YACN,MAAM,EAAE;gBACN,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,EAAE,EAAE;gBACF,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,GAAG,EAAE;gBACH,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,CAAC,EACpB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,WAAW,CAAC,EACpB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;SACF;QACD,QAAQ,EAAE;YACR,MAAM,EAAE;gBACN,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,YAAY,CAAC,QAAQ,EACrB,aAAa,CAAC,QAAQ,CACvB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,EACrC,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,EAAE,EAAE;gBACF,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,YAAY,CAAC,QAAQ,EACrB,aAAa,CAAC,QAAQ,CACvB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,EACrC,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,GAAG,EAAE;gBACH,IAAI,EAAE,WAAW;gBACjB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,CAAC,EACpB,YAAY,CAAC,QAAQ,EACrB,aAAa,CAAC,QAAQ,CACvB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EAChC,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,YAAY,CAAC,QAAQ,EACrB,aAAa,CAAC,QAAQ,CACvB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,EACrC,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,WAAW,GAAG,EAAE;gBACtB,KAAK,EAAE,WAAW,CAChB,OAAO,CAAC,WAAW,GAAG,EAAE,CAAC,EACzB,YAAY,CAAC,QAAQ,EACrB,aAAa,CAAC,QAAQ,CACvB;gBACD,WAAW,EAAE,WAAW,CACtB,OAAO,CAAC,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC,CAAC,EACrC,aAAa,CAAC,QAAQ,EACtB,YAAY,CAAC,QAAQ,CACtB;aACF;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/views/vault.js

@@ -0,0 +1,35 @@
+import { createPublicClient, http } from 'viem';
+import { CHAIN_MAP } from '../constants/chain-configs/chain';
+import { CONTRACT_ADDRESSES } from '../constants/chain-configs/addresses';
+import { BOOK_MANAGER_ABI } from '../constants/abis/core/book-manager-abi';
+/**
+ * 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 const getVault = async ({ chainId, tokenAddress, options, }) => {
+    const publicClient = createPublicClient({
+        chain: CHAIN_MAP[chainId],
+        transport: options?.rpcUrl ? http(options.rpcUrl) : http(),
+    });
+    const vaultAddress = await publicClient.readContract({
+        address: CONTRACT_ADDRESSES[chainId].BookManager,
+        abi: BOOK_MANAGER_ABI,
+        functionName: 'getVault',
+        args: [tokenAddress],
+    });
+    return {
+        address: vaultAddress,
+    };
+};
+//# sourceMappingURL=vault.js.map

package/dist/esm/views/vault.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault.js","sourceRoot":"","sources":["../../../src/views/vault.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAEhD,OAAO,EAAa,SAAS,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAG3E;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAE,EAC7B,OAAO,EACP,YAAY,EACZ,OAAO,GAOR,EAAkB,EAAE;IACnB,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;QACzB,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC;QACnD,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,WAAW;QACjD,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,UAAU;QACxB,IAAI,EAAE,CAAC,YAAY,CAAC;KACrB,CAAC,CAAC;IAEH,OAAO;QACL,OAAO,EAAE,YAAY;KACtB,CAAC;AACJ,CAAC,CAAC"}