@cowprotocol/permit-utils 0.0.1-RC.0 → 0.0.1

package/README.md

@@ -0,0 +1,153 @@
+# @cowprotocol/permit-utils
+
+Collection of utils for handling token permits.
+
+## Installation
+
+```bash
+yarn add @cowprotocol/permit-utils
+```
+
+## Usage
+
+### `getTokenPermitInfo`
+
+```typescript
+import { getTokenPermitInfo } from "@cowprotocol/permit-utils"
+
+const permitInfo = await getTokenPermitInfo({
+  spender, tokenAddress, tokenName, chainId, provider
+})
+```
+
+### `getPermitUtilsInstance`
+
+```typescript
+import { getPermitUtilsInstance } from "@cowprotocol/permit-utils"
+
+// Using the a static account defined in the library
+const staticEip2612PermitUtils = getPermitUtilsInstance(chainId, provider)
+
+// Using a provided account address
+const accountEip2612PermitUtils = getPermitUtilsInstance(chainId, provider, account)
+```
+
+### `generatePermitHook`
+
+```typescript
+import { generatePermitHook } from "@cowprotocol/permit-utils"
+
+const hookData = await generatePermitHook({
+  chainId,
+  inputToken,
+  spender,
+  provider,
+  permitInfo,
+  eip2162Utils,
+  account,
+  nonce
+})
+```
+
+### `checkIsCallDataAValidPermit`
+
+```typescript
+import { checkIsCallDataAValidPermit } from "@cowprotocol/permit-utils"
+
+const isCallDataAValidPermit = await checkIsCallDataAValidPermit(
+  account,
+  chainId,
+  eip2612Utils, 
+  tokenAddress,
+  tokenName,
+  callData,
+  permitInfo
+)
+```
+
+**Full flow example**
+
+To illustrate, we'll show the flow of placing an order with a permit hook using the utils in this lib. 
+
+1. Check whether a given token is permittable
+2. If it is, generate a permit hook
+3. Add permit hook to order's appData
+4. Periodically check whether the permit is still valid
+
+```typescript
+import { checkIsCallDataAValidPermit, generatePermitHook, getPermitUtilsInstance, getTokenPermitInfo } from '@cowprotocol/permit-utils'
+import { stringifyDeterministic } from '@cowprotocol/app-data'
+import { OrderBookApi } from '@cowprotocol/cow-sdk'
+
+
+// Check whether token is permittable.
+// No account info is necessary.
+// `spender` could in theory be any address
+// `tokenName` must always match the contract
+const permitInfo = await getTokenPermitInfo({
+  spender, tokenAddress, tokenName, chainId, provider
+})
+
+// Not able to tell or not permittable
+if (!permitInfo) {
+  return
+}
+
+// Pass in an account address as we'll need the user to sign the actual permit
+const eip2612Utils = getPermitUtilsInstance(chainId, provider, account)
+
+// Need to know what the current permit nonce is
+const nonce = await eip2162Utils.getTokenNonce(inputToken.address, account)
+
+// Calling this fn should trigger the signature in the user's wallet
+const hookData = await generatePermitHook({
+  chainId,
+  inputToken,
+  spender, // Now `spender` must be the real one
+  provider,
+  permitInfo,
+  eip2612Utils,
+  account, // `account` should also be the user's
+  nonce
+})
+
+// Add the hookData to the order's appData
+// See the full reference on https://github.com/cowprotocol/app-data/
+const appData = { version: '0.10.0', metadata: { hooks: { pre: [hookData] } } }
+
+// The order expects the stringified JSON doc
+const fullAppData = await stringifyDeterministic(appData)
+
+// Build cow-sdk orderBookApi instance
+const orderBookApi = new OrderBookApi()
+
+// Note: price quoting is a required step before placing the order but has been left out of this example for brevity
+
+// Place order
+const orderId = await orderBookApi.sendOrder(
+  {
+    ...orderParameters,
+    quoteId, // Must be fetched before hand, and also include the appData in the params
+    appData: fullAppData // <-- The order will be placed with the permit info
+  },
+  { chainId }
+)
+
+// Now we check whether the permit included in the order is still valid
+// It'll become invalid when another permit is executed
+// This check does not consider whether the `address` has enough allowance, it purelly checks the permit validity.
+
+// CallData is part of the hookData
+const callData = hookData.callData
+
+// All properties must match what was used when the hookData was generated
+const isCallDataAValidPermit = await checkIsCallDataAValidPermit(
+  account,
+  chainId,
+  eip2612Utils,
+  tokenAddress,
+  tokenName,
+  callData,
+  permitInfo
+)
+```

