@cowprotocol/permit-utils 3.0.0 → 3.0.2

package/src/utils/PermitProviderConnector.ts

@@ -1,75 +0,0 @@
-import { defaultAbiCoder, ParamType } from '@ethersproject/abi'
-import { TypedDataField } from '@ethersproject/abstract-signer'
-import { BigNumber } from '@ethersproject/bignumber'
-import type { JsonRpcProvider } from '@ethersproject/providers'
-import { Wallet } from '@ethersproject/wallet'
-
-import { getContract } from './getContract'
-
-import type { AbiInput, AbiItem, EIP712TypedData, ProviderConnector } from '@1inch/permit-signed-approvals-utils'
-
-export class PermitProviderConnector implements ProviderConnector {
-  constructor(
-    private provider: JsonRpcProvider,
-    private walletSigner?: Wallet | undefined,
-  ) {}
-
-  contractEncodeABI(abi: AbiItem[], address: string | null, methodName: string, methodParams: unknown[]): string {
-    const contract = getContract(address || '', abi, this.provider)
-
-    return contract.interface.encodeFunctionData(methodName, methodParams)
-  }
-
-  signTypedData(_walletAddress: string, typedData: EIP712TypedData, _typedDataHash: string): Promise<string> {
-    // Removes `EIP712Domain` as it's already part of EIP712 (see https://ethereum.stackexchange.com/a/151930/55204)
-    // and EthersJS complains when a type is not needed (see https://github.com/ethers-io/ethers.js/discussions/4000)
-    const types = Object.keys(typedData.types).reduce<Record<string, TypedDataField[]>>((acc, type) => {
-      if (type !== 'EIP712Domain') {
-        acc[type] = typedData.types[type]
-      }
-      return acc
-    }, {})
-
-    const signer = this.walletSigner || this.provider.getSigner()
-
-    return signer._signTypedData(typedData.domain, types, typedData.message)
-  }
-
-  ethCall(contractAddress: string, callData: string): Promise<string> {
-    return this.provider.call({
-      to: contractAddress,
-      data: callData,
-    })
-  }
-
-  decodeABIParameter<T>(type: string, hex: string): T {
-    return defaultAbiCoder.decode([type], hex)[0]
-  }
-
-  decodeABIParameters<T>(types: AbiInput[], hex: string): T {
-    const decodedValues = defaultAbiCoder.decode(types as unknown as (ParamType | string)[], hex) as T
-
-    // Ethersjs decodes numbers as BigNumber instances
-    // However, 1inch utils do not deal with BigNumber instances,
-    // so we need this mess to convert them to hex strings, which 1inch understands
-    // TODO: Any way to make this typing mess any cleaner?
-    if (decodedValues && typeof decodedValues === 'object') {
-      const copy: Record<string, unknown> = {}
-
-      Object.keys(decodedValues).forEach((key) => {
-        // @ts-ignore
-        const value = decodedValues[key]
-        if (BigNumber.isBigNumber(value)) {
-          // @ts-ignore
-          copy[key] = value.toHexString()
-        } else {
-          copy[key] = value
-        }
-      })
-
-      return copy as T
-    }
-
-    return decodedValues
-  }
-}

package/src/utils/buildPermitCallData.ts

