Skip to content

Commit ac9b2a3

Browse files
olivier7delfolivier7delf
committed
rename batchPayment into batchPayments
1 parent b3b5f72 commit ac9b2a3

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

‎packages/smart-contracts/src/contracts/BatchConversionPayments.sol‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import './BatchNoConversionPayments.sol';
1313
* - Native tokens: (e.g. ETH) using EthConversionProxy and EthereumFeeProxy
1414
* - to: multiple addresses
1515
* - fees: conversion proxy fees and additional batch conversion fees are paid to the same address.
16-
* batchPayment is the main function to batch all kinds of payments at once.
16+
* batchPayments is the main function to batch all kinds of payments at once.
1717
* If one transaction of the batch fails, all transactions are reverted.
18-
* @dev batchPayment is the main function, but other batch payment functions are "public" in order to do
18+
* @dev batchPayments is the main function, but other batch payment functions are "public" in order to do
1919
* gas optimization in some cases.
2020
*/
2121
contract BatchConversionPayments is BatchNoConversionPayments {
@@ -28,8 +28,8 @@ contract BatchConversionPayments is BatchNoConversionPayments {
2828
bool private payerAuthorized = false;
2929

3030
/**
31-
* @dev Used by the batchPayment to handle information for heterogeneous batches, grouped by payment network:
32-
* - paymentNetworkId: from 0 to 4, cf. `batchPayment()` method
31+
* @dev Used by the batchPayments to handle information for heterogeneous batches, grouped by payment network:
32+
* - paymentNetworkId: from 0 to 4, cf. `batchPayments()` method
3333
* - requestDetails all the data required for conversion and no conversion requests to be paid
3434
*/
3535
struct MetaDetail {
@@ -88,10 +88,10 @@ contract BatchConversionPayments is BatchNoConversionPayments {
8888
* @param feeAddress The address where fees should be paid.
8989
* @dev Use pathsToUSD only if you are pretty sure the batch fees will higher than the
9090
* USD limit batchFeeAmountUSDLimit, because it increase gas consumption.
91-
* batchPayment only reduces gas consumption when using more than a single payment network.
91+
* batchPayments only reduces gas consumption when using more than a single payment network.
9292
* For single payment network payments, it is more efficient to use the suited batch function.
9393
*/
94-
function batchPayment(
94+
function batchPayments(
9595
MetaDetail[] calldata metaDetails,
9696
address[][] calldata pathsToUSD,
9797
address feeAddress

‎packages/smart-contracts/src/contracts/BatchNoConversionPayments.sol‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ contract BatchNoConversionPayments is Ownable {
3636
batchFeeAmountUSDLimit = 150 * 1e8 represents $150 */
3737
uint64 public batchFeeAmountUSDLimit;
3838

39-
/** transferBackRemainingNativeTokens is set to false only if the payer use batchPayment
39+
/** transferBackRemainingNativeTokens is set to false only if the payer use batchPayments
4040
and call both batchNativePayments and batchNativeConversionPayments */
4141
bool internal transferBackRemainingNativeTokens = true;
4242

‎packages/smart-contracts/src/lib/artifacts/BatchConversionPayments/0.1.0.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@
504504
"type": "address"
505505
}
506506
],
507-
"name": "batchPayment",
507+
"name": "batchPayments",
508508
"outputs": [],
509509
"stateMutability": "payable",
510510
"type": "function"

‎packages/smart-contracts/test/contracts/BatchConversionPayments.test.ts‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ describe('contract: BatchConversionPayments', async () => {
359359
);
360360
};
361361

362-
describe('batchPayment', async () => {
362+
describe('batchPayments', async () => {
363363
const testBatchPayment = async (applyLimit: boolean) => {
364364
// Limit is applied if there are paths to USD
365365
const pathsToUSD = applyLimit
@@ -376,7 +376,7 @@ describe('contract: BatchConversionPayments', async () => {
376376
const [initialFromFAUBalance, initialToFAUBalance, initialFeeFAUBalance] =
377377
await getERC20Balances(fauERC20);
378378

379-
await batchConversionProxy.batchPayment(
379+
await batchConversionProxy.batchPayments(
380380
[
381381
{
382382
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ERC20_PAYMENTS,
@@ -412,7 +412,7 @@ describe('contract: BatchConversionPayments', async () => {
412412
it(`make 1 ERC20 payment with no conversion`, async () => {
413413
const [initialFromFAUBalance, initialToFAUBalance, initialFeeFAUBalance] =
414414
await getERC20Balances(fauERC20);
415-
await batchConversionProxy.batchPayment(
415+
await batchConversionProxy.batchPayments(
416416
[
417417
{
418418
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_PAYMENTS,
@@ -446,8 +446,8 @@ describe('contract: BatchConversionPayments', async () => {
446446
);
447447
});
448448
it('make 3 ERC20 payments with different tokens and conversion lengths', async () => {
449-
const batchPayment = async () => {
450-
return await batchConversionProxy.batchPayment(
449+
const batchPayments = async () => {
450+
return await batchConversionProxy.batchPayments(
451451
[
452452
{
453453
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_CONVERSION_PAYMENTS,
@@ -468,12 +468,12 @@ describe('contract: BatchConversionPayments', async () => {
468468
const expectedFeeDAIBalanceDiff = BigNumber.from('237623762376237623762');
469469

470470
await manyPaymentsBatchConv(
471-
batchPayment,
471+
batchPayments,
472472
expectedFeeFAUBalanceDiff,
473473
expectedFeeDAIBalanceDiff,
474474
);
475475
} else {
476-
await manyPaymentsBatchConv(batchPayment);
476+
await manyPaymentsBatchConv(batchPayments);
477477
}
478478
});
479479
it('make 1 ETH payment without conversion', async () => {
@@ -482,7 +482,7 @@ describe('contract: BatchConversionPayments', async () => {
482482
const initialFeeETHBalance = await provider.getBalance(feeAddress);
483483
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
484484

485-
tx = await batchConversionProxy.batchPayment(
485+
tx = await batchConversionProxy.batchPayments(
486486
[
487487
{
488488
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ETH_PAYMENTS,
@@ -513,7 +513,7 @@ describe('contract: BatchConversionPayments', async () => {
513513
const initialToETHBalance = await provider.getBalance(to);
514514
const initialFeeETHBalance = await provider.getBalance(feeAddress);
515515
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
516-
tx = await batchConversionProxy.batchPayment(
516+
tx = await batchConversionProxy.batchPayments(
517517
[
518518
{
519519
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ETH_CONVERSION_PAYMENTS,
@@ -547,7 +547,7 @@ describe('contract: BatchConversionPayments', async () => {
547547
const initialFeeETHBalance = await provider.getBalance(feeAddress);
548548
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
549549

550-
tx = await batchConversionProxy.batchPayment(
550+
tx = await batchConversionProxy.batchPayments(
551551
[
552552
{
553553
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_CONVERSION_PAYMENTS,
@@ -666,10 +666,10 @@ describe('contract: BatchConversionPayments', async () => {
666666
await testBatchPayment(false);
667667
});
668668

669-
describe('batchPayment errors', async () => {
670-
it(`too many elements within batchPayment metaDetails input`, async () => {
669+
describe('batchPayments errors', async () => {
670+
it(`too many elements within batchPayments metaDetails input`, async () => {
671671
await expect(
672-
batchConversionProxy.batchPayment(
672+
batchConversionProxy.batchPayments(
673673
Array(6).fill({
674674
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_PAYMENTS,
675675
requestDetails: [],
@@ -681,7 +681,7 @@ describe('contract: BatchConversionPayments', async () => {
681681
});
682682
it(`wrong paymentNetworkId set in metaDetails input`, async () => {
683683
await expect(
684-
batchConversionProxy.batchPayment(
684+
batchConversionProxy.batchPayments(
685685
[
686686
{
687687
paymentNetworkId: 6,
@@ -739,7 +739,7 @@ describe('contract: BatchConversionPayments', async () => {
739739
);
740740
});
741741
it('make 3 payments with different tokens and conversion length', async () => {
742-
const batchPayment = async () => {
742+
const batchPayments = async () => {
743743
return await batchConversionProxy
744744
.connect(fromSigner)
745745
.batchMultiERC20ConversionPayments(
@@ -748,7 +748,7 @@ describe('contract: BatchConversionPayments', async () => {
748748
feeAddress,
749749
);
750750
};
751-
await manyPaymentsBatchConv(batchPayment);
751+
await manyPaymentsBatchConv(batchPayments);
752752
});
753753
});
754754

‎packages/types/src/payment-types.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ export enum BATCH_PAYMENT_NETWORK_ID {
346346
}
347347

348348
/** Input type used by batch conversion proxy to make an ERC20 & ETH,
349-
* and conversion & no-conversion payment through batchPayment */
349+
* and conversion & no-conversion payment through batchPayments */
350350
export interface MetaDetail {
351351
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID;
352352
requestDetails: RequestDetail[];

0 commit comments

Comments
 (0)