@clober/v2-sdk 0.0.7 → 0.0.9

package/dist/types/approval.d.ts

@@ -1,11 +1,12 @@
-import { type HDAccount, type PrivateKeyAccount } from 'viem';
+import { WalletClient } from 'viem';
 import { CHAIN_IDS } from './constants/chain';
 import type { DefaultOptions } from './type';
 /**
+ * @dev This function relates with `viem` dependency
  * Sets approval of all open orders for the specified account on the given chain.
  *
  * @param {CHAIN_IDS} chainId The chain ID.
- * @param {HDAccount | PrivateKeyAccount} account The Ethereum account for which approval is to be set.
+ * @param {WalletClient} walletClient The wallet client.
  * @param {Object} [options] Optional parameters for setting approval.
  * @param {string} options.rpcUrl The RPC URL to use for executing the transaction.
  * @returns {Promise<`0x${string}` | undefined>} Promise resolving to the transaction hash. If the account is already approved for all, the promise resolves to `undefined`.
@@ -22,14 +23,20 @@ import type { DefaultOptions } from './type';
  * import { setApprovalOfOpenOrdersForAll } from '@clober/v2-sdk'
  * import { mnemonicToAccount } from 'viem/accounts'
  *
+ * const walletClient = createWalletClient({
+ *   chain: arbitrumSepolia,
+ *   account: mnemonicToAccount('legal ...'),
+ *   transport: http(),
+ * })
+ *
  * const hash = await setApprovalOfOpenOrdersForAll(
  *   421614,
- *   mnemonicToAccount('legal ...')
+ *   walletClient
  * )
  */
 export declare const setApprovalOfOpenOrdersForAll: (args: {
     chainId: CHAIN_IDS;
-    account: HDAccount | PrivateKeyAccount;
+    walletClient: WalletClient;
     options?: DefaultOptions;
 }) => Promise<`0x${string}` | undefined>;
 //# sourceMappingURL=approval.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"approval.d.ts","sourceRoot":"","sources":["../../src/approval.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,SAAS,EACd,KAAK,iBAAiB,EACvB,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,SAAS,EAAa,MAAM,mBAAmB,CAAA;AAIxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAuB5C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,6BAA6B;aAM7B,SAAS;aACT,SAAS,GAAG,iBAAiB;cAC5B,cAAc;wCAuB3B,CAAA"}