@@ -1,26 +0,0 @@
-import { oneInchPermitUtilsConsts } from '..'
-import { BuildDaiLikePermitCallDataParams, BuildEip2612PermitCallDataParams } from '../types'
-
-export async function buildEip2612PermitCallData({
-  eip2612Utils,
-  callDataParams,
-}: BuildEip2612PermitCallDataParams): Promise<string> {
-  const [permitParams, chainId, tokenName, ...rest] = callDataParams
-
-  const callData = await eip2612Utils.buildPermitCallData(permitParams, chainId, tokenName, ...rest)
-  // For some reason, the method above removes the permit selector prefix
-  // https://github.com/1inch/permit-signed-approvals-utils/blob/master/src/eip-2612-permit.utils.ts#L92
-  // Adding it back
-  return callData.replace('0x', oneInchPermitUtilsConsts.EIP_2612_PERMIT_SELECTOR)
-}
-
-export async function buildDaiLikePermitCallData({
-  eip2612Utils,
-  callDataParams,
-}: BuildDaiLikePermitCallDataParams): Promise<string> {
-  const callData = await eip2612Utils.buildDaiLikePermitCallData(...callDataParams)
-
-  // Same as above, but for dai like
-  // https://github.com/1inch/permit-signed-approvals-utils/blob/master/src/eip-2612-permit.utils.ts#L140
-  return callData.replace('0x', oneInchPermitUtilsConsts.DAI_PERMIT_SELECTOR)
-}

package/src/utils/getContract.ts

@@ -1,6 +0,0 @@
-import { Contract, ContractInterface } from '@ethersproject/contracts'
-import type { JsonRpcProvider } from '@ethersproject/providers'
-
-export function getContract(address: string, abi: ContractInterface, provider: JsonRpcProvider): Contract {
-  return new Contract(address, abi, provider)
-}

package/src/utils/getEip712Domain.ts

@@ -1,70 +0,0 @@
-import { getAddress } from '@ethersproject/address'
-import type { JsonRpcProvider } from '@ethersproject/providers'
-
-import { getContract } from './getContract'
-
-import Erc20Abi from '../abi/erc20.json'
-
-// See https://eips.ethereum.org/EIPS/eip-5267
-
-export async function getEip712Domain(
-  tokenAddress: string,
-  chainId: number,
-  provider: JsonRpcProvider,
-): Promise<Eip712Domain> {
-  const formattedAddress = getAddress(tokenAddress)
-  const erc20Contract = getContract(formattedAddress, Erc20Abi, provider)
-
-  const eip5267Domain: Required<Eip5267Return> = await erc20Contract.callStatic['eip712Domain']()
-
-  return processDomain(eip5267Domain, chainId, tokenAddress)
-}
-
-type Eip5267Return = {
-  fields: string
-  name?: string
-  version?: string
-  chainId?: string
-  verifyingContract?: string
-  salt?: string
-  extensions?: string[]
-}
-
-export type Eip712Domain = Omit<Eip5267Return, 'fields' | 'extensions'>
-
-/** Retrieves the EIP-712 domain of a contract using EIP-5267 without extensions.
- *
- * Derived from https://eips.ethereum.org/EIPS/eip-5267 reference Javascript implementation
- **/
-async function processDomain(domain: Required<Eip5267Return>, chainId: number, address: string): Promise<Eip712Domain> {
-  const { extensions, ...rest } = domain
-
-  if (extensions.length > 0) {
-    throw Error('Extensions not implemented')
-  }
-
-  if (rest.chainId && chainId !== parseInt(rest.chainId, 16)) {
-    throw Error(`ChainId mismatch. Received: '${rest.chainId}', expected: '${chainId}'`)
-  }
-
-  if (rest.verifyingContract && address.toLowerCase() !== rest.verifyingContract.toLowerCase()) {
-    throw Error(`Address mismatch. Received: '${rest.verifyingContract}', expected: '${address}'`)
-  }
-
-  return buildBasicDomain(rest)
-}
-
-const FIELD_NAMES = ['name', 'version', 'chainId', 'verifyingContract', 'salt']
-
-/** Builds a domain object without extensions based on the return values of `eip712Domain()`. */
-function buildBasicDomain(domain: Required<Omit<Eip5267Return, 'extensions'>>): Eip712Domain {
-  // Will be a 5bit number as a hex string
-  const fields = parseInt(domain.fields, 16)
-
-  return FIELD_NAMES.reduce<Eip712Domain>((acc, field, i) => {
-    if (fields & (1 << i)) {
-      acc[field as keyof Eip712Domain] = domain[field as keyof Omit<Eip5267Return, 'extensions'>]
-    }
-    return acc
-  }, {})
-}

