@cowprotocol/permit-utils 3.0.0 → 3.0.1

package/src/utils/getTokenPermitVersion.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTokenPermitVersion = getTokenPermitVersion;
+const abi_1 = require("@ethersproject/abi");
+const getContract_1 = require("./getContract");
+const versionAbis_1 = require("../abi/versionAbis");
+async function getTokenPermitVersion(tokenAddress, provider, index = 0) {
+    const abi = versionAbis_1.VERSION_ABIS[index];
+    if (!abi) {
+        return '1';
+    }
+    try {
+        const contract = (0, getContract_1.getContract)(tokenAddress, abi, provider);
+        const data = contract.interface.encodeFunctionData(abi[0].name);
+        const response = await provider.call({ to: tokenAddress, data });
+        if (response === '0x' || Number.isNaN(Number(response))) {
+            return '1';
+        }
+        if (!response.startsWith('0x')) {
+            return response;
+        }
+        return abi_1.defaultAbiCoder.decode(['string'], response).toString();
+    }
+    catch {
+        return getTokenPermitVersion(tokenAddress, provider, index + 1);
+    }
+}
+//# sourceMappingURL=getTokenPermitVersion.js.map

package/src/utils/getTokenPermitVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTokenPermitVersion.js","sourceRoot":"","sources":["../../../../../libs/permit-utils/src/utils/getTokenPermitVersion.ts"],"names":[],"mappings":";;AAOA,sDA2BC;AAlCD,4CAAoD;AAGpD,+CAA2C;AAE3C,oDAAiD;AAE1C,KAAK,UAAU,qBAAqB,CACzC,YAAoB,EACpB,QAAyB,EACzB,KAAK,GAAG,CAAC;IAET,MAAM,GAAG,GAAG,0BAAY,CAAC,KAAK,CAAC,CAAA;IAE/B,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAA,yBAAW,EAAC,YAAY,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAA;QACzD,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC/D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAA;QAEhE,IAAI,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YACxD,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,OAAO,QAAQ,CAAA;QACjB,CAAC;QAED,OAAO,qBAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAA;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,qBAAqB,CAAC,YAAY,EAAE,QAAQ,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;IACjE,CAAC;AACH,CAAC"}

package/src/utils/isSupportedPermitInfo.d.ts

@@ -0,0 +1,2 @@
+import { PermitInfo } from '../types';
+export declare function isSupportedPermitInfo(p: PermitInfo | undefined): p is PermitInfo;

package/src/utils/isSupportedPermitInfo.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSupportedPermitInfo = isSupportedPermitInfo;
+function isSupportedPermitInfo(p) {
+    return !!p && p.type !== 'unsupported';
+}
+//# sourceMappingURL=isSupportedPermitInfo.js.map

package/src/utils/isSupportedPermitInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isSupportedPermitInfo.js","sourceRoot":"","sources":["../../../../../libs/permit-utils/src/utils/isSupportedPermitInfo.ts"],"names":[],"mappings":";;AAEA,sDAEC;AAFD,SAAgB,qBAAqB,CAAC,CAAyB;IAC7D,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,aAAa,CAAA;AACxC,CAAC"}

package/jest.config.ts

@@ -1,11 +0,0 @@
-export default {
-  displayName: 'permit-utils',
-  preset: '../../jest.preset.js',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
-  },
-  setupFilesAfterEnv: ['../../jest.setup.ts'],
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../coverage/libs/permit-utils',
-}

package/project.json

@@ -1,42 +0,0 @@
-{
-  "name": "permit-utils",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "libs/permit-utils/src",
-  "projectType": "library",
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/libs/permit-utils",
-        "main": "libs/permit-utils/src/index.ts",
-        "tsConfig": "libs/permit-utils/tsconfig.lib.json",
-        "assets": ["libs/permit-utils/*.md"],
-        "updateBuildableProjectDepsInPackageJson": true,
-        "buildableProjectDepsInPackageJsonType": "dependencies"
-      }
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": ["libs/permit-utils/**/*.ts"]
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "libs/permit-utils/jest.config.ts",
-        "passWithNoTests": true
-      },
-      "configurations": {
-        "ci": {
-          "ci": true,
-          "codeCoverage": true
-        }
-      }
-    }
-  },
-  "tags": []
-}

package/src/abi/versionAbis.ts

