Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pathfinder max transfer steps as core option #180

Merged
merged 1 commit into from
Mar 31, 2023
Merged

Add pathfinder max transfer steps as core option #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,15 @@ export default class CirclesCore {
type: 'string',
default: 'server',
},
pathfinderMaxTransferSteps: {
type: 'number',
/* Due to block gas limit of 12.500.000 a transitive transaction can have a
* limited number of steps. The limit below gives a 50% buffer between the
* gas estimate and the block gas limit.
* For more information, see the Circles handbook.
*/
default: 30,
},
});

// Expose error classes and constants
Expand Down
34 changes: 21 additions & 13 deletions src/token.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,6 @@ import checkOptions from '~/common/checkOptions';
import { getTokenContract } from '~/common/getContracts';
import { getVersion } from '~/safe';

/* Due to block gas limit of 12.500.000 a transitive transaction can have a
* limited number of steps. The limit below gives a 50% buffer between the
* gas estimate and the block gas limit.
* For more information, see the Circles handbook.
*/
const MAX_TRANSFER_STEPS = 30;

/**
* Find maximumFlow and transfer steps through a trust graph from someone to
* someone else to transitively send an amount of Circles using the binary
Expand All @@ -23,6 +16,8 @@ const MAX_TRANSFER_STEPS = 30;
* @param {Web3} web3 - Web3 instance
* @param {Object} utils - core utils
* @param {Object} userOptions - search arguments
* @param {string} pathfinderType - pathfinder execution type
* @param {number} pathfinderMaxTransferSteps - default pathfinder server max transfer steps
*
* @return {Object[]} - transaction steps
*/
Expand All @@ -31,14 +26,20 @@ export async function findTransitiveTransfer(
utils,
userOptions,
pathfinderType,
pathfinderMaxTransferSteps,
) {
let result;
if (pathfinderType == 'cli') {
// call cli pathfinders
result = await findTransitiveTransferCli(web3, utils, userOptions);
} else if (pathfinderType == 'server') {
// call server
result = await findTransitiveTransferServer(web3, utils, userOptions);
result = await findTransitiveTransferServer(
web3,
utils,
userOptions,
pathfinderMaxTransferSteps,
);
}
return result;
}
Expand Down Expand Up @@ -111,7 +112,12 @@ async function findTransitiveTransferCli(web3, utils, userOptions) {
*
* @return {Object[]} - transaction steps
*/
async function findTransitiveTransferServer(web3, utils, userOptions) {
async function findTransitiveTransferServer(
web3,
utils,
userOptions,
pathfinderMaxTransferSteps,
) {
const options = checkOptions(userOptions, {
from: {
type: web3.utils.checkAddressChecksum,
Expand All @@ -124,7 +130,7 @@ async function findTransitiveTransferServer(web3, utils, userOptions) {
},
maxTransfers: {
type: 'number',
default: MAX_TRANSFER_STEPS,
default: pathfinderMaxTransferSteps,
},
});

Expand Down Expand Up @@ -219,7 +225,7 @@ export default function createTokenModule(
globalOptions,
) {
const { hub } = contracts;
const { pathfinderType } = globalOptions;
const { pathfinderType, pathfinderMaxTransferSteps } = globalOptions;
return {
/**
* Returns true if there are enough balance on this Safe address to deploy
Expand Down Expand Up @@ -450,6 +456,7 @@ export default function createTokenModule(
utils,
userOptions,
pathfinderType,
pathfinderMaxTransferSteps,
);
},

Expand Down Expand Up @@ -531,7 +538,7 @@ export default function createTokenModule(
},
maxTransfers: {
type: 'number',
default: MAX_TRANSFER_STEPS,
default: pathfinderMaxTransferSteps,
},
};
}
Expand Down Expand Up @@ -578,6 +585,7 @@ export default function createTokenModule(
utils,
options,
pathfinderType,
pathfinderMaxTransferSteps,
);
if (web3.utils.toBN(response.maxFlowValue).lt(options.value)) {
throw new TransferError(
Expand All @@ -589,7 +597,7 @@ export default function createTokenModule(
},
);
}
if (response.transferSteps.length > MAX_TRANSFER_STEPS) {
if (response.transferSteps.length > pathfinderMaxTransferSteps) {
throw new TransferError(
'Too many transfer steps',
ErrorCodes.TOO_COMPLEX_TRANSFER,
Expand Down