package/src/utils/getPermitDeadline.ts

@@ -1,7 +0,0 @@
-import { DEFAULT_PERMIT_DURATION } from '../const'
-
-// TODO: Add proper return type annotation
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function getPermitDeadline() {
-  return Math.ceil((Date.now() + DEFAULT_PERMIT_DURATION) / 1000)
-}

package/src/utils/getTokenName.ts

@@ -1,13 +0,0 @@
-import { getAddress } from '@ethersproject/address'
-import type { JsonRpcProvider } from '@ethersproject/providers'
-
-import { getContract } from './getContract'
-
-import Erc20Abi from '../abi/erc20.json'
-
-export async function getTokenName(tokenAddress: string, chainId: number, provider: JsonRpcProvider): Promise<string> {
-  const formattedAddress = getAddress(tokenAddress)
-  const erc20Contract = getContract(formattedAddress, Erc20Abi, provider)
-
-  return erc20Contract.callStatic['name']()
-}

package/src/utils/getTokenPermitVersion.ts

@@ -1,35 +0,0 @@
-import { defaultAbiCoder } from '@ethersproject/abi'
-import type { JsonRpcProvider } from '@ethersproject/providers'
-
-import { getContract } from './getContract'
-
-import { VERSION_ABIS } from '../abi/versionAbis'
-
-export async function getTokenPermitVersion(
-  tokenAddress: string,
-  provider: JsonRpcProvider,
-  index = 0,
-): Promise<string> {
-  const abi = VERSION_ABIS[index]
-
-  if (!abi) {
-    return '1'
-  }
-
-  try {
-    const contract = 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 defaultAbiCoder.decode(['string'], response).toString()
-  } catch {
-    return getTokenPermitVersion(tokenAddress, provider, index + 1)
-  }
-}

package/src/utils/isSupportedPermitInfo.ts

@@ -1,5 +0,0 @@
-import { PermitInfo } from '../types'
-
-export function isSupportedPermitInfo(p: PermitInfo | undefined): p is PermitInfo {
-  return !!p && p.type !== 'unsupported'
-}

package/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "module": "commonjs",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "declaration": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "exclude": ["src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc",
-    "module": "commonjs",
-    "types": ["jest", "node"]
-  },
-  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
-}

package/vite.config.mts

@@ -1,51 +0,0 @@
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
-import macrosPlugin from 'vite-plugin-babel-macros'
-import dts from 'vite-plugin-dts'
-import viteTsConfigPaths from 'vite-tsconfig-paths'
-
-import * as path from 'path'
-
-export default defineConfig({
-  root: path.resolve(__dirname, './'),
-  cacheDir: '../../../node_modules/.vite/permit-utils',
-
-  plugins: [
-    dts({
-      entryRoot: 'src',
-      tsconfigPath: path.join(__dirname, 'tsconfig.lib.json'),
-    }),
-
-    macrosPlugin(),
-
-    viteTsConfigPaths({
-      root: '../../../',
-    }),
-  ],
-  // Uncomment this if you are using workers.
-  // worker: {
-  //  plugins: [
-  //    viteTsConfigPaths({
-  //      root: '../../',
-  //    }),
-  //  ],
-  // },
-
-  // Configuration for building your library.
-  // See: https://vitejs.dev/guide/build.html#library-mode
-  build: {
-    lib: {
-      // Could also be a dictionary or array of multiple entry points.
-      entry: 'src/index.ts',
-      name: 'permit-utils',
-      fileName: 'index',
-      // Change this to the formats you want to support.
-      // Don't forget to update your package.json as well.
-      formats: ['es', 'cjs'],
-    },
-    rollupOptions: {
-      // External packages that should not be bundled into your library.
-      external: [/@1inch/, /@cowprotocol/, /@ethersproject/],
-    },
-  },
-})