Merge pull request #87 from clober-dex/feat/remove-permit-function

refactor: remove `signERC20Permit` function

examples/limit-order.ts

@@ -2,12 +2,7 @@ import { createWalletClient, http, parseUnits } from 'viem'
 import { arbitrumSepolia } from 'viem/chains'
 import { privateKeyToAccount } from 'viem/accounts'
 import * as dotenv from 'dotenv'
-import {
-  getMarket,
-  getOpenOrders,
-  limitOrder,
-  signERC20Permit,
-} from '@clober/v2-sdk'
+import { getMarket, getOpenOrders, limitOrder } from '@clober/v2-sdk'
 
 dotenv.config()
 
@@ -20,34 +15,24 @@ const main = async () => {
     transport: http(),
   })
 
-  const erc20PermitParam = await signERC20Permit({
-    chainId: arbitrumSepolia.id,
-    walletClient,
-    token: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
-    amount: '1.12',
-  })
-
   const {
     transaction,
-    result: { make, taken },
+    result: { make, take },
   } = await limitOrder({
     chainId: arbitrumSepolia.id,
     userAddress: walletClient.account.address,
     inputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
     outputToken: '0x0000000000000000000000000000000000000000',
     amount: '1.12',
     price: '8000.01',
-    options: {
-      erc20PermitParam: erc20PermitParam!,
-    },
   })
   const hash = await walletClient.sendTransaction({
     ...transaction,
     gasPrice: parseUnits('1', 9),
   })
   console.log(`limit order hash: ${hash}`)
   console.log(`make: `, make)
-  console.log(`taken: `, taken)
+  console.log(`take: `, take)
 
   const market = await getMarket({
     chainId: arbitrumSepolia.id,

examples/market-order.ts

@@ -2,7 +2,7 @@ import { createWalletClient, http, parseUnits } from 'viem'
 import { arbitrumSepolia } from 'viem/chains'
 import { privateKeyToAccount } from 'viem/accounts'
 import * as dotenv from 'dotenv'
-import { getMarket, marketOrder, signERC20Permit } from '@clober/v2-sdk'
+import { getMarket, marketOrder } from '@clober/v2-sdk'
 
 dotenv.config()
 
@@ -15,32 +15,22 @@ const main = async () => {
     transport: http(),
   })
 
-  const erc20PermitParam = await signERC20Permit({
-    chainId: arbitrumSepolia.id,
-    walletClient,
-    token: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
-    amount: '1.12',
-  })
-
   const {
     transaction,
-    result: { spent, take },
+    result: { spend, take },
   } = await marketOrder({
     chainId: arbitrumSepolia.id,
     userAddress: walletClient.account.address,
     inputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
     outputToken: '0x0000000000000000000000000000000000000000',
     amountIn: '1.12',
-    options: {
-      erc20PermitParam: erc20PermitParam!,
-    },
   })
   const hash = await walletClient.sendTransaction({
     ...transaction,
     gasPrice: parseUnits('1', 9),
   })
   console.log(`market order hash: ${hash}`)
-  console.log(`spent: `, spent)
+  console.log(`spend: `, spend)
   console.log(`take: `, take)
 
   const market = await getMarket({

src/call.ts

@@ -149,24 +149,16 @@ export const openMarket = async ({
  * @returns {Promise<{ transaction: Transaction, result: { make: CurrencyFlow, take: CurrencyFlow, spent: CurrencyFlow }>}
  * Promise resolving to the transaction object representing the limit order with the result of the order.
  * @example
- * import { signERC20Permit, limitOrder } from '@clober/v2-sdk'
+ * import { limitOrder } from '@clober/v2-sdk'
  * import { privateKeyToAccount } from 'viem/accounts'
  *
- * const erc20PermitParam = await signERC20Permit({
- *   chainId: 421614,
- *   walletClient,
- *   token: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
- *   amount: '100.123'
- * })
- *
  * const { transaction } = await limitOrder({
  *   chainId: 421614,
  *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69
  *   inputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
  *   outputToken: '0x0000000000000000000000000000000000000000',
  *   amount: '100.123', // 100.123 USDC
  *   price: '4000.01', // price at 4000.01 (ETH/USDC)
- *   options: { erc20PermitParam }
  * })
  *
  * @example
@@ -444,16 +436,9 @@ export const limitOrder = async ({
  * @returns {Promise<{ transaction: Transaction, result: { spent: CurrencyFlow, taken: CurrencyFlow } }>}
  * Promise resolving to the transaction object representing the market order with the result of the order.
  * @example
- * import { signERC20Permit, marketOrder } from '@clober/v2-sdk'
+ * import { marketOrder } from '@clober/v2-sdk'
  * import { privateKeyToAccount } from 'viem/accounts'
  *
- * const erc20PermitParam = await signERC20Permit({
- *   chainId: 421614,
- *   walletClient,
- *   token: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
- *   amount: '100.123'
- * })
- *
  * const transaction = await marketOrder({
  *   chainId: 421614,
  *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69

src/index.ts

@@ -1,6 +1,5 @@
 export * from './type'
 export * from './view'
 export * from './call'
-export * from './signature'
 export * from './approval'
 export * from './utils'

src/view.ts

@@ -129,6 +129,7 @@ export const getMarket = async ({
  * @param chainId - chain id from {@link CHAIN_IDS}
  * @param token0 - token0 address
  * @param token1 - token1 address
+ * @param salt - salt for the pool
  * @param options {@link DefaultOptions} options.
  * @param options.n - number of depth levels to fetch
  * @returns A pool {@link Pool}