+{"version":3,"file":"approval.d.ts","sourceRoot":"","sources":["../../src/approval.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAEnC,OAAO,EAAE,SAAS,EAAa,MAAM,mBAAmB,CAAA;AAIxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAuB5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,6BAA6B;aAK7B,SAAS;kBACJ,YAAY;cAChB,cAAc;wCAqB3B,CAAA"}

package/dist/types/signature.d.ts

@@ -1,12 +1,12 @@
-import { HDAccount, PrivateKeyAccount } from 'viem';
+import { WalletClient } from 'viem';
 import { CHAIN_IDS } from './constants/chain';
 import { DefaultOptions, PermitSignature } from './type';
 /**
+ * @dev This function relates with `viem` dependency
  * Signs an ERC20 permit using EIP-712 encoding.
  *
  * @param {CHAIN_IDS} chainId The chain ID.
- * @param {HDAccount | PrivateKeyAccount} account The Ethereum account used for signing using
- * [viem - Local Accounts (Private Key, Mnemonic, etc)](https://viem.sh/docs/accounts/local#local-accounts-private-key-mnemonic-etc).
+ * @param {WalletClient} walletClient The wallet client.
  * @param {`0x${string}`} token The ERC20 token address.
  * @param {string} amount The amount of tokens to permit.
  * @param options
@@ -27,16 +27,22 @@ import { DefaultOptions, PermitSignature } from './type';
  * import { signERC20Permit } from '@clober/v2-sdk'
  * import { mnemonicToAccount } from 'viem/accounts'
  *
+ * const walletClient = createWalletClient({
+ *   chain: arbitrumSepolia,
+ *   account: mnemonicToAccount('legal ...'),
+ *   transport: http(),
+ * })
+ *
  * const { deadline, r, s, v } = await signERC20Permit({
  *   chainId: 421614,
- *   account: mnemonicToAccount('legal ...')
+ *   walletClient
  *   token: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
  *   amount: '1000.123', // spend 1000.123 USDC
  * })
  */
 export declare const signERC20Permit: (args: {
     chainId: CHAIN_IDS;
-    account: HDAccount | PrivateKeyAccount;
+    walletClient: WalletClient;
     token: `0x${string}`;
     amount: string;
     options?: DefaultOptions;

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

@@ -1 +1 @@
-{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../src/signature.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAGT,iBAAiB,EAGlB,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAI7C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAoDxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,eAAe;aAOf,SAAS;aACT,SAAS,GAAG,iBAAiB;WAC/B,KAAK,MAAM,EAAE;YACZ,MAAM;cACJ,cAAc;8BAuF3B,CAAA"}
+{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../src/signature.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,YAAY,EAEb,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAI7C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AAoDxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,eAAe;aAOf,SAAS;kBACJ,YAAY;WACnB,KAAK,MAAM,EAAE;YACZ,MAAM;cACJ,cAAc;8BA4F3B,CAAA"}

package/dist/types/view.d.ts

@@ -192,4 +192,26 @@ export declare const getChartLogs: (args: {
     from: number;
     to: number;
 }) => Promise<ChartLog[]>;
+/**
+ * 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=view.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAI9D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAGnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAE5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,SAAS;aAOT,SAAS;YACV,KAAK,MAAM,EAAE;YACb,KAAK,MAAM,EAAE;cACX;QACR,CAAC,CAAC,EAAE,MAAM,CAAA;KACX,GAAG,cAAc;qBAkBrB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,iBAAiB;aAQjB,SAAS;gBACN,KAAK,MAAM,EAAE;iBACZ,KAAK,MAAM,EAAE;cAChB,MAAM;cACN;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc;;iBAErC,MAAM;iBACN,MAAM;YACX,MAAM;EAgCjB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB;aAQhB,SAAS;gBACN,KAAK,MAAM,EAAE;iBACZ,KAAK,MAAM,EAAE;eACf,MAAM;cACP;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc;;iBAErC,MAAM;iBACN,MAAM;YACX,MAAM;EAgCjB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,YAAY;aAKZ,SAAS;QACd,MAAM;cACA,cAAc;wBAI3B,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa;aAKb,SAAS;iBACL,KAAK,MAAM,EAAE;cAChB,cAAc;0BAI3B,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB;aAMjB,SAAS;WACX,KAAK,MAAM,EAAE;UACd,KAAK,MAAM,EAAE;uBAItB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,eAAO,MAAM,YAAY;aASZ,SAAS;WACX,KAAK,MAAM,EAAE;UACd,KAAK,MAAM,EAAE;kBACL,mBAAmB;UAC3B,MAAM;QACR,MAAM;yBAIb,CAAA"}
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAI9D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAGnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAG5C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,SAAS;aAOT,SAAS;YACV,KAAK,MAAM,EAAE;YACb,KAAK,MAAM,EAAE;cACX;QACR,CAAC,CAAC,EAAE,MAAM,CAAA;KACX,GAAG,cAAc;qBAkBrB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,iBAAiB;aAQjB,SAAS;gBACN,KAAK,MAAM,EAAE;iBACZ,KAAK,MAAM,EAAE;cAChB,MAAM;cACN;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc;;iBAErC,MAAM;iBACN,MAAM;YACX,MAAM;EAgCjB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB;aAQhB,SAAS;gBACN,KAAK,MAAM,EAAE;iBACZ,KAAK,MAAM,EAAE;eACf,MAAM;cACP;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc;;iBAErC,MAAM;iBACN,MAAM;YACX,MAAM;EAgCjB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,YAAY;aAKZ,SAAS;QACd,MAAM;cACA,cAAc;wBAI3B,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,aAAa;aAKb,SAAS;iBACL,KAAK,MAAM,EAAE;cAChB,cAAc;0BAI3B,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB;aAMjB,SAAS;WACX,KAAK,MAAM,EAAE;UACd,KAAK,MAAM,EAAE;uBAItB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,eAAO,MAAM,YAAY;aASZ,SAAS;WACX,KAAK,MAAM,EAAE;UACd,KAAK,MAAM,EAAE;kBACL,mBAAmB;UAC3B,MAAM;QACR,MAAM;yBAIb,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,iCAIvB;IACD,OAAO,EAAE,SAAS,CAAA;IAClB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;IACrB,MAAM,EAAE,KAAK,MAAM,EAAE,CAAA;CACtB,KAAG,KAAK,MAAM,EAEd,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clober/v2-sdk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "🛠 An SDK for building applications on top of Clober V2",
   "files": [
     "dist"