@1stdex/first-sdk 1.0.4 → 1.0.6

package/dist/types/calls/approval/order.d.ts

@@ -1,69 +1,56 @@
-import { WalletClient } from 'viem';
 import { CHAIN_IDS } from '../../constants/chain-configs/chain';
-import { DefaultWriteContractOptions } from '../../types';
+import { DefaultWriteContractOptions, Transaction } from '../../types';
 /**
- * @dev This function relates with `viem` dependency
- * Sets the order operator approval for the specified operator address on the given chain.
+ * Prepares a transaction to set the order operator approval for the specified operator address on the given chain.
  *
  * @param {CHAIN_IDS} chainId The chain ID.
- * @param {WalletClient} walletClient The wallet client.
+ * @param {`0x${string}`} userAddress The user address.
  * @param {`0x${string}`} operator The operator address to approve or revoke.
  * @param {boolean} approved Whether to approve or revoke the operator.
  * @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}`>} Promise resolving to the transaction hash.
+ * @param {string} options.rpcUrl The RPC URL to use for building the transaction.
+ * @returns {Promise<Transaction>} Promise resolving to the transaction object.
  * @example
  * import { setOrderOperatorApproval } from '@clober/v2-sdk'
- * import { mnemonicToAccount } from 'viem/accounts'
  *
- * const walletClient = createWalletClient({
- *   chain: arbitrumSepolia,
- *   account: mnemonicToAccount('legal ...'),
- *   transport: http(),
- * })
- *
- * const hash = await setOrderOperatorApproval({
+ * const transaction = await setOrderOperatorApproval({
  *   chainId: 421614,
- *   walletClient,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
  *   operator: '0x1234567890123456789012345678901234567890',
  *   approved: true
  * })
+ *
+ * const hash = await walletClient.sendTransaction(transaction)
  */
-export declare const setOrderOperatorApproval: ({ chainId, walletClient, operator, approved, options, }: {
+export declare const setOrderOperatorApproval: ({ chainId, userAddress, operator, approved, options, }: {
     chainId: CHAIN_IDS;
-    walletClient: WalletClient;
+    userAddress: `0x${string}`;
     operator: `0x${string}`;
     approved: boolean;
     options?: DefaultWriteContractOptions;
-}) => Promise<`0x${string}`>;
+}) => Promise<Transaction | undefined>;
 /**
- * @dev This function relates with `viem` dependency
- * Approves the controller as an order operator for the specified chain.
+ * Prepares a transaction to approve the controller as an order operator for the specified chain.
  * This is a convenience function that delegates to `setOrderOperatorApproval`.
  *
  * @param {CHAIN_IDS} chainId The chain ID.
- * @param {WalletClient} walletClient The wallet client.
+ * @param {`0x${string}`} userAddress The user address.
  * @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}`>} Promise resolving to the transaction hash.
+ * @param {string} options.rpcUrl The RPC URL to use for building the transaction.
+ * @returns {Promise<Transaction>} Promise resolving to the transaction object.
  * @example
  * import { approveControllerAsOrderOperator } from '@clober/v2-sdk'
- * import { mnemonicToAccount } from 'viem/accounts'
  *
- * const walletClient = createWalletClient({
- *   chain: arbitrumSepolia,
- *   account: mnemonicToAccount('legal ...'),
- *   transport: http(),
- * })
- *
- * const hash = await approveControllerAsOrderOperator({
+ * const transaction = await approveControllerAsOrderOperator({
  *   chainId: 421614,
- *   walletClient
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69'
  * })
+ *
+ * const hash = await walletClient.sendTransaction(transaction)
  */
