ADDS support for integrator attribution

johnrjj · johnrjj · commit 5576039ad6a2 · 2022-04-20T21:28:07.000-04:00
diff --git a/src/sdk/v4/NftSwapV4.ts b/src/sdk/v4/NftSwapV4.ts
@@ -23,6 +23,7 @@ import type {
 import { UnexpectedAssetTypeError } from '../error';
 import {
   approveAsset,
+  DEFAULT_APP_ID,
   generateErc1155Order,
   generateErc721Order,
   getApprovalStatus,
@@ -154,7 +155,11 @@ export interface INftSwapV4 extends BaseNftSwap {
 }
 
 export interface AdditionalSdkConfig {
+  // Identify your app fills with distinct integer
+  appId: string;
+  // Custom zeroex proxy contract address (defaults to the canonical contracts deployed by 0x Labs core team)
   zeroExExchangeProxyContractAddress: string;
+  // Custom orderbook url. Defaults to using Trader.xyz's multi-chain open orderbook
   orderbookRootUrl: string;
 }
 
@@ -165,6 +170,9 @@ class NftSwapV4 implements INftSwapV4 {
   public exchangeProxy: IZeroEx;
   public exchangeProxyContractAddress: string;
 
+  // Unique identifier for app. Must be a positive integer between 1 and 2**128
+  public appId: string;
+
   public orderbookRootUrl: string;
 
   constructor(
@@ -195,6 +203,8 @@ class NftSwapV4 implements INftSwapV4 {
     this.orderbookRootUrl =
       additionalConfig?.orderbookRootUrl ?? ORDERBOOK_API_ROOT_URL_PRODUCTION;
 
+    this.appId = additionalConfig?.appId ?? DEFAULT_APP_ID;
+
     this.exchangeProxy = IZeroEx__factory.connect(
       zeroExExchangeContractAddress,
       signer ?? provider
@@ -432,7 +442,11 @@ class NftSwapV4 implements INftSwapV4 {
     makerAddress: string,
     userConfig?: Partial<OrderStructOptionsCommonStrict>
   ): NftOrderV4Serialized => {
-    const defaultConfig = { chainId: this.chainId, makerAddress: makerAddress };
+    const defaultConfig = {
+      chainId: this.chainId,
+      makerAddress: makerAddress,
+      appId: this.appId,
+    };
     const config = { ...defaultConfig, ...userConfig };
 
     const direction =
diff --git a/src/sdk/v4/pure.ts b/src/sdk/v4/pure.ts
@@ -6,6 +6,9 @@ import type { ContractTransaction } from '@ethersproject/contracts';
 import getUnixTime from 'date-fns/getUnixTime';
 import { v4 } from 'uuid';
 import warning from 'tiny-warning';
+import invariant from 'tiny-invariant';
+import padEnd from 'lodash/padEnd';
+import padStart from 'lodash/padStart';
 import {
   ERC1155__factory,
   ERC20__factory,
@@ -322,7 +325,9 @@ export const generateErc721Order = (
         };
       }) ?? [],
     expiry: expiry,
-    nonce: orderData.nonce?.toString() ?? generateRandomV4OrderNonce(),
+    nonce:
+      orderData.nonce?.toString() ??
+      generateRandomV4OrderNonce(orderData.appId),
     taker: orderData.taker?.toLowerCase() ?? NULL_ADDRESS,
   };
 
@@ -367,21 +372,81 @@ export const generateErc1155Order = (
         };
       }) ?? [],
     expiry: expiry,
-    nonce: orderData.nonce?.toString() ?? generateRandomV4OrderNonce(),
+    nonce:
+      orderData.nonce?.toString() ??
+      generateRandomV4OrderNonce(orderData.appId),
     taker: orderData.taker?.toLowerCase() ?? NULL_ADDRESS,
   };
 
   return erc1155Order;
 };
 
+// Number of digits in base 10 128bit nonce
+// floor(log_10(2^128 - 1)) + 1
+export const ONE_TWENTY_EIGHT_BIT_LENGTH = 39;
+
+// Max nonce digit length in base 10
+// floor(log_10(2^256 - 1)) + 1
+export const TWO_FIFTY_SIX_BIT_LENGTH = 78;
+
+const checkIfStringContainsOnlyNumbers = (val: string) => {
+  const onlyNumbers = /^\d+$/.test(val);
+  return onlyNumbers;
+};
+
+export const RESERVED_APP_ID_PREFIX = '1001';
+const RESERVED_APP_ID_PREFIX_DIGITS = RESERVED_APP_ID_PREFIX.length;
+
+export const DEFAULT_APP_ID = '314159';
+
+const verifyAppIdOrThrow = (appId: string) => {
+  const isCorrectLength =
+    appId.length <= ONE_TWENTY_EIGHT_BIT_LENGTH - RESERVED_APP_ID_PREFIX_DIGITS;
+  const hasOnlyNumbers = checkIfStringContainsOnlyNumbers(appId);
+  invariant(isCorrectLength, 'appId must be 39 digits or less');
+  invariant(
+    hasOnlyNumbers,
+    'appId must be numeric only (no alpha or special characters, only numbers)'
+  );
+};
+
 /**
+ * Generates a 256bit nonce.
+ * The format:
+ *   First 128bits:  ${SDK_PREFIX}${APP_ID}000000 (right padded zeroes to fill)
+ *   Second 128bits: ${RANDOM_GENERATED_128BIT_ORDER_HASH}
  * @returns 128bit nonce as string (0x orders can handle up to 256 bit nonce)
  */
-export const generateRandomV4OrderNonce = (): string => {
+export const generateRandomV4OrderNonce = (
+  appId: string = DEFAULT_APP_ID
+): string => {
+  if (appId) {
+    verifyAppIdOrThrow(appId);
+  }
+  const order128 = padStart(
+    generateRandom128BitNumber(),
+    ONE_TWENTY_EIGHT_BIT_LENGTH,
+    '0'
+  );
+  const appId128 = padEnd(
+    `${RESERVED_APP_ID_PREFIX}${appId}`,
+    ONE_TWENTY_EIGHT_BIT_LENGTH,
+    '0'
+  );
+  const final256BitNonce = `${appId128}${order128}`;
+  invariant(
+    final256BitNonce.length <= TWO_FIFTY_SIX_BIT_LENGTH,
+    'Invalid nonce size'
+  );
+  return final256BitNonce;
+};
+
+// uuids are 128bits
+export const generateRandom128BitNumber = (base = 10): string => {
   const hex = '0x' + v4().replace(/-/g, '');
   const value = BigInt(hex);
-  const decimal = value.toString(); // don't convert this to a number, will lose precision
-  return decimal;
+  const valueBase10String = value.toString(base); // don't convert this to a number, will lose precision
+  return valueBase10String;
 };
 
 export const serializeNftOrder = (
diff --git a/src/sdk/v4/types.ts b/src/sdk/v4/types.ts
@@ -95,6 +95,7 @@ export interface OrderStructOptionsCommon {
   direction: BigNumberish;
   maker: string;
   taker: string;
+  appId: string;
   expiry: Date | number;
   nonce: BigNumberish;
   // erc20Token: string;
@@ -108,6 +109,7 @@ export interface OrderStructOptionsCommonStrict {
   // erc20Token: string;
   // erc20TokenAmount: BigNumberish;
   maker: string;
+  appId?: string;
   taker?: string;
   expiry?: Date | number;
   nonce?: BigNumberish;
diff --git a/test/v4/erc721-test-swap.test.ts b/test/v4/erc721-test-swap.test.ts
@@ -96,36 +96,15 @@ describe('NFTSwapV4', () => {
     expect(signedOrderErc1155.direction.toString()).toBe('0');
 
     await nftSwapperMaker.postOrder(signedOrder, '3');
-    // console.log('erc721 signatuee', signedOrder.signature);
-    // expect(signedOrder.signature.signatureType.toString()).toEqual('2');
+
+    expect(signedOrder.signature.signatureType.toString()).toEqual('2');
 
     // const fillTx = await nftSwapperMaker.fillSignedOrder(signedOrder);
     // const txReceipt = await fillTx.wait();
     // console.log('erc721 fill tx', txReceipt.transactionHash);
 
     // expect(txReceipt.transactionHash).toBeTruthy();
 
-    // const normalizedOrder = normalizeOrder(order);
-    // const signedOrder = await nftSwapperMaker.signOrder(
-    //   normalizedOrder,
-    // );
-
-    // const normalizedSignedOrder = normalizeOrder(signedOrder);
-
-    // expect(normalizedSignedOrder.makerAddress.toLowerCase()).toBe(
-    //   MAKER_WALLET_ADDRESS.toLowerCase()
-    // );
-
-    // Uncomment to actually fill order
-    // const tx = await nftSwapperMaker.fillSignedOrder(signedOrder, undefined, {
-    //   gasPrice,
-    //   gasLimit: '500000',
-    //   // HACK(johnnrjj) - Rinkeby still has protocol fees, so we give it a little bit of ETH so its happy.
-    //   value: parseEther('0.01'),
-    // });
-
-    // const txReceipt = await tx.wait();
-    // expect(txReceipt.transactionHash).toBeTruthy();
     // console.log(`Swapped on Ropsten (txHAsh: ${txReceipt.transactionIndex})`);
   });
 });
diff --git a/test/v4/nonce.test.ts b/test/v4/nonce.test.ts
@@ -0,0 +1,113 @@
+import { ethers } from 'ethers';
+import { ETH_ADDRESS_AS_ERC20 } from '../../src/sdk';
+import { NftSwapV4 } from '../../src/sdk/v4/NftSwapV4';
+import {
+  generateRandomV4OrderNonce,
+  TWO_FIFTY_SIX_BIT_LENGTH,
+} from '../../src/sdk/v4/pure';
+
+import { SwappableAssetV4 } from '../../src/sdk/v4/types';
+
+jest.setTimeout(90 * 1000);
+
+const MAKER_WALLET_ADDRESS = '0xabc23F70Df4F45dD3Df4EC6DA6827CB05853eC9b';
+const MAKER_PRIVATE_KEY =
+  'fc5db508b0a52da8fbcac3ab698088715595f8de9cccf2467d51952eec564ec9';
+
+const TEST_NFT_CONTRACT_ADDRESS = '0xf5de760f2e916647fd766b4ad9e85ff943ce3a2b'; // https://ropsten.etherscan.io/token/0xf5de760f2e916647fd766b4ad9e85ff943ce3a2b?a=0xabc23F70Df4F45dD3Df4EC6DA6827CB05853eC9b
+
+const RPC_TESTNET =
+  'https://eth-ropsten.alchemyapi.io/v2/is1WqyAFM1nNFFx2aCozhTep7IxHVNGo';
+
+const MAKER_WALLET = new ethers.Wallet(MAKER_PRIVATE_KEY);
+
+const PROVIDER = new ethers.providers.StaticJsonRpcProvider(RPC_TESTNET);
+
+const MAKER_SIGNER = MAKER_WALLET.connect(PROVIDER);
+
+const ROPSTEN_CHAIN_ID = 3;
+
+const ETH_ASSET: SwappableAssetV4 = {
+  type: 'ERC20',
+  tokenAddress: ETH_ADDRESS_AS_ERC20,
+  amount: '420000000000000', // 1 USDC
+};
+
+const NFT_ASSET: SwappableAssetV4 = {
+  type: 'ERC721',
+  tokenAddress: TEST_NFT_CONTRACT_ADDRESS,
+  tokenId: '11045',
+};
+
+const maxNonce = BigInt(2 ** 256 - 1) + BigInt(1);
+
+const sdkReservedNoncePrefix = '1001';
+
+describe('NFTSwapV4', () => {
+  it('custom nonce testing', async () => {
+    // const half = BigInt(2^128 - 1);
+    const TWO_FIFTY_SIX_BIT_LENGTH = 78;
+
+    const appId = '1337';
+    const v4Nonce = generateRandomV4OrderNonce(appId);
+
+    // 256 bit number
+    const nonceBigInt = BigInt(v4Nonce);
+
+    expect(v4Nonce.startsWith(sdkReservedNoncePrefix)).toBe(true);
+    expect(v4Nonce.length).toEqual(TWO_FIFTY_SIX_BIT_LENGTH);
+    expect(v4Nonce.substring(4).startsWith(appId)).toBe(true);
+    expect(nonceBigInt <= maxNonce).toBe(true);
+  });
+
+  it('order with default nonce', async () => {
+    const defaultAppId = '314159';
+    const nftSwapperMaker = new NftSwapV4(
+      MAKER_SIGNER as any,
+      MAKER_SIGNER,
+      ROPSTEN_CHAIN_ID
+    );
+
+    const order = nftSwapperMaker.buildOrder(
+      NFT_ASSET,
+      ETH_ASSET,
+      MAKER_WALLET_ADDRESS
+    );
+
+    // 256 bit number
+    const v4Nonce = order.nonce;
+    const nonceBigInt = BigInt(order.nonce);
+
+    expect(v4Nonce.startsWith(sdkReservedNoncePrefix)).toBe(true);
+    expect(v4Nonce.length).toEqual(TWO_FIFTY_SIX_BIT_LENGTH);
+    expect(v4Nonce.substring(4).startsWith(defaultAppId)).toBe(true);
+    const isWithinMaxBits = nonceBigInt <= maxNonce;
+    expect(isWithinMaxBits).toBe(true);
+  });
+
+  it('order with custom nonce', async () => {
+    const customAppId = '696969';
+    const nftSwapperMaker = new NftSwapV4(
+      MAKER_SIGNER as any,
+      MAKER_SIGNER,
+      ROPSTEN_CHAIN_ID,
+      {
+        appId: customAppId,
+      }
+    );
+
+    const order = nftSwapperMaker.buildOrder(
+      NFT_ASSET,
+      ETH_ASSET,
+      MAKER_WALLET_ADDRESS
+    );
+
+    const v4Nonce = order.nonce;
+    const nonceBigInt = BigInt(order.nonce);
+
+    expect(v4Nonce.startsWith(sdkReservedNoncePrefix)).toBe(true);
+    expect(v4Nonce.length).toEqual(TWO_FIFTY_SIX_BIT_LENGTH);
+    expect(v4Nonce.substring(4).startsWith(customAppId)).toBe(true);
+    expect(nonceBigInt < maxNonce).toBe(true);
+  });
+});