@@ -1,37 +0,0 @@
-/**
- * ABIs for fetching the version of different permit flavours
- */
-export const VERSION_ABIS = [
-  [
-    {
-      constant: true,
-      inputs: [],
-      name: 'version',
-      outputs: [
-        {
-          name: '',
-          type: 'string',
-        },
-      ],
-      payable: false,
-      stateMutability: 'view',
-      type: 'function',
-    },
-  ],
-  [
-    {
-      constant: true,
-      inputs: [],
-      name: 'ERC712_VERSION',
-      outputs: [
-        {
-          name: '',
-          type: 'string',
-        },
-      ],
-      payable: false,
-      stateMutability: 'view',
-      type: 'function',
-    },
-  ],
-]

package/src/const.ts

@@ -1,20 +0,0 @@
-import { MaxUint256 } from '@ethersproject/constants'
-import { Wallet } from '@ethersproject/wallet'
-
-import ms from 'ms.macro'
-import { privateKeyToAccount } from 'viem/accounts'
-
-// PK used only for signing permit requests for quoting and identifying token 'permittability'
-// Do not use or try to send funds to it. Or do. It'll be your funds 🤷
-const PERMIT_PK = '0xa50dc0f7fc051309434deb3b1c71e927dbb711759231d8ecbf630c85d94a42fe' // address: 0xDa5F16F4ab0410096a4403e7223988649fac38cF
-
-export const PERMIT_ACCOUNT = privateKeyToAccount(PERMIT_PK)
-export const PERMIT_SIGNER = new Wallet(PERMIT_PK)
-
-export const DEFAULT_MIN_GAS_LIMIT = 55_000
-
-export const DEFAULT_PERMIT_GAS_LIMIT = '80000'
-
-export const DEFAULT_PERMIT_VALUE = MaxUint256.toBigInt()
-
-export const DEFAULT_PERMIT_DURATION = ms`5 years`

package/src/consts/1inchPermitUtils.ts

@@ -1,68 +0,0 @@
-/**
- * @1inch/permit-signed-approvals-utils has a lot of extra variables and increases bundle size.
- *
- * At the same time it's repo is archived.
- *
- * Therefore we just copied needed constants, and when it's not possible, we should use import(...)
- *
- * You also can use `import type ... from '@1inch/permit-signed-approvals-utils'`
- */
-
-export const DAI_EIP_2612_PERMIT_ABI = [
-  {
-    constant: false,
-    inputs: [
-      {
-        internalType: 'address',
-        name: 'holder',
-        type: 'address',
-      },
-      {
-        internalType: 'address',
-        name: 'spender',
-        type: 'address',
-      },
-      {
-        internalType: 'uint256',
-        name: 'nonce',
-        type: 'uint256',
-      },
-      {
-        internalType: 'uint256',
-        name: 'expiry',
-        type: 'uint256',
-      },
-      {
-        internalType: 'bool',
-        name: 'allowed',
-        type: 'bool',
-      },
-      {
-        internalType: 'uint8',
-        name: 'v',
-        type: 'uint8',
-      },
-      {
-        internalType: 'bytes32',
-        name: 'r',
-        type: 'bytes32',
-      },
-      {
-        internalType: 'bytes32',
-        name: 's',
-        type: 'bytes32',
-      },
-    ],
-    name: 'permit',
-    outputs: [],
-    payable: false,
-    stateMutability: 'nonpayable',
-    type: 'function',
-  },
-]
-
-export const EIP_2612_PERMIT_SELECTOR = '0xd505accf'
-
-export const DAI_PERMIT_SELECTOR = '0x8fcbaf0c'
-
-export const DAI_LIKE_PERMIT_TYPEHASH = '0xea2aa0a1be11a07ed86d755c93467f4f82362b452371d1ba94d1715123511acb'

package/src/lib/checkIsCallDataAValidPermit.ts

