fix: contract logging

for help with debugging, all contract writes now log their arguments to the debug console
NFTX-project · Nov 23, 2023 · 34e5edf · 34e5edf
1 parent 39621bc
commit 34e5edf
Show file tree

Hide file tree

Showing 13 changed files with 128 additions and 96 deletions.
diff --git a/packages/trade/src/approve/approve.ts b/packages/trade/src/approve/approve.ts
@@ -15,7 +15,7 @@ import type {
 import { MaxUint256, PERMIT2, Zero } from '@nftx/constants';
 import { ValidationError } from '@nftx/errors';
 import config from '@nftx/config';
-import { zeroAddress } from 'viem';
+import { encodeAbiParameters, zeroAddress } from 'viem';
 
 function approvePunk({
   tokenId,
@@ -156,7 +156,7 @@ async function approvePermit2({
     details: {
       token: tokenAddress,
       amount,
-      expiration: deadline,
+      expiration: Number(deadline),
       nonce,
     },
     spender: spenderAddress,
@@ -176,6 +176,50 @@ async function approvePermit2({
     wait: async () => {
       const signature = await promise;
 
+      const permit2encoded = encodeAbiParameters(
+        [
+          {
+            name: 'owner',
+            type: 'address',
+          },
+          {
+            name: 'permitSingle',
+            type: 'tuple',
+            components: [
+              {
+                name: 'details',
+                type: 'tuple',
+                components: [
+                  {
+                    name: 'token',
+                    type: 'address',
+                  },
+                  {
+                    name: 'amount',
+                    type: 'uint160',
+                  },
+                  {
+                    name: 'expiration',
+                    type: 'uint48',
+                  },
+                  {
+                    name: 'nonce',
+                    type: 'uint48',
+                  },
+                ],
+              },
+              { name: 'spender', type: 'address' },
+              { name: 'sigDeadline', type: 'uint256' },
+            ],
+          },
+          {
+            name: 'signature',
+            type: 'bytes',
+          },
+        ],
+        [userAddress, permitSingleStruct, signature]
+      );
+
       return {
         blockHash: '0x',
         blockNumber: 0n,
@@ -197,6 +241,7 @@ async function approvePermit2({
           expiration: permitSingleStruct.details.expiration,
           sigDeadline: permitSingleStruct.sigDeadline,
           nonce: permitSingleStruct.details.nonce,
+          permit2encoded,
         },
       };
     },

diff --git a/packages/trade/src/approve/approveContracts.ts b/packages/trade/src/approve/approveContracts.ts
@@ -0,0 +1,73 @@
+import { MaxUint256, PERMIT2 } from '@nftx/constants';
+import { ApproveContract, TokenId } from '@nftx/types';
+import { getChainConstant, getUniqueTokenIds, isCryptoPunk } from '@nftx/utils';
+
+type GetApproveContract = Pick<
+  ApproveContract,
+  'label' | 'spenderAddress' | 'tokenAddress'
+> &
+  Partial<Pick<ApproveContract, 'amount' | 'standard' | 'tokenIds'>> & {
+    network: number;
+    usePermit2?: boolean;
+  };
+
+export const getApproveContracts = ({
+  label,
+  network,
+  spenderAddress,
+  tokenAddress,
+  amount,
+  standard,
+  tokenIds,
+  usePermit2,
+}: GetApproveContract): ApproveContract[] => {
+  if (isCryptoPunk(tokenAddress)) {
+    return (
+      tokenIds?.map((tokenIdOrTuple) => {
+        const tokenIds = getUniqueTokenIds([tokenIdOrTuple as TokenId]);
+
+        return {
+          type: 'on-chain',
+          label: `${label} [${tokenIds}]`,
+          tokenIds,
+          spenderAddress,
+          tokenAddress,
+          standard,
+        };
+      }) || []
+    );
+    // Permit2 is only available for ERC20 tokens
+  } else if (usePermit2 && (standard === 'ERC20' || standard == null)) {
+    return [
+      {
+        label: 'Approve Permit2',
+        type: 'on-chain',
+        spenderAddress: getChainConstant(PERMIT2, network),
+        tokenAddress,
+        standard: 'ERC20',
+        amount: MaxUint256,
+      },
+      {
+        type: 'permit2',
+        label,
+        spenderAddress,
+        tokenAddress,
+        amount,
+        standard,
+        tokenIds,
+      },
+    ];
+  } else {
+    return [
+      {
+        type: 'on-chain',
+        label,
+        spenderAddress,
+        tokenAddress,
+        amount,
+        standard,
+        tokenIds,
+      },
+    ];
+  }
+};
diff --git a/packages/trade/src/approve/index.ts b/packages/trade/src/approve/index.ts
@@ -1,2 +1,3 @@
 export { default as approve } from './approve';
 export { default as isApproved } from './isApproved';
+export * from './approveContracts';
diff --git a/packages/trade/src/pools/createVault.ts b/packages/trade/src/pools/createVault.ts
@@ -39,13 +39,6 @@ const makeCreateVault = ({
       signer,
     });
 
-    console.debug({
-      method: 'createVault',
-      address,
-      value,
-      params,
-    });
-
     return contract.write.createVault({
       args: [params],
       value,

diff --git a/packages/trade/src/positions/createInventoryPosition.ts b/packages/trade/src/positions/createInventoryPosition.ts
@@ -24,14 +24,6 @@ const createInventoryPosition = ({
     signer,
   });
 
-  console.debug({
-    method: 'depositWithNFT',
-    vaultId,
-    nftIds,
-    nftAmounts,
-    userAddress,
-  });
-
   return contract.write.depositWithNFT({
     args: [BigInt(vaultId), nftIds, nftAmounts, userAddress],
   });

diff --git a/packages/trade/src/positions/withdrawInventory.ts b/packages/trade/src/positions/withdrawInventory.ts
@@ -23,14 +23,6 @@ const withdrawInventory = ({
   provider: Provider;
   signer: Signer;
 }) => {
-  console.debug({
-    method: 'withdraw',
-    positionId,
-    vTokenShares,
-    nftIds,
-    vTokenPremiumLimit,
-  });
-
   const contract = getContract({
     abi: InventoryStaking,
     address: getChainConstant(INVENTORY_STAKING, network),

diff --git a/packages/trade/src/positions/withdrawLiquidity.ts b/packages/trade/src/positions/withdrawLiquidity.ts
@@ -24,12 +24,6 @@ const withdrawLiquidity = ({
     signer,
   });
 
-  console.debug({
-    method: 'removeLiquidity',
-    params,
-    value,
-  });
-
   return contract.write.removeLiquidity({
     args: [params],
     value,

diff --git a/packages/trade/src/trade/buy.ts b/packages/trade/src/trade/buy.ts
@@ -36,17 +36,6 @@ const buy = ({
   const vTokenPremiumLimit = BigInt(params.premiumLimit);
   const deductRoyalty = false;
 
-  console.debug({
-    method: 'buyNFTsWithETH',
-    vaultId,
-    idsOut,
-    calldata,
-    to,
-    vTokenPremiumLimit,
-    deductRoyalty,
-    value: BigInt(params.value),
-  });
-
   return contract.write.buyNFTsWithETH({
     args: [vaultId, idsOut, calldata, to, vTokenPremiumLimit, deductRoyalty],
     value: BigInt(params.value),

diff --git a/packages/trade/src/trade/mint.ts b/packages/trade/src/trade/mint.ts
@@ -24,8 +24,6 @@ const mint = async ({
   const to = params.to;
   const value = BigInt(params.value);
 
-  console.debug({ method: 'mint', tokenIds, amounts, depositor, to, value });
-
   // Not sure if vaultAddress is correct
   return contract.write.mint({
     args: [tokenIds, amounts, depositor, to],

diff --git a/packages/trade/src/trade/redeem.ts b/packages/trade/src/trade/redeem.ts
@@ -28,16 +28,6 @@ const redeem = async ({
   const value = BigInt(params.value);
   const vTokenPremiumLimit = BigInt(params.premiumLimit);
 
-  console.debug({
-    method: 'redeem',
-    tokenIds,
-    to,
-    wethAmount,
-    vTokenPremiumLimit,
-    forceFees,
-    value,
-  });
-
   return contract.write.redeem({
     args: [tokenIds, to, wethAmount, vTokenPremiumLimit, forceFees],
     value,

diff --git a/packages/trade/src/trade/sell.ts b/packages/trade/src/trade/sell.ts
@@ -29,35 +29,14 @@ const sell = ({
   const to = params.to;
   // TODO: handle royalties?
   const deductRoyalty = false;
-  const value = BigInt(params.value);
 
   if (params.standard === 'ERC1155') {
-    console.debug({
-      method: 'sell1155',
-      vaultId,
-      idsIn,
-      amounts,
-      calldata,
-      to,
-      deductRoyalty,
-    });
-
     return contract.write.sell1155({
       args: [vaultId, idsIn, amounts, calldata, to, deductRoyalty],
       // value,
     });
   }
 
-  console.debug({
-    method: 'sell721',
-    vaultId,
-    idsIn,
-    calldata,
-    to,
-    deductRoyalty,
-    value,
-  });
-
   return contract.write.sell721({
     args: [vaultId, idsIn, calldata, to, deductRoyalty],
     // value,

diff --git a/packages/trade/src/trade/swap.ts b/packages/trade/src/trade/swap.ts
@@ -38,33 +38,12 @@ const swap = ({
   const value = BigInt(params.value);
 
   if (params.standard === 'ERC1155') {
-    console.debug({
-      method: 'swap1155',
-      vaultId,
-      idsIn,
-      amounts,
-      idsOut,
-      vTokenPremiumLimit,
-      to,
-      value,
-    });
-
     return contract.write.swap1155({
       args: [vaultId, idsIn, amounts, idsOut, vTokenPremiumLimit, to],
       value,
     });
   }
 
-  console.debug({
-    method: 'swap721',
-    vaultId,
-    idsIn,
-    idsOut,
-    vTokenPremiumLimit,
-    to,
-    value,
-  });
-
   return contract.write.swap721({
     args: [vaultId, idsIn, idsOut, vTokenPremiumLimit, to],
     value,

diff --git a/packages/utils/src/web3/getContract.ts b/packages/utils/src/web3/getContract.ts
@@ -44,6 +44,13 @@ function getContract<T extends Abi>({
         const [userAddress] = await signer.getAddresses();
         const account = userAddress;
 
+        console.debug({
+          method: functionName,
+          contractAddress: address,
+          account,
+          ...args,
+        });
+
         const { request } = await provider.simulateContract({
           address,
           abi,