Skip to content

Commit aec302c

Browse files
olivier7delfolivier7delf
committed
rename batchRouter function into batchPayment
1 parent 552ebbb commit aec302c

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

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

Lines changed: 5 additions & 5 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-
* batchRouter is the main function to batch all kinds of payments at once.
16+
* batchPayment 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 batchRouter is the main function, but other batch payment functions are "public" in order to do
18+
* @dev batchPayment 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 {
@@ -25,8 +25,8 @@ contract BatchConversionPayments is BatchNoConversionPayments {
2525
IEthConversionProxy public paymentEthConversionProxy;
2626

2727
/**
28-
* @dev Used by the batchRouter to handle information for heterogeneous batches, grouped by payment network.
29-
* - paymentNetworkId: from 0 to 4, cf. `batchRouter()` method.
28+
* @dev Used by the batchPayment to handle information for heterogeneous batches, grouped by payment network.
29+
* - paymentNetworkId: from 0 to 4, cf. `batchPayment()` method.
3030
* - requestDetails all the data required for conversion and no conversion requests to be paid
3131
*/
3232
struct MetaDetail {
@@ -73,7 +73,7 @@ contract BatchConversionPayments is BatchNoConversionPayments {
7373
* @param pathsToUSD The list of paths into USD for every token, used to limit the batch fees.
7474
* Without paths, there is not limitation.
7575
* @param feeAddress The address where fees should be paid
76-
* @dev batchRouter only reduces gas consumption when using more than a single payment network.
76+
* @dev batchPayment only reduces gas consumption when using more than a single payment network.
7777
* For single payment network payments, it is more efficient to use the suited batch function.
7878
*/
7979
function batchPayment(

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ contract BatchNoConversionPayments is Ownable {
3737
/** batchPayment function is the caller */
3838
bool internal batchPaymentOrigin = false;
3939

40-
/** transferBackRemainingEth is set to false only if the payer use batchRouter
40+
/** transferBackRemainingEth is set to false only if the payer use batchPayment
4141
and call both batchEthPayments and batchConversionEthPaymentsWithReference */
4242
bool internal transferBackRemainingEth = true;
4343

‎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
@@ -519,7 +519,7 @@
519519
"type": "address"
520520
}
521521
],
522-
"name": "batchRouter",
522+
"name": "batchPayment",
523523
"outputs": [],
524524
"stateMutability": "payable",
525525
"type": "function"

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -319,12 +319,12 @@ describe('contract: BatchConversionPayments', async () => {
319319
);
320320
};
321321

322-
describe('batchRouter', async () => {
322+
describe('batchPayment', async () => {
323323
describe('payment under the fee limit', async () => {
324324
it(`make 1 ERC20 payment with no conversion`, async () => {
325325
const [initialFromFAUBalance, initialToFAUBalance, initialFeeFAUBalance] =
326326
await getERC20Balances(fauERC20);
327-
await batchConversionProxy.batchRouter(
327+
await batchConversionProxy.batchPayment(
328328
[
329329
{
330330
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_PAYMENTS,
@@ -361,7 +361,7 @@ describe('contract: BatchConversionPayments', async () => {
361361
});
362362
it('make 3 ERC20 payments with different tokens and conversion lengths', async () => {
363363
const batchPayment = async () => {
364-
return await batchConversionProxy.batchRouter(
364+
return await batchConversionProxy.batchPayment(
365365
[
366366
{
367367
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_CONVERSION_PAYMENTS,
@@ -384,7 +384,7 @@ describe('contract: BatchConversionPayments', async () => {
384384
const initialFeeETHBalance = await provider.getBalance(feeAddress);
385385
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
386386

387-
tx = await batchConversionProxy.batchRouter(
387+
tx = await batchConversionProxy.batchPayment(
388388
[
389389
{
390390
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ETH_PAYMENTS,
@@ -421,7 +421,7 @@ describe('contract: BatchConversionPayments', async () => {
421421
const initialToETHBalance = await provider.getBalance(to);
422422
const initialFeeETHBalance = await provider.getBalance(feeAddress);
423423
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
424-
tx = await batchConversionProxy.batchRouter(
424+
tx = await batchConversionProxy.batchPayment(
425425
[
426426
{
427427
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ETH_CONVERSION_PAYMENTS,
@@ -452,7 +452,7 @@ describe('contract: BatchConversionPayments', async () => {
452452
const initialFeeETHBalance = await provider.getBalance(feeAddress);
453453
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
454454

455-
tx = await batchConversionProxy.batchRouter(
455+
tx = await batchConversionProxy.batchPayment(
456456
[
457457
{
458458
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_CONVERSION_PAYMENTS,
@@ -570,7 +570,7 @@ describe('contract: BatchConversionPayments', async () => {
570570
it(`make 1 ERC20 payment with no conversion, BATCH_ERC20_PAYMENTS`, async () => {
571571
const [initialFromFAUBalance, initialToFAUBalance, initialFeeFAUBalance] =
572572
await getERC20Balances(fauERC20);
573-
await batchConversionProxy.batchRouter(
573+
await batchConversionProxy.batchPayment(
574574
[
575575
{
576576
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ERC20_PAYMENTS,
@@ -614,7 +614,7 @@ describe('contract: BatchConversionPayments', async () => {
614614
it(`make 1 ERC20 payment with no conversion`, async () => {
615615
const [initialFromFAUBalance, initialToFAUBalance, initialFeeFAUBalance] =
616616
await getERC20Balances(fauERC20);
617-
await batchConversionProxy.batchRouter(
617+
await batchConversionProxy.batchPayment(
618618
[
619619
{
620620
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_PAYMENTS,
@@ -658,7 +658,7 @@ describe('contract: BatchConversionPayments', async () => {
658658
it(`make 1 ERC20 payment with no conversion and wrong paths to USD`, async () => {
659659
const [initialFromFAUBalance, initialToFAUBalance, initialFeeFAUBalance] =
660660
await getERC20Balances(fauERC20);
661-
await batchConversionProxy.batchRouter(
661+
await batchConversionProxy.batchPayment(
662662
[
663663
{
664664
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_PAYMENTS,
@@ -705,7 +705,7 @@ describe('contract: BatchConversionPayments', async () => {
705705
const [initialFromDAIBalance, initialToDAIBalance, initialFeeDAIBalance] =
706706
await getERC20Balances(daiERC20);
707707

708-
tx = await batchConversionProxy.batchRouter(
708+
tx = await batchConversionProxy.batchPayment(
709709
[
710710
{
711711
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_CONVERSION_PAYMENTS,
@@ -771,7 +771,7 @@ describe('contract: BatchConversionPayments', async () => {
771771
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
772772
const USDReqAmount = 200000000000;
773773
const reqAmount = BigNumber.from(USDReqAmount).mul(USD_ETH_RATE).toString();
774-
tx = await batchConversionProxy.batchRouter(
774+
tx = await batchConversionProxy.batchPayment(
775775
[
776776
{
777777
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ETH_PAYMENTS,
@@ -817,7 +817,7 @@ describe('contract: BatchConversionPayments', async () => {
817817
const reqAmount = 200000000000;
818818
const copyEthConvRequest = Utils.deepCopy(ethConvRequest);
819819
copyEthConvRequest.requestAmount = reqAmount.toString();
820-
tx = await batchConversionProxy.batchRouter(
820+
tx = await batchConversionProxy.batchPayment(
821821
[
822822
{
823823
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_ETH_CONVERSION_PAYMENTS,
@@ -853,7 +853,7 @@ describe('contract: BatchConversionPayments', async () => {
853853
const initialFeeETHBalance = await provider.getBalance(feeAddress);
854854
const initialFromETHBalance = await provider.getBalance(await fromSigner.getAddress());
855855

856-
tx = await batchConversionProxy.batchRouter(
856+
tx = await batchConversionProxy.batchPayment(
857857
[
858858
{
859859
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_CONVERSION_PAYMENTS,
@@ -958,10 +958,10 @@ describe('contract: BatchConversionPayments', async () => {
958958
});
959959
});
960960
});
961-
describe('batchRouter errors', async () => {
962-
it(`too many elements within batchRouter metaDetails input`, async () => {
961+
describe('batchPayment errors', async () => {
962+
it(`too many elements within batchPayment metaDetails input`, async () => {
963963
await expect(
964-
batchConversionProxy.batchRouter(
964+
batchConversionProxy.batchPayment(
965965
Array(6).fill({
966966
paymentNetworkId: BATCH_PAYMENT_NETWORK_ID.BATCH_MULTI_ERC20_PAYMENTS,
967967
requestDetails: [],
@@ -973,7 +973,7 @@ describe('contract: BatchConversionPayments', async () => {
973973
});
974974
it(`wrong paymentNetworkId set in metaDetails input`, async () => {
975975
await expect(
976-
batchConversionProxy.batchRouter(
976+
batchConversionProxy.batchPayment(
977977
[
978978
{
979979
paymentNetworkId: 6,

0 commit comments

Comments
 (0)