@@ -1,64 +0,0 @@
-import { oneInchPermitUtilsConsts } from '..'
-import { PermitInfo } from '../types'
-
-import type { Eip2612PermitUtils } from '@1inch/permit-signed-approvals-utils'
-
-export async function checkIsCallDataAValidPermit(
-  owner: string,
-  chainId: number,
-  eip2612Utils: Eip2612PermitUtils,
-  tokenAddress: string,
-  _tokenName: string | undefined,
-  callData: string,
-  { version, type, name }: PermitInfo,
-): Promise<boolean | undefined> {
-  // TODO: take name only from PermitInfo
-  const tokenName = name || _tokenName
-
-  if (type === 'unsupported') {
-    return false
-  }
-
-  if (!tokenName) {
-    throw new Error(`No token name for ${tokenAddress}`)
-  }
-
-  const params = { chainId, tokenName, tokenAddress, callData, version }
-
-  let recoverPermitOwnerPromise: Promise<string> | undefined = undefined
-
-  // If pre-hook doesn't start with either selector, it's not a permit
-  if (callData.startsWith(oneInchPermitUtilsConsts.EIP_2612_PERMIT_SELECTOR)) {
-    recoverPermitOwnerPromise = eip2612Utils.recoverPermitOwnerFromCallData({
-      ...params,
-      // I don't know why this was removed, ok?
-      // We added it back on buildPermitCallData.ts
-      // But it looks like this is needed 🤷
-      // Check the test for this method https://github.com/1inch/permit-signed-approvals-utils/blob/master/src/eip-2612-permit.test.ts#L85-L106
-      callData: callData.replace(oneInchPermitUtilsConsts.EIP_2612_PERMIT_SELECTOR, '0x'),
-    })
-  } else if (callData.startsWith(oneInchPermitUtilsConsts.DAI_PERMIT_SELECTOR)) {
-    recoverPermitOwnerPromise = eip2612Utils.recoverDaiLikePermitOwnerFromCallData({
-      ...params,
-      callData: callData.replace(oneInchPermitUtilsConsts.DAI_PERMIT_SELECTOR, '0x'),
-    })
-  }
-
-  if (!recoverPermitOwnerPromise) {
-    // The callData doesn't match any known permit type
-    return undefined
-  }
-
-  try {
-    const recoveredOwner = await recoverPermitOwnerPromise
-
-    // Permit is valid when recovered owner matches order owner
-    return recoveredOwner.toLowerCase() === owner.toLowerCase()
-  } catch (e) {
-    console.debug(
-      `[checkHasValidPendingPermit] Failed to check permit validity for owner ${owner} with callData ${callData}`,
-      e,
-    )
-    return false
-  }
-}

package/src/lib/generatePermitHook.ts

@@ -1,133 +0,0 @@
-import { PERMIT_HOOK_DAPP_ID } from '@cowprotocol/hook-dapp-lib'
-import { JsonRpcProvider } from '@ethersproject/providers'
-
-import { DEFAULT_PERMIT_GAS_LIMIT, DEFAULT_PERMIT_VALUE, PERMIT_SIGNER } from '../const'
-import { PermitHookData, PermitHookParams } from '../types'
-import { buildDaiLikePermitCallData, buildEip2612PermitCallData } from '../utils/buildPermitCallData'
-import { getPermitDeadline } from '../utils/getPermitDeadline'
-import { isSupportedPermitInfo } from '../utils/isSupportedPermitInfo'
-
-const REQUESTS_CACHE: { [permitKey: string]: Promise<PermitHookData | undefined> } = {}
-
-export async function generatePermitHook(params: PermitHookParams): Promise<PermitHookData | undefined> {
-  const permitKey = getCacheKey(params)
-
-  const cachedRequest = REQUESTS_CACHE[permitKey]
-
-  if (cachedRequest) {
-    return await cachedRequest
-  }
-
-  const request = generatePermitHookRaw(params)
-    .catch((e) => {
-      console.debug(`[generatePermitHook] cached request failed`, e)
-      return undefined
-    })
-    .finally(() => {
-      // Remove consumed request to avoid stale data
-      delete REQUESTS_CACHE[permitKey]
-    })
-
-  REQUESTS_CACHE[permitKey] = request
-
-  return request
-}
-
-async function generatePermitHookRaw(params: PermitHookParams): Promise<PermitHookData> {
-  const { inputToken, spender, chainId, permitInfo, provider, account, eip2612Utils, nonce: preFetchedNonce } = params
-
-  const tokenAddress = inputToken.address
-  // TODO: remove the need for `name` from input token. Should come from permitInfo instead
-  const tokenName = permitInfo.name || inputToken.name
-
-  if (!isSupportedPermitInfo(permitInfo)) {
-    throw new Error(`Trying to generate permit hook for unsupported token: ${tokenAddress}`)
-  }
-
-  if (!tokenName) {
-    throw new Error(`No token name for token: ${tokenAddress}`)
-  }
-
-  const owner = account || PERMIT_SIGNER.address
-
-  // Only fetch the nonce in case it wasn't pre-fetched before
-  // That's the case for static account
-  const nonce = preFetchedNonce === undefined ? await eip2612Utils.getTokenNonce(tokenAddress, owner) : preFetchedNonce
-
-  const deadline = getPermitDeadline()
-  const value = params.amount || DEFAULT_PERMIT_VALUE
-
-  const callData =
-    permitInfo.type === 'eip-2612'
-      ? await buildEip2612PermitCallData({
-          eip2612Utils,
-          callDataParams: [
-            {
-              owner,
-              spender,
-              value: value.toString(),
-              nonce,
-              deadline,
-            },
-            chainId as number,
-            tokenName,
-            tokenAddress,
-            permitInfo.version,
-          ],
-        })
-      : await buildDaiLikePermitCallData({
-          eip2612Utils,
-          callDataParams: [
-            {
-              holder: owner,
-              spender,
-              allowed: true,
-              value: value.toString(),
-              nonce,
-              expiry: deadline,
-            },
-            chainId as number,
-            tokenName,
-            tokenAddress,
-            permitInfo.version,
-          ],
-        })
-
-  const gasLimit = await calculateGasLimit(callData, owner, tokenAddress, provider, !!account)
-
-  return {
-    target: tokenAddress,
-    callData,
-    gasLimit,
-    dappId: PERMIT_HOOK_DAPP_ID,
-  }
-}
-
-async function calculateGasLimit(
-  data: string,
-  from: string,
-  to: string,
-  provider: JsonRpcProvider,
-  isUserAccount: boolean,
-): Promise<string> {
-  try {
-    // Query the actual gas estimate
-    const actual = await provider.estimateGas({ data, from, to })
-
-    // Add 10% to actual value to account for minor differences with real account
-    // Do not add it if this is the real user's account
-    const gasLimit = !isUserAccount ? actual.add(actual.div(10)) : actual
-
-    // Pick the biggest between estimated and default
-    return gasLimit.gt(DEFAULT_PERMIT_GAS_LIMIT) ? gasLimit.toString() : DEFAULT_PERMIT_GAS_LIMIT
-  } catch (e) {
-    console.debug(`[calculatePermitGasLimit] Failed to estimateGas, using default`, e)
-
-    return DEFAULT_PERMIT_GAS_LIMIT
-  }
-}
-
-function getCacheKey(params: PermitHookParams): string {
-  const { inputToken, chainId, account, amount } = params
-  return `${inputToken.address.toLowerCase()}-${chainId}${account ? `-${account.toLowerCase()}` : ''}${amount ? `-${amount.toString()}` : ''}`
-}