package/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("@1inch/permit-signed-approvals-utils"),L=require("@ethersproject/constants"),M=require("@ethersproject/wallet"),w=require("@ethersproject/abi"),U=require("@ethersproject/bignumber"),N=require("@ethersproject/contracts");function A(a){return a==="USD//C"?"USD Coin":a}async function O(a,t,e,n,o,r,{version:i}){const s={chainId:t,tokenName:A(o),tokenAddress:n,callData:r,version:i};let c;if(r.startsWith(u.EIP_2612_PERMIT_SELECTOR)?c=e.recoverPermitOwnerFromCallData({...s,callData:r.replace(u.EIP_2612_PERMIT_SELECTOR,"0x")}):r.startsWith(u.DAI_PERMIT_SELECTOR)&&(c=e.recoverDaiLikePermitOwnerFromCallData({...s,callData:r.replace(u.DAI_PERMIT_SELECTOR,"0x")})),!!c)try{return(await c).toLowerCase()===a.toLowerCase()}catch(d){return console.debug(`[checkHasValidPendingPermit] Failed to check permit validity for owner ${a} with callData ${r}`,d),!1}}const $="0xc58a2a421ca71ca57ae698f1c32feeb0b0ccb434da0b8089d88d80fb918f3f9d",f=new M.Wallet($),H={1:55e3,100:55e3,5:36e3},I="80000",D=L.MaxUint256.toString(),F=157788e6,x=new Set(["0x6b175474e89094c44da98b954eedeac495271d0f"]);async function y({eip2162Utils:a,callDataParams:t}){const[e,n,o,...r]=t;return(await a.buildPermitCallData(e,n,A(o),...r)).replace("0x",u.EIP_2612_PERMIT_SELECTOR)}async function S({eip2162Utils:a,callDataParams:t}){return(await a.buildDaiLikePermitCallData(...t)).replace("0x",u.DAI_PERMIT_SELECTOR)}function p(){return Math.ceil((Date.now()+F)/1e3)}const g={};async function q(a){const t=V(a),e=g[t];if(e)try{return await e}catch(o){console.debug("[generatePermitHookWith] cached request failed",o),delete g[t]}const n=G(a).then(o=>(delete g[t],o));return g[t]=n,n}async function G(a){const{inputToken:t,spender:e,chainId:n,permitInfo:o,provider:r,account:i,eip2162Utils:s,nonce:c}=a,d=t.address,m=t.name||d,l=i||f.address,P=c===void 0?await s.getTokenNonce(d,l):c,h=p(),E=D,T=o.type==="eip-2612"?await y({eip2162Utils:s,callDataParams:[{owner:l,spender:e,value:E,nonce:P,deadline:h},n,m,d,o.version]}):await S({eip2162Utils:s,callDataParams:[{holder:l,spender:e,allowed:!0,value:E,nonce:P,expiry:h},n,m,d,o.version]}),R=await K(T,l,d,r,!!i);return{target:d,callData:T,gasLimit:R}}async function K(a,t,e,n,o){try{const r=await n.estimateGas({data:a,from:t,to:e}),i=o?r:r.add(r.div(10));return i.gt(I)?i.toString():I}catch(r){return console.debug("[calculatePermitGasLimit] Failed to estimateGas, using default",r),I}}function V(a){const{inputToken:t,chainId:e,account:n}=a;return`${t.address.toLowerCase()}-${e}${n?`-${n.toLowerCase()}`:""}`}class B{constructor(t,e){this.provider=t,this.walletSigner=e}getContract(t,e,n){return new N.Contract(t,e,n)}contractEncodeABI(t,e,n,o){return this.getContract(e||"",t,this.provider).interface.encodeFunctionData(n,o)}signTypedData(t,e,n){const o=Object.keys(e.types).reduce((i,s)=>(s!=="EIP712Domain"&&(i[s]=e.types[s]),i),{});return(this.walletSigner||this.provider.getSigner())._signTypedData(e.domain,o,e.message)}ethCall(t,e){return this.provider.call({to:t,data:e})}decodeABIParameter(t,e){return w.defaultAbiCoder.decode([t],e)[0]}decodeABIParameters(t,e){const n=w.defaultAbiCoder.decode(t,e);if(n&&typeof n=="object"){const o={};return Object.keys(n).forEach(r=>{const i=n[r];U.BigNumber.isBigNumber(i)?o[r]=i.toHexString():o[r]=i}),o}return n}}const k=new Map,_=new Map;function v(a,t,e){const n=k.get(a);if(!e&&n)return n;const o=`${a}-${e}`,r=_.get(o);if(r)return r;const i=new B(t,e?void 0:f),s=new u.Eip2612PermitUtils(i);return e?(console.log(`[getPermitUtilsInstance] Set cached provider utils for chain ${a}-${e}`,s),_.set(o,s)):(console.log(`[getPermitUtilsInstance] Set cached chain utils for chain ${a}`,s),k.set(a,s)),s}const j={value:D,nonce:0,deadline:p()},W={allowed:!0,nonce:0,expiry:p()},C={};async function Q(a){const{tokenAddress:t,chainId:e}=a,n=`${e}-${t.toLowerCase()}`,o=C[n];if(o)return o;const r=Y(a);return C[n]=r,r}async function Y(a){const{spender:t,tokenAddress:e,tokenName:n,chainId:o,provider:r}=a,i=v(o,r),s=f.address;let c;try{c=await i.getTokenNonce(e,s)}catch(l){return l==="nonce not supported"||l.message==="nonce is NaN"?(console.debug(`[checkTokenIsPermittable] Not a permittable token ${e}`,l?.message||l),!1):(console.debug(`[checkTokenIsPermittable] Failed to get nonce for ${e}`,l),{error:l.message||l.toString()})}let d;if(!x.has(e))try{d=await i.getTokenVersion(e)}catch(l){console.debug(`[checkTokenIsPermittable] Failed to get version for ${e}`,l)}const m={chainId:o,eip2612PermitUtils:i,nonce:c,spender:t,tokenAddress:e,tokenName:n,walletAddress:s,version:d};try{return await b({...m,type:"eip-2612",provider:r})}catch(l){console.debug(`[checkTokenIsPermittable] Failed to estimate eip-2612 permit for ${e}`,l);try{return await b({...m,type:"dai-like",provider:r})}catch(P){return console.debug(`[checkTokenIsPermittable] Failed to estimate dai-like permit for ${e}`,P),{error:P.message||P.toString()}}}}async function b(a){const{provider:t,chainId:e,walletAddress:n,tokenAddress:o,type:r,version:i}=a,c=await(r==="eip-2612"?z:J)(a);return c&&(await t.estimateGas({data:c,from:n,to:o})).toNumber()>H[e]?{type:r,version:i}:!1}async function z(a){const{eip2612PermitUtils:t,walletAddress:e,spender:n,nonce:o,chainId:r,tokenName:i,tokenAddress:s,version:c}=a;return y({eip2162Utils:t,callDataParams:[{...j,owner:e,spender:n,nonce:o},+r,i,s,c]})}async function J(a){const{eip2612PermitUtils:t,tokenAddress:e,walletAddress:n,spender:o,nonce:r,chainId:i,tokenName:s,version:c}=a;return await t.getPermitTypeHash(e)===u.DAI_LIKE_PERMIT_TYPEHASH?S({eip2162Utils:t,callDataParams:[{...W,holder:n,spender:o,nonce:r},i,s,e,c]}):!1}exports.checkIsCallDataAValidPermit=O;exports.generatePermitHook=q;exports.getPermitUtilsInstance=v;exports.getTokenPermitInfo=Q;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const p=require("@1inch/permit-signed-approvals-utils"),M=require("@ethersproject/constants"),U=require("@ethersproject/wallet"),w=require("@ethersproject/abi"),H=require("@ethersproject/bignumber"),O=require("@ethersproject/contracts"),F=require("@ethersproject/address");function A(t){return t==="USD//C"?"USD Coin":t}async function q(t,n,e,a,o,r,{version:i,type:c,name:l}){const d=l||o;if(c==="unsupported")return!1;if(!d)throw new Error(`No token name for ${a}`);const m={chainId:n,tokenName:A(d),tokenAddress:a,callData:r,version:i};let u;if(r.startsWith(p.EIP_2612_PERMIT_SELECTOR)?u=e.recoverPermitOwnerFromCallData({...m,callData:r.replace(p.EIP_2612_PERMIT_SELECTOR,"0x")}):r.startsWith(p.DAI_PERMIT_SELECTOR)&&(u=e.recoverDaiLikePermitOwnerFromCallData({...m,callData:r.replace(p.DAI_PERMIT_SELECTOR,"0x")})),!!u)try{return(await u).toLowerCase()===t.toLowerCase()}catch(s){return console.debug(`[checkHasValidPendingPermit] Failed to check permit validity for owner ${t} with callData ${r}`,s),!1}}const x="0xec10458cfaafb32533a4a27e18d9da345758094dde7052521b939a41c55dd1b0",h=new U.Wallet(x),G={1:55e3,100:55e3,5:36e3},I="80000",D=M.MaxUint256.toString(),K=157788e6,V=new Set(["0x6b175474e89094c44da98b954eedeac495271d0f"]);async function S({eip2162Utils:t,callDataParams:n}){const[e,a,o,...r]=n;return(await t.buildPermitCallData(e,a,A(o),...r)).replace("0x",p.EIP_2612_PERMIT_SELECTOR)}async function v({eip2162Utils:t,callDataParams:n}){return(await t.buildDaiLikePermitCallData(...n)).replace("0x",p.DAI_PERMIT_SELECTOR)}function T(){return Math.ceil((Date.now()+K)/1e3)}function L(t){return!!t&&t.type!=="unsupported"}const f={};async function B(t){const n=Q(t),e=f[n];if(e)try{return await e}catch(o){console.debug("[generatePermitHookWith] cached request failed",o),delete f[n]}const a=j(t).then(o=>(delete f[n],o));return f[n]=a,a}async function j(t){const{inputToken:n,spender:e,chainId:a,permitInfo:o,provider:r,account:i,eip2162Utils:c,nonce:l}=t,d=n.address,m=o.name||n.name;if(!L(o))throw new Error(`Trying to generate permit hook for unsupported token: ${d}`);if(!m)throw new Error(`No token name for token: ${d}`);const u=i||h.address,s=l===void 0?await c.getTokenNonce(d,u):l,P=T(),k=D,E=o.type==="eip-2612"?await S({eip2162Utils:c,callDataParams:[{owner:u,spender:e,value:k,nonce:s,deadline:P},a,m,d,o.version]}):await v({eip2162Utils:c,callDataParams:[{holder:u,spender:e,allowed:!0,value:k,nonce:s,expiry:P},a,m,d,o.version]}),N=await W(E,u,d,r,!!i);return{target:d,callData:E,gasLimit:N}}async function W(t,n,e,a,o){try{const r=await a.estimateGas({data:t,from:n,to:e}),i=o?r:r.add(r.div(10));return i.gt(I)?i.toString():I}catch(r){return console.debug("[calculatePermitGasLimit] Failed to estimateGas, using default",r),I}}function Q(t){const{inputToken:n,chainId:e,account:a}=t;return`${n.address.toLowerCase()}-${e}${a?`-${a.toLowerCase()}`:""}`}function R(t,n,e){return new O.Contract(t,n,e)}class Y{constructor(n,e){this.provider=n,this.walletSigner=e}contractEncodeABI(n,e,a,o){return R(e||"",n,this.provider).interface.encodeFunctionData(a,o)}signTypedData(n,e,a){const o=Object.keys(e.types).reduce((i,c)=>(c!=="EIP712Domain"&&(i[c]=e.types[c]),i),{});return(this.walletSigner||this.provider.getSigner())._signTypedData(e.domain,o,e.message)}ethCall(n,e){return this.provider.call({to:n,data:e})}decodeABIParameter(n,e){return w.defaultAbiCoder.decode([n],e)[0]}decodeABIParameters(n,e){const a=w.defaultAbiCoder.decode(n,e);if(a&&typeof a=="object"){const o={};return Object.keys(a).forEach(r=>{const i=a[r];H.BigNumber.isBigNumber(i)?o[r]=i.toHexString():o[r]=i}),o}return a}}const _=new Map,y=new Map;function $(t,n,e){const a=_.get(t);if(!e&&a)return a;const o=`${t}-${e}`,r=y.get(o);if(r)return r;const i=new Y(n,e?void 0:h),c=new p.Eip2612PermitUtils(i);return e?(console.log(`[getPermitUtilsInstance] Set cached provider utils for chain ${t}-${e}`,c),y.set(o,c)):(console.log(`[getPermitUtilsInstance] Set cached chain utils for chain ${t}`,c),_.set(t,c)),c}const z=[{constant:!0,inputs:[],name:"name",outputs:[{name:"",type:"string"}],payable:!1,stateMutability:"view",type:"function"}];async function J(t,n,e){const a=F.getAddress(t);return R(a,z,e).callStatic.name()}const X={value:D,nonce:0,deadline:T()},Z={allowed:!0,nonce:0,expiry:T()},C={},g={type:"unsupported"};async function ee(t){const{tokenAddress:n,chainId:e}=t,a=`${e}-${n.toLowerCase()}`,o=C[a];if(o)return o;const r=te(t);return C[a]=r,r}async function te(t){const{spender:n,tokenAddress:e,tokenName:a,chainId:o,provider:r}=t,i=$(o,r),c=h.address;let l=a;try{l=await J(e,o,r)}catch(s){if(/ETIMEDOUT/.test(s)&&!l)return{error:"Failed to fetch token name from contract. RPC connection error"};console.debug(`[checkTokenIsPermittable] Couldn't fetch token name from the contract for token ${e}, using provided '${l}'`,s)}if(!l)return{error:`Token name could not be determined for ${e}`};let d;try{d=await i.getTokenNonce(e,c)}catch(s){return s==="nonce not supported"||s.message==="nonce is NaN"?(console.debug(`[checkTokenIsPermittable] Not a permittable token ${e} - ${l}`,s?.message||s),{...g,name:l}):(console.debug(`[checkTokenIsPermittable] Failed to get nonce for ${e} - ${l}`,s),{error:s.message||s.toString()})}let m;if(!V.has(e))try{m=await i.getTokenVersion(e)}catch(s){console.debug(`[checkTokenIsPermittable] Failed to get version for ${e} - ${l}`,s)}const u={chainId:o,eip2612PermitUtils:i,nonce:d,spender:n,tokenAddress:e,tokenName:l,walletAddress:c,version:m};try{return await b({...u,type:"eip-2612",provider:r})}catch(s){try{return await re(e,i)?await b({...u,type:"dai-like",provider:r}):/invalid signature/.test(s)||s?.code==="UNPREDICTABLE_GAS_LIMIT"?(console.debug(`[checkTokenIsPermittable] Token ${e} - ${l} might be permittable, but it's not supported for now. Reason:`,s?.reason),{...g,name:l}):(console.debug(`[checkTokenIsPermittable] Failed to estimate eip-2612 permit for ${e} - ${l}`,s),{error:s.message||s.toString()})}catch(P){return console.debug(`[checkTokenIsPermittable] Failed to estimate dai-like permit for ${e} - ${l}`,P),{error:P.message||P.toString()}}}}async function b(t){const{provider:n,chainId:e,walletAddress:a,tokenAddress:o,tokenName:r,type:i,version:c}=t,d=await(i==="eip-2612"?ne:ae)(t);return d?(await n.estimateGas({data:d,from:a,to:o})).toNumber()>G[e]?{type:i,version:c,name:r}:{...g,name:r}:{...g,name:r}}async function ne(t){const{eip2612PermitUtils:n,walletAddress:e,spender:a,nonce:o,chainId:r,tokenName:i,tokenAddress:c,version:l}=t;return S({eip2162Utils:n,callDataParams:[{...X,owner:e,spender:a,nonce:o},+r,i,c,l]})}async function re(t,n){return await n.getPermitTypeHash(t)===p.DAI_LIKE_PERMIT_TYPEHASH}async function ae(t){const{eip2612PermitUtils:n,tokenAddress:e,walletAddress:a,spender:o,nonce:r,chainId:i,tokenName:c,version:l}=t;return await n.getPermitTypeHash(e)===p.DAI_LIKE_PERMIT_TYPEHASH?v({eip2162Utils:n,callDataParams:[{...Z,holder:a,spender:o,nonce:r},i,c,e,l]}):!1}exports.checkIsCallDataAValidPermit=q;exports.generatePermitHook=B;exports.getPermitUtilsInstance=$;exports.getTokenPermitInfo=ee;exports.isSupportedPermitInfo=L;