-export declare const approveControllerAsOrderOperator: ({ chainId, walletClient, options, }: {
+export declare const approveControllerAsOrderOperator: ({ chainId, userAddress, options, }: {
     chainId: CHAIN_IDS;
-    walletClient: WalletClient;
+    userAddress: `0x${string}`;
     options?: DefaultWriteContractOptions;
-}) => Promise<`0x${string}`>;
+}) => Promise<Transaction | undefined>;
 //# sourceMappingURL=order.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/order.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,YAAY,EAAE,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAG1D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,wBAAwB,4DAMlC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,KAAK,MAAM,EAAE,CAsCxB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,gCAAgC,wCAI1C;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,KAAK,MAAM,EAAE,CAaxB,CAAC"}
+{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/order.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAKvE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,wBAAwB,2DAMlC;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,GAAG,SAAS,CAsClC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,gCAAgC,uCAI1C;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,GAAG,SAAS,CAQlC,CAAC"}

package/dist/types/calls/approval/token.d.ts

@@ -1,41 +1,39 @@
-import { WalletClient } from 'viem';
 import { CHAIN_IDS } from '../../constants/chain-configs/chain';
-import { DefaultWriteContractOptions } from '../../types';
+import { DefaultWriteContractOptions, Transaction } from '../../types';
 /**
- * @dev This function relates with `viem` dependency
- * Sets maximum allowance for a token and its vault to the respective contracts.
+ * Prepares approval transactions for a token and its vault.
  * This includes:
  * - Max allowance for the token to controller
  * - Max allowance for the token's vault to controller
  * - Max allowance for the token's vault to book manager
  *
- * Only adds allowance if current allowance is below threshold (max - 1 million tokens).
+ * Only includes approvals where current allowance is below threshold (max - 1 million tokens).
  *
  * @param {CHAIN_IDS} chainId The chain ID.
- * @param {WalletClient} walletClient The wallet client.
+ * @param {`0x${string}`} userAddress The user address.
  * @param {`0x${string}`} tokenAddress The token address.
  * @param options
  * @param options.rpcUrl The RPC URL of the blockchain.
- * @returns {Promise<`0x${string}`[]>} Promise resolving to array of transaction hashes. Empty array if no approvals needed.
+ * @returns {Promise<Transaction[]>} Promise resolving to array of approval transactions. Empty array if no approvals needed.
  * @example
  * import { setTokenAllowances } from '@clober/v2-sdk'
  *
- * const walletClient = createWalletClient({
- *   chain: arbitrumSepolia,
- *   account: mnemonicToAccount('legal ...'),
- *   transport: http(),
- * })
- *
- * const hashes = await setTokenAllowances({
+ * const transactions = await setTokenAllowances({
  *   chainId: 421614,
- *   walletClient,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
  *   tokenAddress: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
  * })
+ *
+ * // Send transactions sequentially
+ * for (const tx of transactions) {
+ *   const hash = await walletClient.sendTransaction(tx)
+ *   await publicClient.waitForTransactionReceipt({ hash })
+ * }
  */
-export declare const setTokenAllowances: ({ chainId, walletClient, tokenAddress, options, }: {
+export declare const setTokenAllowances: ({ chainId, userAddress, tokenAddress, options, }: {
     chainId: CHAIN_IDS;
-    walletClient: WalletClient;
+    userAddress: `0x${string}`;
     tokenAddress: `0x${string}`;
     options?: DefaultWriteContractOptions;
-}) => Promise<`0x${string}`[]>;
+}) => Promise<Transaction[]>;
 //# sourceMappingURL=token.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/token.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,YAAY,EAAE,MAAM,MAAM,CAAC;AAE9D,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAM1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,kBAAkB,sDAK5B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,YAAY,EAAE,YAAY,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,KAAK,MAAM,EAAE,EAAE,CAuN1B,CAAC"}
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../../../../src/calls/approval/token.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAa,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAOvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,kBAAkB,qDAK5B;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,YAAY,EAAE,KAAK,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,2BAA2B,CAAC;CACvC,KAAG,QAAQ,WAAW,EAAE,CA+GxB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1stdex/first-sdk",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "🛠 An SDK for building applications on top of 1st V2",
   "files": [
     "dist"