package/src/lib/getPermitUtilsInstance.ts

@@ -1,51 +0,0 @@
-import type { JsonRpcProvider } from '@ethersproject/providers'
-
-import { PERMIT_SIGNER } from '../const'
-import { PermitProviderConnector } from '../utils/PermitProviderConnector'
-
-import type { Eip2612PermitUtils } from '@1inch/permit-signed-approvals-utils'
-
-/**
- * Cache by network. Here we don't care about the provider as a static account will be used for the signature
- */
-const CHAIN_UTILS_CACHE = new Map<number, Eip2612PermitUtils>()
-/**
- * Cache by provider. Here we cache per provider as each account should have its own instance
- */
-const PROVIDER_UTILS_CACHE = new Map<string, Eip2612PermitUtils>()
-
-export async function getPermitUtilsInstance(
-  chainId: number,
-  provider: JsonRpcProvider,
-  account?: string | undefined,
-): Promise<Eip2612PermitUtils> {
-  const chainCache = CHAIN_UTILS_CACHE.get(chainId)
-
-  if (!account && chainCache) {
-    return chainCache
-  }
-  const providerCacheKey = `${chainId}-${account}`
-  const providerCache = PROVIDER_UTILS_CACHE.get(providerCacheKey)
-
-  if (providerCache) {
-    return providerCache
-  }
-
-  // TODO: allow to receive the signer as a parameter
-  const web3ProviderConnector = new PermitProviderConnector(provider, account ? undefined : PERMIT_SIGNER)
-  const Eip2612PermitUtilsClass = await import('../imports/1inchPermitUtils').then((r) => r.Eip2612PermitUtils)
-  const eip2612PermitUtils = new Eip2612PermitUtilsClass(web3ProviderConnector, { enabledCheckSalt: true })
-
-  if (!account) {
-    console.log(`[getPermitUtilsInstance] Set cached chain utils for chain ${chainId}`, eip2612PermitUtils)
-    CHAIN_UTILS_CACHE.set(chainId, eip2612PermitUtils)
-  } else {
-    console.log(
-      `[getPermitUtilsInstance] Set cached provider utils for chain ${chainId}-${account}`,
-      eip2612PermitUtils,
-    )
-    PROVIDER_UTILS_CACHE.set(providerCacheKey, eip2612PermitUtils)
-  }
-
-  return eip2612PermitUtils
-}