package/index.d.ts

@@ -2,4 +2,5 @@ export { checkIsCallDataAValidPermit } from './lib/checkIsCallDataAValidPermit';
 export { generatePermitHook } from './lib/generatePermitHook';
 export { getPermitUtilsInstance } from './lib/getPermitUtilsInstance';
 export { getTokenPermitInfo } from './lib/getTokenPermitInfo';
-export type { PermitHookData, PermitHookParams, PermitInfo, PermitType, SupportedPermitInfo, GetTokenPermitIntoResult, } from './types';
+export { isSupportedPermitInfo } from './utils/isSupportedPermitInfo';
+export type { PermitHookData, PermitHookParams, PermitInfo, PermitType, GetTokenPermitIntoResult } from './types';

package/index.js

@@ -1,311 +1,382 @@
-import { EIP_2612_PERMIT_SELECTOR as P, DAI_PERMIT_SELECTOR as g, Eip2612PermitUtils as R, DAI_LIKE_PERMIT_TYPEHASH as U } from "@1inch/permit-signed-approvals-utils";
-import { MaxUint256 as N } from "@ethersproject/constants";
-import { Wallet as M } from "@ethersproject/wallet";
-import { defaultAbiCoder as E } from "@ethersproject/abi";
-import { BigNumber as $ } from "@ethersproject/bignumber";
-import { Contract as H } from "@ethersproject/contracts";
-function D(a) {
-  return a === "USD//C" ? "USD Coin" : a;
+import { EIP_2612_PERMIT_SELECTOR as h, DAI_PERMIT_SELECTOR as k, Eip2612PermitUtils as U, DAI_LIKE_PERMIT_TYPEHASH as A } from "@1inch/permit-signed-approvals-utils";
+import { MaxUint256 as M } from "@ethersproject/constants";
+import { Wallet as H } from "@ethersproject/wallet";
+import { defaultAbiCoder as y } from "@ethersproject/abi";
+import { BigNumber as F } from "@ethersproject/bignumber";
+import { Contract as O } from "@ethersproject/contracts";
+import { getAddress as x } from "@ethersproject/address";
+function v(t) {
+  return t === "USD//C" ? "USD Coin" : t;
 }
-async function ae(a, t, e, n, o, r, {
-  version: i
+async function ue(t, n, e, o, a, r, {
+  version: i,
+  type: c,
+  name: l
 }) {
-  const s = {
-    chainId: t,
-    tokenName: D(o),
-    tokenAddress: n,
+  const d = l || a;
+  if (c === "unsupported")
+    return !1;
+  if (!d)
+    throw new Error(`No token name for ${o}`);
+  const u = {
+    chainId: n,
+    tokenName: v(d),
+    tokenAddress: o,
     callData: r,
     version: i
   };
-  let c;
-  if (r.startsWith(P) ? c = e.recoverPermitOwnerFromCallData({
-    ...s,
+  let m;
+  if (r.startsWith(h) ? m = e.recoverPermitOwnerFromCallData({
+    ...u,
     // 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: r.replace(P, "0x")
-  }) : r.startsWith(g) && (c = e.recoverDaiLikePermitOwnerFromCallData({
-    ...s,
-    callData: r.replace(g, "0x")
-  })), !!c)
+    callData: r.replace(h, "0x")
+  }) : r.startsWith(k) && (m = e.recoverDaiLikePermitOwnerFromCallData({
+    ...u,
+    callData: r.replace(k, "0x")
+  })), !!m)
     try {
-      return (await c).toLowerCase() === a.toLowerCase();
-    } catch (d) {
-      return console.debug(`[checkHasValidPendingPermit] Failed to check permit validity for owner ${a} with callData ${r}`, d), !1;
+      return (await m).toLowerCase() === t.toLowerCase();
+    } catch (s) {
+      return console.debug(`[checkHasValidPendingPermit] Failed to check permit validity for owner ${t} with callData ${r}`, s), !1;
     }
 }
-const F = "0xc58a2a421ca71ca57ae698f1c32feeb0b0ccb434da0b8089d88d80fb918f3f9d", h = new M(F), O = {
+const G = "0xec10458cfaafb32533a4a27e18d9da345758094dde7052521b939a41c55dd1b0", w = new H(G), K = {
   1: 55e3,
   100: 55e3,
   5: 36e3
-}, p = "80000", b = N.toString(), x = 157788e6, G = /* @__PURE__ */ new Set(["0x6b175474e89094c44da98b954eedeac495271d0f"]);
-async function v({
-  eip2162Utils: a,
-  callDataParams: t
+}, P = "80000", S = M.toString(), V = 157788e6, B = /* @__PURE__ */ new Set(["0x6b175474e89094c44da98b954eedeac495271d0f"]);
+async function L({
+  eip2162Utils: t,
+  callDataParams: n
 }) {
-  const [e, n, o, ...r] = t;
-  return (await a.buildPermitCallData(e, n, D(o), ...r)).replace("0x", P);
+  const [e, o, a, ...r] = n;
+  return (await t.buildPermitCallData(e, o, v(a), ...r)).replace("0x", h);
 }
-async function S({
-  eip2162Utils: a,
-  callDataParams: t
+async function $({
+  eip2162Utils: t,
+  callDataParams: n
 }) {
-  return (await a.buildDaiLikePermitCallData(...t)).replace("0x", g);
+  return (await t.buildDaiLikePermitCallData(...n)).replace("0x", k);
 }
-function I() {
-  return Math.ceil((Date.now() + x) / 1e3);
+function T() {
+  return Math.ceil((Date.now() + V) / 1e3);
+}
+function q(t) {
+  return !!t && t.type !== "unsupported";
 }
 const f = {};
-async function oe(a) {
-  const t = B(a), e = f[t];
+async function pe(t) {
+  const n = Q(t), e = f[n];
   if (e)
     try {
       return await e;
-    } catch (o) {
-      console.debug("[generatePermitHookWith] cached request failed", o), delete f[t];
+    } catch (a) {
+      console.debug("[generatePermitHookWith] cached request failed", a), delete f[n];
     }
-  const n = K(a).then((o) => (delete f[t], o));
-  return f[t] = n, n;
+  const o = W(t).then((a) => (delete f[n], a));
+  return f[n] = o, o;
 }
-async function K(a) {
+async function W(t) {
   const {
-    inputToken: t,
+    inputToken: n,
     spender: e,
-    chainId: n,
-    permitInfo: o,
+    chainId: o,
+    permitInfo: a,
     provider: r,
     account: i,
-    eip2162Utils: s,
-    nonce: c
-  } = a, d = t.address, m = t.name || d, l = i || h.address, u = c === void 0 ? await s.getTokenNonce(d, l) : c, w = I(), k = b, T = o.type === "eip-2612" ? await v({
-    eip2162Utils: s,
+    eip2162Utils: c,
+    nonce: l
+  } = t, d = n.address, u = a.name || n.name;
+  if (!q(a))
+    throw new Error(`Trying to generate permit hook for unsupported token: ${d}`);
+  if (!u)
+    throw new Error(`No token name for token: ${d}`);
+  const m = i || w.address, s = l === void 0 ? await c.getTokenNonce(d, m) : l, p = T(), I = S, E = a.type === "eip-2612" ? await L({
+    eip2162Utils: c,
     callDataParams: [{
-      owner: l,
+      owner: m,
       spender: e,
-      value: k,
-      nonce: u,
-      deadline: w
-    }, n, m, d, o.version]
-  }) : await S({
-    eip2162Utils: s,
+      value: I,
+      nonce: s,
+      deadline: p
+    }, o, u, d, a.version]
+  }) : await $({
+    eip2162Utils: c,
     callDataParams: [{
-      holder: l,
+      holder: m,
       spender: e,
       allowed: !0,
-      value: k,
-      nonce: u,
-      expiry: w
-    }, n, m, d, o.version]
-  }), L = await V(T, l, d, r, !!i);
+      value: I,
+      nonce: s,
+      expiry: p
+    }, o, u, d, a.version]
+  }), R = await j(E, m, d, r, !!i);
   return {
     target: d,
-    callData: T,
-    gasLimit: L
+    callData: E,
+    gasLimit: R
   };
 }
-async function V(a, t, e, n, o) {
+async function j(t, n, e, o, a) {
   try {
-    const r = await n.estimateGas({
-      data: a,
-      from: t,
+    const r = await o.estimateGas({
+      data: t,
+      from: n,
       to: e
-    }), i = o ? r : r.add(r.div(10));
-    return i.gt(p) ? i.toString() : p;
+    }), i = a ? r : r.add(r.div(10));
+    return i.gt(P) ? i.toString() : P;
   } catch (r) {
-    return console.debug("[calculatePermitGasLimit] Failed to estimateGas, using default", r), p;
+    return console.debug("[calculatePermitGasLimit] Failed to estimateGas, using default", r), P;
   }
 }
-function B(a) {
+function Q(t) {
   const {
-    inputToken: t,
+    inputToken: n,
     chainId: e,
-    account: n
-  } = a;
-  return `${t.address.toLowerCase()}-${e}${n ? `-${n.toLowerCase()}` : ""}`;
+    account: o
+  } = t;
+  return `${n.address.toLowerCase()}-${e}${o ? `-${o.toLowerCase()}` : ""}`;
 }
-class q {
-  constructor(t, e) {
-    this.provider = t, this.walletSigner = e;
-  }
-  getContract(t, e, n) {
-    return new H(t, e, n);
+function N(t, n, e) {
+  return new O(t, n, e);
+}
+class Y {
+  constructor(n, e) {
+    this.provider = n, this.walletSigner = e;
   }
-  contractEncodeABI(t, e, n, o) {
-    return this.getContract(e || "", t, this.provider).interface.encodeFunctionData(n, o);
+  contractEncodeABI(n, e, o, a) {
+    return N(e || "", n, this.provider).interface.encodeFunctionData(o, a);
   }
-  signTypedData(t, e, n) {
-    const o = Object.keys(e.types).reduce((i, s) => (s !== "EIP712Domain" && (i[s] = e.types[s]), i), {});
-    return (this.walletSigner || this.provider.getSigner())._signTypedData(e.domain, o, e.message);
+  signTypedData(n, e, o) {
+    const a = Object.keys(e.types).reduce((i, c) => (c !== "EIP712Domain" && (i[c] = e.types[c]), i), {});
+    return (this.walletSigner || this.provider.getSigner())._signTypedData(e.domain, a, e.message);
   }
-  ethCall(t, e) {
+  ethCall(n, e) {
     return this.provider.call({
-      to: t,
+      to: n,
       data: e
     });
   }
-  decodeABIParameter(t, e) {
-    return E.decode([t], e)[0];
+  decodeABIParameter(n, e) {
+    return y.decode([n], e)[0];
   }
-  decodeABIParameters(t, e) {
-    const n = E.decode(t, e);
-    if (n && typeof n == "object") {
-      const o = {};
-      return Object.keys(n).forEach((r) => {
-        const i = n[r];
-        $.isBigNumber(i) ? o[r] = i.toHexString() : o[r] = i;
-      }), o;
+  decodeABIParameters(n, e) {
+    const o = y.decode(n, e);
+    if (o && typeof o == "object") {
+      const a = {};
+      return Object.keys(o).forEach((r) => {
+        const i = o[r];
+        F.isBigNumber(i) ? a[r] = i.toHexString() : a[r] = i;
+      }), a;
     }
-    return n;
+    return o;
   }
 }
-const C = /* @__PURE__ */ new Map(), _ = /* @__PURE__ */ new Map();
-function W(a, t, e) {
-  const n = C.get(a);
-  if (!e && n)
-    return n;
-  const o = `${a}-${e}`, r = _.get(o);
+const C = /* @__PURE__ */ new Map(), b = /* @__PURE__ */ new Map();
+function z(t, n, e) {
+  const o = C.get(t);
+  if (!e && o)
+    return o;
+  const a = `${t}-${e}`, r = b.get(a);
   if (r)
     return r;
-  const i = new q(t, e ? void 0 : h), s = new R(i);
-  return e ? (console.log(`[getPermitUtilsInstance] Set cached provider utils for chain ${a}-${e}`, s), _.set(o, s)) : (console.log(`[getPermitUtilsInstance] Set cached chain utils for chain ${a}`, s), C.set(a, s)), s;
+  const i = new Y(n, e ? void 0 : w), c = new U(i);
+  return e ? (console.log(`[getPermitUtilsInstance] Set cached provider utils for chain ${t}-${e}`, c), b.set(a, c)) : (console.log(`[getPermitUtilsInstance] Set cached chain utils for chain ${t}`, c), C.set(t, c)), c;
 }
-const j = {
-  value: b,
+const J = [
+  {
+    constant: !0,
+    inputs: [],
+    name: "name",
+    outputs: [
+      {
+        name: "",
+        type: "string"
+      }
+    ],
+    payable: !1,
+    stateMutability: "view",
+    type: "function"
+  }
+];
+async function X(t, n, e) {
+  const o = x(t);
+  return N(o, J, e).callStatic.name();
+}
+const Z = {
+  value: S,
   nonce: 0,
-  deadline: I()
-}, Q = {
+  deadline: T()
+}, ee = {
   allowed: !0,
   nonce: 0,
-  expiry: I()
-}, y = {};
-async function ie(a) {
+  expiry: T()
+}, D = {}, g = {
+  type: "unsupported"
+};
+async function fe(t) {
   const {
-    tokenAddress: t,
+    tokenAddress: n,
     chainId: e
-  } = a, n = `${e}-${t.toLowerCase()}`, o = y[n];
-  if (o)
-    return o;
-  const r = Y(a);
-  return y[n] = r, r;
+  } = t, o = `${e}-${n.toLowerCase()}`, a = D[o];
+  if (a)
+    return a;
+  const r = te(t);
+  return D[o] = r, r;
 }
-async function Y(a) {
+async function te(t) {
   const {
-    spender: t,
+    spender: n,
     tokenAddress: e,
-    tokenName: n,
-    chainId: o,
+    tokenName: o,
+    chainId: a,
     provider: r
-  } = a, i = W(o, r), s = h.address;
-  let c;
+  } = t, i = z(a, r), c = w.address;
+  let l = o;
   try {
-    c = await i.getTokenNonce(e, s);
-  } catch (l) {
-    return l === "nonce not supported" || l.message === "nonce is NaN" ? (console.debug(`[checkTokenIsPermittable] Not a permittable token ${e}`, l?.message || l), !1) : (console.debug(`[checkTokenIsPermittable] Failed to get nonce for ${e}`, l), {
-      error: l.message || l.toString()
-    });
+    l = await X(e, a, r);
+  } catch (s) {
+    if (/ETIMEDOUT/.test(s) && !l)
+      return {
+        error: "Failed to fetch token name from contract. RPC connection error"
+      };
+    console.debug(`[checkTokenIsPermittable] Couldn't fetch token name from the contract for token ${e}, using provided '${l}'`, s);
   }
+  if (!l)
+    return {
+      error: `Token name could not be determined for ${e}`
+    };
   let d;
-  if (!G.has(e))
+  try {
+    d = await i.getTokenNonce(e, c);
+  } catch (s) {
+    return s === "nonce not supported" || s.message === "nonce is NaN" ? (console.debug(`[checkTokenIsPermittable] Not a permittable token ${e} - ${l}`, s?.message || s), {
+      ...g,
+      name: l
+    }) : (console.debug(`[checkTokenIsPermittable] Failed to get nonce for ${e} - ${l}`, s), {
+      error: s.message || s.toString()
+    });
+  }
+  let u;
+  if (!B.has(e))
     try {
-      d = await i.getTokenVersion(e);
-    } catch (l) {
-      console.debug(`[checkTokenIsPermittable] Failed to get version for ${e}`, l);
+      u = await i.getTokenVersion(e);
+    } catch (s) {
+      console.debug(`[checkTokenIsPermittable] Failed to get version for ${e} - ${l}`, s);
     }
   const m = {
-    chainId: o,
+    chainId: a,
     eip2612PermitUtils: i,
-    nonce: c,
-    spender: t,
+    nonce: d,
+    spender: n,
     tokenAddress: e,
-    tokenName: n,
-    walletAddress: s,
-    version: d
+    tokenName: l,
+    walletAddress: c,
+    version: u
   };
   try {
-    return await A({
+    return await _({
       ...m,
       type: "eip-2612",
       provider: r
     });
-  } catch (l) {
-    console.debug(`[checkTokenIsPermittable] Failed to estimate eip-2612 permit for ${e}`, l);
+  } catch (s) {
     try {
-      return await A({
+      return await re(e, i) ? await _({
         ...m,
         type: "dai-like",
         provider: r
+      }) : /invalid signature/.test(s) || s?.code === "UNPREDICTABLE_GAS_LIMIT" ? (console.debug(`[checkTokenIsPermittable] Token ${e} - ${l} might be permittable, but it's not supported for now. Reason:`, s?.reason), {
+        ...g,
+        name: l
+      }) : (console.debug(`[checkTokenIsPermittable] Failed to estimate eip-2612 permit for ${e} - ${l}`, s), {
+        error: s.message || s.toString()
       });
-    } catch (u) {
-      return console.debug(`[checkTokenIsPermittable] Failed to estimate dai-like permit for ${e}`, u), {
-        error: u.message || u.toString()
+    } catch (p) {
+      return console.debug(`[checkTokenIsPermittable] Failed to estimate dai-like permit for ${e} - ${l}`, p), {
+        error: p.message || p.toString()
       };
     }
   }
 }
-async function A(a) {
+async function _(t) {
   const {
-    provider: t,
+    provider: n,
     chainId: e,
-    walletAddress: n,
-    tokenAddress: o,
-    type: r,
-    version: i
-  } = a, c = await (r === "eip-2612" ? z : J)(a);
-  return c && (await t.estimateGas({
-    data: c,
-    from: n,
-    to: o
-  })).toNumber() > O[e] ? {
-    type: r,
-    version: i
-  } : !1;
+    walletAddress: o,
+    tokenAddress: a,
+    tokenName: r,
+    type: i,
+    version: c
+  } = t, d = await (i === "eip-2612" ? ne : oe)(t);
+  return d ? (await n.estimateGas({
+    data: d,
+    from: o,
+    to: a
+  })).toNumber() > K[e] ? {
+    type: i,
+    version: c,
+    name: r
+  } : {
+    ...g,
+    name: r
+  } : {
+    ...g,
+    name: r
+  };
 }
-async function z(a) {
+async function ne(t) {
   const {
-    eip2612PermitUtils: t,
+    eip2612PermitUtils: n,
     walletAddress: e,
-    spender: n,
-    nonce: o,
+    spender: o,
+    nonce: a,
     chainId: r,
     tokenName: i,
-    tokenAddress: s,
-    version: c
-  } = a;
-  return v({
-    eip2162Utils: t,
+    tokenAddress: c,
+    version: l
+  } = t;
+  return L({
+    eip2162Utils: n,
     callDataParams: [{
-      ...j,
+      ...Z,
       owner: e,
-      spender: n,
-      nonce: o
-    }, +r, i, s, c]
+      spender: o,
+      nonce: a
+    }, +r, i, c, l]
   });
 }
-async function J(a) {
+async function re(t, n) {
+  return await n.getPermitTypeHash(t) === A;
+}
+async function oe(t) {
   const {
-    eip2612PermitUtils: t,
+    eip2612PermitUtils: n,
     tokenAddress: e,
-    walletAddress: n,
-    spender: o,
+    walletAddress: o,
+    spender: a,
     nonce: r,
     chainId: i,
-    tokenName: s,
-    version: c
-  } = a;
-  return await t.getPermitTypeHash(e) === U ? S({
-    eip2162Utils: t,
+    tokenName: c,
+    version: l
+  } = t;
+  return await n.getPermitTypeHash(e) === A ? $({
+    eip2162Utils: n,
     callDataParams: [{
-      ...Q,
-      holder: n,
-      spender: o,
+      ...ee,
+      holder: o,
+      spender: a,
       nonce: r
-    }, i, s, e, c]
+    }, i, c, e, l]
   }) : !1;
 }
 export {
-  ae as checkIsCallDataAValidPermit,
-  oe as generatePermitHook,
-  W as getPermitUtilsInstance,
-  ie as getTokenPermitInfo
+  ue as checkIsCallDataAValidPermit,
+  pe as generatePermitHook,
+  z as getPermitUtilsInstance,
+  fe as getTokenPermitInfo,
+  q as isSupportedPermitInfo
 };

package/lib/checkIsCallDataAValidPermit.d.ts

@@ -1,3 +1,3 @@
 import { Eip2612PermitUtils } from '@1inch/permit-signed-approvals-utils';
-import { SupportedPermitInfo } from '../types';
-export declare function checkIsCallDataAValidPermit(owner: string, chainId: number, eip2162Utils: Eip2612PermitUtils, tokenAddress: string, tokenName: string, callData: string, { version }: SupportedPermitInfo): Promise<boolean | undefined>;
+import { PermitInfo } from '../types';
+export declare function checkIsCallDataAValidPermit(owner: string, chainId: number, eip2162Utils: Eip2612PermitUtils, tokenAddress: string, _tokenName: string | undefined, callData: string, { version, type, name }: PermitInfo): Promise<boolean | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/permit-utils",
-  "version": "0.0.1-RC.0",
+  "version": "0.0.1",
   "type": "module",
   "dependencies": {
     "ethers": "^5.7.2",

package/types.d.ts

@@ -1,13 +1,12 @@
 import { Eip2612PermitUtils } from '@1inch/permit-signed-approvals-utils';
 import { latest } from '@cowprotocol/app-data';
 import { JsonRpcProvider } from '@ethersproject/providers';
-export type PermitType = 'dai-like' | 'eip-2612';
-export type SupportedPermitInfo = {
+export type PermitType = 'dai-like' | 'eip-2612' | 'unsupported';
+export type PermitInfo = {
     type: PermitType;
-    version: string | undefined;
+    name?: string;
+    version?: string | undefined;
 };
-type UnsupportedPermitInfo = false;
-export type PermitInfo = SupportedPermitInfo | UnsupportedPermitInfo;
 type TokenInfo = {
     address: string;
     name: string | undefined;
@@ -16,7 +15,7 @@ export type PermitHookParams = {
     inputToken: TokenInfo;
     spender: string;
     chainId: number;
-    permitInfo: SupportedPermitInfo;
+    permitInfo: PermitInfo;
     provider: JsonRpcProvider;
     eip2162Utils: Eip2612PermitUtils;
     account?: string | undefined;
@@ -26,7 +25,7 @@ export type PermitHookData = latest.CoWHook;
 type FailedToIdentify = {
     error: string;
 };
-export type GetTokenPermitIntoResult = SupportedPermitInfo | FailedToIdentify | UnsupportedPermitInfo;
+export type GetTokenPermitIntoResult = PermitInfo | FailedToIdentify;
 type BasePermitCallDataParams = {
     eip2162Utils: Eip2612PermitUtils;
 };
@@ -39,7 +38,7 @@ export type BuildDaiLikePermitCallDataParams = BasePermitCallDataParams & {
 export type GetTokenPermitInfoParams = {
     spender: string;
     tokenAddress: string;
-    tokenName: string;
+    tokenName?: string | undefined;
     chainId: number;
     provider: JsonRpcProvider;
 };

package/utils/PermitProviderConnector.d.ts

@@ -5,7 +5,6 @@ export declare class PermitProviderConnector implements ProviderConnector {
     private provider;
     private walletSigner?;
     constructor(provider: JsonRpcProvider, walletSigner?: Wallet | undefined);
-    private getContract;
     contractEncodeABI(abi: AbiItem[], address: string | null, methodName: string, methodParams: unknown[]): string;
     signTypedData(_walletAddress: string, typedData: EIP712TypedData, _typedDataHash: string): Promise<string>;
     ethCall(contractAddress: string, callData: string): Promise<string>;

package/utils/getContract.d.ts

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

package/utils/getTokenName.d.ts

@@ -0,0 +1,2 @@
+import type { JsonRpcProvider } from '@ethersproject/providers';
+export declare function getTokenName(tokenAddress: string, chainId: number, provider: JsonRpcProvider): Promise<string>;

package/utils/isSupportedPermitInfo.d.ts

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