chore: add onchainkit-referrer

coinbase · Jan 30, 2025 · 1261517 · 1261517
1 parent 797b7f0
commit 1261517
Show file tree

Hide file tree

Showing 36 changed files with 566 additions and 272 deletions.
diff --git a/src/api/buildMintTransaction.test.ts b/src/api/buildMintTransaction.test.ts
@@ -35,7 +35,11 @@ describe('buildMintTransaction', () => {
     const result = await buildMintTransaction(params);
 
     expect(result).toEqual(mockResponse.result);
-    expect(mockSendRequest).toHaveBeenCalledWith(CDP_MINT_TOKEN, [params]);
+    expect(mockSendRequest).toHaveBeenCalledWith(
+      CDP_MINT_TOKEN,
+      [params],
+      'api',
+    );
   });
 
   it('should return error details when request fails with an error', async () => {
@@ -55,7 +59,11 @@ describe('buildMintTransaction', () => {
       error: 'Error building mint transaction',
       message: 'Not Found',
     });
-    expect(mockSendRequest).toHaveBeenCalledWith(CDP_MINT_TOKEN, [params]);
+    expect(mockSendRequest).toHaveBeenCalledWith(
+      CDP_MINT_TOKEN,
+      [params],
+      'api',
+    );
   });
 
   it('should return uncaught error details when an exception is thrown', async () => {
@@ -68,6 +76,10 @@ describe('buildMintTransaction', () => {
       error: 'Something went wrong',
       message: 'Error building mint transaction',
     });
-    expect(mockSendRequest).toHaveBeenCalledWith(CDP_MINT_TOKEN, [params]);
+    expect(mockSendRequest).toHaveBeenCalledWith(
+      CDP_MINT_TOKEN,
+      [params],
+      'api',
+    );
   });
 });
diff --git a/src/api/buildMintTransaction.ts b/src/api/buildMintTransaction.ts
@@ -1,5 +1,5 @@
 import { CDP_MINT_TOKEN } from '../core/network/definitions/nft';
