chore: NEAR transaction callback arguments (#948)

yomarion · web-flow · commit 2e612e3eb953 · 2022-10-12T13:54:19.000+02:00
* chore: NEAR transaction callback arguments
* bump near-api-js
diff --git a/packages/payment-processor/package.json b/packages/payment-processor/package.json
@@ -46,7 +46,7 @@
     "@requestnetwork/utils": "0.35.0",
     "@superfluid-finance/sdk-core": "0.3.2",
     "ethers": "5.5.1",
-    "near-api-js": "0.42.0",
+    "near-api-js": "1.1.0",
     "tslib": "2.3.1"
   },
   "devDependencies": {
diff --git a/packages/payment-processor/src/payment/index.ts b/packages/payment-processor/src/payment/index.ts
@@ -21,6 +21,7 @@ import { encodeRequestErc20Approval } from './encoder-approval';
 import { encodeRequestPayment } from './encoder-payment';
 import { IPreparedTransaction } from './prepared-transaction';
 import { IRequestPaymentOptions } from './settings';
+export { INearTransactionCallback } from './utils-near';
 
 export const noConversionNetworks = [
   ExtensionTypes.ID.PAYMENT_NETWORK_ERC777_STREAM,
diff --git a/packages/payment-processor/src/payment/near-conversion.ts b/packages/payment-processor/src/payment/near-conversion.ts
@@ -9,7 +9,11 @@ import {
   getAmountToPay,
   getPaymentExtensionVersion,
 } from './utils';
-import { isNearNetwork, processNearPaymentWithConversion } from './utils-near';
+import {
+  INearTransactionCallback,
+  isNearNetwork,
+  processNearPaymentWithConversion,
+} from './utils-near';
 import { IConversionPaymentSettings } from '.';
 import { CurrencyManager, UnsupportedCurrencyError } from '@requestnetwork/currency';
 
@@ -24,6 +28,7 @@ export async function payNearConversionRequest(
   walletConnection: WalletConnection,
   paymentSettings: IConversionPaymentSettings,
   amount?: BigNumberish,
+  callback?: INearTransactionCallback,
 ): Promise<void> {
   validateRequest(request, PaymentTypes.PAYMENT_NETWORK_ID.ANY_TO_NATIVE);
 
@@ -59,6 +64,7 @@ export async function payNearConversionRequest(
     paymentSettings.maxToSpend,
     maxRateTimespan || '0',
     version,
+    callback,
   );
 }
 
diff --git a/packages/payment-processor/src/payment/near-input-data.ts b/packages/payment-processor/src/payment/near-input-data.ts
@@ -9,7 +9,7 @@ import {
   getAmountToPay,
   getPaymentExtensionVersion,
 } from './utils';
-import { isNearNetwork, processNearPayment } from './utils-near';
+import { INearTransactionCallback, isNearNetwork, processNearPayment } from './utils-near';
 
 /**
  * processes the transaction to pay a Near request.
@@ -21,6 +21,7 @@ export async function payNearInputDataRequest(
   request: ClientTypes.IRequestData,
   walletConnection: WalletConnection,
   amount?: BigNumberish,
+  callback?: INearTransactionCallback,
 ): Promise<void> {
   if (!request.currencyInfo.network || !isNearNetwork(request.currencyInfo.network)) {
     throw new Error('request.currencyInfo should be a Near network');
@@ -42,5 +43,6 @@ export async function payNearInputDataRequest(
     paymentAddress,
     paymentReference,
     version,
+    callback,
   );
 }
diff --git a/packages/payment-processor/src/payment/utils-near.ts b/packages/payment-processor/src/payment/utils-near.ts
@@ -6,6 +6,16 @@ import {
   NearConversionNativeTokenPaymentDetector,
 } from '@requestnetwork/payment-detection';
 
+/**
+ * Callback arguments for the Near web wallet.
+ * @member callbackUrl called upon transaction approval
+ * @member callbackMeta (according to Near docs: `meta` will be attached to the `callbackUrl` as a url search param)
+ */
+export interface INearTransactionCallback {
+  callbackUrl?: string;
+  meta?: string;
+}
+
 export const isValidNearAddress = async (nearNetwork: Near, address: string): Promise<boolean> => {
   try {
     await nearNetwork.connection.provider.query(`account/${address}`, '');
@@ -44,6 +54,7 @@ export const processNearPayment = async (
   to: string,
   paymentReference: string,
   version = '0.2.0',
+  callback: INearTransactionCallback | undefined = undefined,
 ): Promise<void> => {
   if (version !== '0.2.0') {
     if (version === '0.1.0') {
@@ -66,14 +77,15 @@ export const processNearPayment = async (
         viewMethods: [],
       },
     ) as any;
-    await contract.transfer_with_reference(
-      {
+    await contract.transfer_with_reference({
+      args: {
         to,
         payment_reference: paymentReference,
       },
-      GAS_LIMIT_NATIVE,
-      amount.toString(),
-    );
+      gas: GAS_LIMIT_NATIVE,
+      amount: amount.toString(),
+      ...callback,
+    });
     return;
   } catch (e) {
     throw new Error(`Could not pay Near request. Got ${e.message}`);
@@ -99,6 +111,7 @@ export const processNearPaymentWithConversion = async (
   maxToSpend: BigNumberish,
   maxRateTimespan = '0',
   version = '0.1.0',
+  callback: INearTransactionCallback | undefined = undefined,
 ): Promise<void> => {
   if (version !== '0.1.0') {
     throw new Error('Native Token with conversion payments on Near only support v0.1.0 extensions');
@@ -120,8 +133,8 @@ export const processNearPaymentWithConversion = async (
         viewMethods: [],
       },
     ) as any;
-    await contract.transfer_with_reference(
-      {
+    await contract.transfer_with_reference({
+      args: {
         payment_reference: paymentReference,
         to,
         amount,
@@ -130,9 +143,10 @@ export const processNearPaymentWithConversion = async (
         fee_amount: feeAmount,
         max_rate_timespan: maxRateTimespan,
       },
-      GAS_LIMIT_CONVERSION_TO_NATIVE,
-      maxToSpend.toString(),
-    );
+      gas: GAS_LIMIT_CONVERSION_TO_NATIVE,
+      amount: maxToSpend.toString(),
+      ...callback,
+    });
     return;
   } catch (e) {
     throw new Error(`Could not pay Near request. Got ${e.message}`);
diff --git a/packages/payment-processor/test/payment/any-to-near.test.ts b/packages/payment-processor/test/payment/any-to-near.test.ts
@@ -65,7 +65,13 @@ describe('payNearWithConversionRequest', () => {
       paymentAddress,
     );
 
-    await payNearConversionRequest(request, mockedNearWalletConnection, conversionSettings);
+    await payNearConversionRequest(
+      request,
+      mockedNearWalletConnection,
+      conversionSettings,
+      undefined,
+      { callbackUrl: 'https://some.callback.url', meta: 'param' },
+    );
     expect(paymentSpy).toHaveBeenCalledWith(
       expect.anything(),
       'aurora',
@@ -78,6 +84,10 @@ describe('payNearWithConversionRequest', () => {
       conversionSettings.maxToSpend,
       '0',
       '0.1.0',
+      {
+        callbackUrl: 'https://some.callback.url',
+        meta: 'param',
+      },
     );
   });
   it('throws when tyring to pay another payment extension', async () => {
diff --git a/packages/payment-processor/test/payment/index.test.ts b/packages/payment-processor/test/payment/index.test.ts
@@ -180,14 +180,18 @@ describe('payNearInputDataRequest', () => {
       },
     };
 
-    await payNearInputDataRequest(request, mockedNearWalletConnection, '1');
+    await payNearInputDataRequest(request, mockedNearWalletConnection, '1', {
+      callbackUrl: 'https://some.callback.url',
+      meta: 'param',
+    });
     expect(paymentSpy).toHaveBeenCalledWith(
       expect.anything(),
       'aurora',
       '1',
       '0x789',
       '700912030bd973e3',
       '0.2.0',
+      { callbackUrl: 'https://some.callback.url', meta: 'param' },
     );
   });
   it('throws when tyring to pay another payment extension', async () => {
diff --git a/yarn.lock b/yarn.lock
@@ -8478,16 +8478,21 @@ bn.js@5.1.3:
   resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.1.3.tgz#beca005408f642ebebea80b042b4d18d2ac0ee6b"
   integrity sha512-GkTiFpjFtUzU9CbMeJ5iazkCzGL3jrhzerzZIuqLABjbwRaFt33I9tUdSNryIptM+RxDet6OKm2WnLXzW51KsQ==
 
-bn.js@5.2.0, bn.js@^5.0.0, bn.js@^5.1.1, bn.js@^5.1.2, bn.js@^5.1.3:
-  version "5.2.0"
-  resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.2.0.tgz#358860674396c6997771a9d051fcc1b57d4ae002"
-  integrity sha512-D7iWRBvnZE8ecXiLj/9wbxH7Tk79fAh8IHaTNq1RWRixsS02W+5qS+iE9yq6RYl0asXx5tw0bLhmT5pIfbSquw==
+bn.js@5.2.1, bn.js@^5.2.0:
+  version "5.2.1"
+  resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.2.1.tgz#0bc527a6a0d18d0aa8d5b0538ce4a77dccfa7b70"
+  integrity sha512-eXRvHzWyYPBuB4NBy0cmYQjGitUrtqwbvlzP3G6VFnNRbsZQIxQ10PbKKHt8gZ/HW/D/747aDl+QkDqg3KQLMQ==
 
 bn.js@^4.0.0, bn.js@^4.1.0, bn.js@^4.10.0, bn.js@^4.11.0, bn.js@^4.11.1, bn.js@^4.11.6, bn.js@^4.11.8, bn.js@^4.11.9, bn.js@^4.4.0, bn.js@^4.8.0:
   version "4.12.0"
   resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-4.12.0.tgz#775b3f278efbb9718eec7361f483fb36fbbfea88"
   integrity sha512-c98Bf3tPniI+scsdk237ku1Dc3ujXQTSgyiPUDEOe7tRkhrqridvh8klBv0HCEso1OLOYcHuCv/cS6DNxKH+ZA==
 
+bn.js@^5.0.0, bn.js@^5.1.1, bn.js@^5.1.2, bn.js@^5.1.3:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/bn.js/-/bn.js-5.2.0.tgz#358860674396c6997771a9d051fcc1b57d4ae002"
+  integrity sha512-D7iWRBvnZE8ecXiLj/9wbxH7Tk79fAh8IHaTNq1RWRixsS02W+5qS+iE9yq6RYl0asXx5tw0bLhmT5pIfbSquw==
+
 body-parser@1.19.0, body-parser@^1.16.0:
   version "1.19.0"
   resolved "https://registry.yarnpkg.com/body-parser/-/body-parser-1.19.0.tgz#96b2709e57c9c4e09a6fd66a8fd979844f69f08a"
@@ -8521,13 +8526,12 @@ boolbase@^1.0.0, boolbase@~1.0.0:
   resolved "https://registry.yarnpkg.com/boolbase/-/boolbase-1.0.0.tgz#68dff5fbe60c51eb37725ea9e3ed310dcc1e776e"
   integrity sha1-aN/1++YMUes3cl6p4+0xDcwed24=
 
-borsh@^0.4.0:
-  version "0.4.0"
-  resolved "https://registry.yarnpkg.com/borsh/-/borsh-0.4.0.tgz#9dd6defe741627f1315eac2a73df61421f6ddb9f"
-  integrity sha512-aX6qtLya3K0AkT66CmYWCCDr77qsE9arV05OmdFpmat9qu8Pg9J5tBUPDztAW5fNh/d/MyVG/OYziP52Ndzx1g==
+borsh@^0.7.0:
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/borsh/-/borsh-0.7.0.tgz#6e9560d719d86d90dc589bca60ffc8a6c51fec2a"
+  integrity sha512-CLCsZGIBCFnPtkNnieW/a8wmreDmfUtjU2m9yHrzPXIlNbqVs0AQrSatSG6vdNYUqdc83tkQi2eHfF98ubzQLA==
   dependencies:
-    "@types/bn.js" "^4.11.5"
-    bn.js "^5.0.0"
+    bn.js "^5.2.0"
     bs58 "^4.0.0"
     text-encoding-utf-8 "^1.0.2"
 
@@ -11965,14 +11969,14 @@ error-ex@^1.2.0, error-ex@^1.3.1:
   dependencies:
     is-arrayish "^0.2.1"
 
-error-polyfill@^0.1.2:
-  version "0.1.2"
-  resolved "https://registry.yarnpkg.com/error-polyfill/-/error-polyfill-0.1.2.tgz#05b27de7d126cbc9d42a96f45faab28a98a0b28b"
-  integrity sha512-8uhnXlJuhFkmIfhw2tAHtWQGpXcw5rrc0dhuY3bhn8tBHvh6l0oL9VJvR2suqx9eltglKKhVPv8luPQy+UxLTA==
+error-polyfill@^0.1.3:
+  version "0.1.3"
+  resolved "https://registry.yarnpkg.com/error-polyfill/-/error-polyfill-0.1.3.tgz#df848b61ad8834f7a5db69a70b9913df86721d15"
+  integrity sha512-XHJk60ufE+TG/ydwp4lilOog549iiQF2OAPhkk9DdiYWMrltz5yhDz/xnKuenNwP7gy3dsibssO5QpVhkrSzzg==
   dependencies:
     capability "^0.2.5"
     o3 "^1.0.3"
-    u3 "^0.1.0"
+    u3 "^0.1.1"
 
 es-abstract@^1.17.2, es-abstract@^1.18.0-next.1, es-abstract@^1.18.0-next.2:
   version "1.18.0"
@@ -19429,16 +19433,16 @@ natural-compare@^1.4.0:
   resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7"
   integrity sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=
 
-near-api-js@0.42.0:
-  version "0.42.0"
-  resolved "https://registry.yarnpkg.com/near-api-js/-/near-api-js-0.42.0.tgz#1f773791e930a349be65b866752bbae67df4388d"
-  integrity sha512-YtDR0sXHL2CclXZdscqUIjoc4Vp/o09CSY1lQ6mygSNbWp5ghLAR1kNBQnALGGQhYC6NLBCzJQJZMb2IQr2WzA==
+near-api-js@1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/near-api-js/-/near-api-js-1.1.0.tgz#907e807f052c1f043c6fbf28f61872de3c02235a"
+  integrity sha512-qYKv1mYsaDZc2uYndhS+ttDhR9+60qFc+ZjD6lWsAxr3ZskMjRwPffDGQZYhC7BRDQMe1HEbk6d5mf+TVm0Lqg==
   dependencies:
-    bn.js "5.2.0"
-    borsh "^0.4.0"
+    bn.js "5.2.1"
+    borsh "^0.7.0"
     bs58 "^4.0.0"
     depd "^2.0.0"
-    error-polyfill "^0.1.2"
+    error-polyfill "^0.1.3"
     http-errors "^1.7.2"
     js-sha256 "^0.9.0"
     mustache "^4.0.0"
@@ -26150,10 +26154,10 @@ typical@^2.6.0, typical@^2.6.1:
   resolved "https://registry.yarnpkg.com/typical/-/typical-2.6.1.tgz#5c080e5d661cbbe38259d2e70a3c7253e873881d"
   integrity sha1-XAgOXWYcu+OCWdLnCjxyU+hziB0=
 
-u3@^0.1.0:
-  version "0.1.0"
-  resolved "https://registry.yarnpkg.com/u3/-/u3-0.1.0.tgz#0060927663b68353c539cda99e9511d6687edd9d"
-  integrity sha1-AGCSdmO2g1PFOc2pnpUR1mh+3Z0=
+u3@^0.1.1:
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/u3/-/u3-0.1.1.tgz#5f52044f42ee76cd8de33148829e14528494b73b"
+  integrity sha512-+J5D5ir763y+Am/QY6hXNRlwljIeRMZMGs0cT6qqZVVzzT3X3nFPXVyPOFRMOR4kupB0T8JnCdpWdp6Q/iXn3w==
 
 ua-parser-js@^0.7.18:
   version "0.7.25"