-import { sendRequest } from '../core/network/request';
+import { type JSONRPCReferrer, sendRequest } from '../core/network/request';
 import type {
   BuildMintTransactionParams,
   BuildMintTransactionResponse,
@@ -8,26 +8,29 @@ import type {
 /**
  * Retrieves contract to mint an NFT
  */
-export async function buildMintTransaction({
-  mintAddress,
-  tokenId,
-  network = '',
-  quantity,
-  takerAddress,
-}: BuildMintTransactionParams): Promise<BuildMintTransactionResponse> {
+export async function buildMintTransaction(
+  params: BuildMintTransactionParams,
+  _referrer: JSONRPCReferrer = 'api',
+): Promise<BuildMintTransactionResponse> {
+  const { mintAddress, tokenId, network = '', quantity, takerAddress } = params;
+
   try {
     const res = await sendRequest<
       BuildMintTransactionParams,
       BuildMintTransactionResponse
-    >(CDP_MINT_TOKEN, [
-      {
-        mintAddress,
-        network,
-        quantity,
-        takerAddress,
-        tokenId,
-      },
-    ]);
+    >(
+      CDP_MINT_TOKEN,
+      [
+        {
+          mintAddress,
+          network,
+          quantity,
+          takerAddress,
+          tokenId,
+        },
+      ],
+      _referrer,
+    );
     if (res.error) {
       return {
         code: `${res.error.code}`,

diff --git a/src/api/buildPayTransaction.test.ts b/src/api/buildPayTransaction.test.ts
@@ -50,9 +50,11 @@ describe('buildPayTransaction', () => {
     const payTransaction = await buildPayTransaction(mockParams);
     expect(payTransaction).toEqual(MOCK_HYDRATE_CHARGE_SUCCESS_RESPONSE.result);
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_HYDRATE_CHARGE, [
-      mockAPIParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_HYDRATE_CHARGE,
+      [mockAPIParams],
+      'api',
+    );
   });
 
   it('should return a Pay Transaction with productId', async () => {
@@ -72,9 +74,11 @@ describe('buildPayTransaction', () => {
       MOCK_CREATE_PRODUCT_CHARGE_SUCCESS_RESPONSE.result,
     );
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_CREATE_PRODUCT_CHARGE, [
-      mockAPIParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_CREATE_PRODUCT_CHARGE,
+      [mockAPIParams],
+      'api',
+    );
   });
 
   it('should return an error if neither chargeId nor productId is provided', async () => {
@@ -126,8 +130,10 @@ describe('buildPayTransaction', () => {
       message: CHECKOUT_INVALID_CHARGE_ERROR_MESSAGE,
     });
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_HYDRATE_CHARGE, [
-      mockAPIParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_HYDRATE_CHARGE,
+      [mockAPIParams],
+      'api',
+    );
   });
 });
diff --git a/src/api/buildPayTransaction.ts b/src/api/buildPayTransaction.ts
@@ -2,7 +2,11 @@ import {
   CDP_CREATE_PRODUCT_CHARGE,
   CDP_HYDRATE_CHARGE,
 } from '../core/network/definitions/pay';
-import { type JSONRPCResult, sendRequest } from '../core/network/request';
+import {
+  type JSONRPCReferrer,
+  type JSONRPCResult,
+  sendRequest,
+} from '../core/network/request';
 import type {
   BuildPayTransactionParams,
   BuildPayTransactionResponse,
@@ -11,33 +15,42 @@ import type {
 } from './types';
 import { getPayErrorMessage } from './utils/getPayErrorMessage';
 
-export async function buildPayTransaction({
-  address,
-  chargeId,
-  productId,
-}: BuildPayTransactionParams): Promise<BuildPayTransactionResponse> {
+export async function buildPayTransaction(
+  params: BuildPayTransactionParams,
+  _referrer: JSONRPCReferrer = 'api',
+): Promise<BuildPayTransactionResponse> {
+  const { address, chargeId, productId } = params;
+
   try {
     let res: JSONRPCResult<BuildPayTransactionResponse>;
     if (chargeId) {
       res = await sendRequest<
         HydrateChargeAPIParams,
         BuildPayTransactionResponse
-      >(CDP_HYDRATE_CHARGE, [
-        {
-          sender: address,
-          chargeId,
-        },
-      ]);
+      >(
+        CDP_HYDRATE_CHARGE,
+        [
+          {
+            sender: address,
+            chargeId,
+          },
+        ],
+        _referrer,
+      );
     } else if (productId) {
       res = await sendRequest<
         CreateProductChargeParams,
         BuildPayTransactionResponse
-      >(CDP_CREATE_PRODUCT_CHARGE, [
-        {
-          sender: address,
-          productId,
-        },
-      ]);
+      >(
+        CDP_CREATE_PRODUCT_CHARGE,
+        [
+          {
+            sender: address,
+            productId,
+          },
+        ],
+        _referrer,
+      );
     } else {
       return {
         code: 'AmBPTa01', // Api Module Build Pay Transaction Error 01

diff --git a/src/api/buildSwapTransaction.test.ts b/src/api/buildSwapTransaction.test.ts
@@ -115,9 +115,11 @@ describe('buildSwapTransaction', () => {
     expect(quote.fee).toEqual(expectedResponse.fee);
     expect(quote.warning).toEqual(expectedResponse.warning);
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_GET_SWAP_TRADE, [
-      mockApiParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_GET_SWAP_TRADE,
+      [mockApiParams],
+      'api',
+    );
   });
 
   it('should return a swap with useAggregator=false', async () => {
@@ -197,9 +199,11 @@ describe('buildSwapTransaction', () => {
     expect(quote.fee).toEqual(expectedResponse.fee);
     expect(quote.warning).toEqual(expectedResponse.warning);
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_GET_SWAP_TRADE, [
-      mockApiParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_GET_SWAP_TRADE,
+      [mockApiParams],
+      'api',
+    );
   });
 
   it('should return an error for an unsupported amount reference', async () => {
@@ -301,12 +305,16 @@ describe('buildSwapTransaction', () => {
     expect(quote.fee).toEqual(expectedResponse.fee);
     expect(quote.warning).toEqual(expectedResponse.warning);
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_GET_SWAP_TRADE, [
-      {
-        slippagePercentage: '30',
-        ...mockApiParams,
-      },
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_GET_SWAP_TRADE,
+      [
+        {
+          slippagePercentage: '30',
+          ...mockApiParams,
+        },
+      ],
+      'api',
+    );
   });
 
   it('should return an error if sendRequest fails', async () => {
@@ -330,9 +338,11 @@ describe('buildSwapTransaction', () => {
       message: '',
     });
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_GET_SWAP_TRADE, [
-      mockApiParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_GET_SWAP_TRADE,
+      [mockApiParams],
+      'api',
+    );
   });
 
   it('should return an error object from buildSwapTransaction', async () => {
@@ -361,9 +371,11 @@ describe('buildSwapTransaction', () => {
       message: '',
     });
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_GET_SWAP_TRADE, [
-      mockApiParams,
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_GET_SWAP_TRADE,
+      [mockApiParams],
+      'api',
+    );
   });
 
   it('should return an error object from buildSwapTransaction for invalid `amount` input', async () => {
@@ -396,10 +408,14 @@ describe('buildSwapTransaction', () => {
     };
     await buildSwapTransaction(mockParams);
     expect(sendRequest).toHaveBeenCalledTimes(1);
-    expect(sendRequest).toHaveBeenCalledWith(CDP_GET_SWAP_TRADE, [
-      expect.objectContaining({
-        slippagePercentage: '30',
-      }),
-    ]);
+    expect(sendRequest).toHaveBeenCalledWith(
+      CDP_GET_SWAP_TRADE,
+      [
+        expect.objectContaining({
+          slippagePercentage: '30',
+        }),
+      ],
+      'api',
+    );
   });
 });
diff --git a/src/api/buildSwapTransaction.ts b/src/api/buildSwapTransaction.ts
@@ -1,7 +1,7 @@
 import { SwapMessage } from '@/swap/constants';
 import { UNSUPPORTED_AMOUNT_REFERENCE_ERROR_CODE } from '@/swap/constants';
 import { CDP_GET_SWAP_TRADE } from '../core/network/definitions/swap';
-import { sendRequest } from '../core/network/request';
+import { type JSONRPCReferrer, sendRequest } from '../core/network/request';
 import type { SwapAPIResponse } from '../swap/types';
 import { getSwapErrorCode } from '../swap/utils/getSwapErrorCode';
 import type {
@@ -17,6 +17,7 @@ import { getSwapTransaction } from './utils/getSwapTransaction';
  */
 export async function buildSwapTransaction(
   params: BuildSwapTransactionParams,
+  _referrer: JSONRPCReferrer = 'api',
 ): Promise<BuildSwapTransactionResponse> {
   // Default parameters
   const defaultParams = {
@@ -64,6 +65,7 @@ export async function buildSwapTransaction(
     const res = await sendRequest<SwapAPIParams, SwapAPIResponse>(
       CDP_GET_SWAP_TRADE,
       [apiParams],
+      _referrer,
     );
     if (res.error) {
       return {

diff --git a/src/api/getMintDetails.test.ts b/src/api/getMintDetails.test.ts
@@ -43,9 +43,11 @@ describe('getMintDetails', () => {
     const result = await getMintDetails(params);
 
     expect(result).toEqual(mockResponse.result);
-    expect(mockSendRequest).toHaveBeenCalledWith(CDP_GET_MINT_DETAILS, [
-      params,
-    ]);
+    expect(mockSendRequest).toHaveBeenCalledWith(
+      CDP_GET_MINT_DETAILS,
+      [params],
+      'api',
+    );
   });
 
   it('should return error details when request fails with an error', async () => {
@@ -65,9 +67,11 @@ describe('getMintDetails', () => {
       error: 'Error fetching mint details',
       message: 'Not Found',
     });
-    expect(mockSendRequest).toHaveBeenCalledWith(CDP_GET_MINT_DETAILS, [
-      params,
-    ]);
+    expect(mockSendRequest).toHaveBeenCalledWith(
+      CDP_GET_MINT_DETAILS,
+      [params],
+      'api',
+    );
   });
 
   it('should return uncaught error details when an exception is thrown', async () => {
@@ -80,8 +84,10 @@ describe('getMintDetails', () => {
       error: 'Something went wrong',
       message: 'Error fetching mint details',
     });
-    expect(mockSendRequest).toHaveBeenCalledWith(CDP_GET_MINT_DETAILS, [
-      params,
-    ]);
+    expect(mockSendRequest).toHaveBeenCalledWith(
+      CDP_GET_MINT_DETAILS,
+      [params],
+      'api',
+    );
   });
 });