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

Jump to bottom

feat: allow builder boost factor to be configured via proposer config file #6357

Merged
merged 3 commits into from
Jan 26, 2024
Merged

feat: allow builder boost factor to be configured via proposer config file #6357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fefca05
feat: allow builder boost factor to be configured via proposer config…
g11tech Jan 26, 2024
70a769a
reuse parseBuilderBoostFactor fn
g11tech Jan 26, 2024
621bc13
re-shuffle fns and add builder selection validation
g11tech Jan 26, 2024
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
29 changes: 1 addition & 28 deletions packages/cli/src/cmds/validator/handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {GlobalArgs} from "../../options/index.js";
import {YargsError, cleanOldLogFiles, getDefaultGraffiti, mkdir, parseLoggerArgs} from "../../util/index.js";
import {onGracefulShutdown, parseFeeRecipient, parseProposerConfig} from "../../util/index.js";
import {getVersionData} from "../../util/version.js";
import {parseBuilderSelection, parseBuilderBoostFactor} from "../../util/proposerConfig.js";
import {getAccountPaths, getValidatorPaths} from "./paths.js";
import {IValidatorCliArgs, validatorMetricsDefaultOptions, validatorMonitoringDefaultOptions} from "./options.js";
import {getSignersFromArgs} from "./signers/index.js";
Expand Down Expand Up @@ -254,24 +255,6 @@ function getProposerConfigFromArgs(
return valProposerConfig;
}

function parseBuilderSelection(builderSelection?: string): routes.validator.BuilderSelection | undefined {
if (builderSelection) {
switch (builderSelection) {
case "maxprofit":
break;
case "builderalways":
break;
case "builderonly":
break;
case "executiononly":
break;
default:
throw new YargsError("Invalid input for builder selection, check help");
}
}
return builderSelection as routes.validator.BuilderSelection;
}

function parseBroadcastValidation(broadcastValidation?: string): routes.beacon.BroadcastValidation | undefined {
if (broadcastValidation) {
switch (broadcastValidation) {
Expand All @@ -286,13 +269,3 @@ function parseBroadcastValidation(broadcastValidation?: string): routes.beacon.B

return broadcastValidation as routes.beacon.BroadcastValidation;
}

function parseBuilderBoostFactor(boostFactor?: string): bigint | undefined {
if (boostFactor === undefined) return;

if (!/^\d+$/.test(boostFactor)) {
throw new YargsError("Invalid input for builder boost factor, must be a valid number without decimals");
}

return BigInt(boostFactor);
}
38 changes: 36 additions & 2 deletions packages/cli/src/util/proposerConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {routes} from "@lodestar/api";
import {parseFeeRecipient} from "./feeRecipient.js";

import {readFile} from "./file.js";
import {YargsError} from "./index.js";

type ProposerConfig = ValidatorProposerConfig["defaultConfig"];

Expand All @@ -20,6 +21,7 @@ type ProposerConfigFileSection = {
// for js-yaml
gas_limit?: number;
selection?: routes.validator.BuilderSelection;
boost_factor?: bigint;
};
};

Expand Down Expand Up @@ -57,7 +59,7 @@ function parseProposerConfigSection(
overrideConfig?: ProposerConfig
): ProposerConfig {
const {graffiti, strict_fee_recipient_check, fee_recipient, builder} = proposerFileSection;
const {gas_limit, selection: builderSelection} = builder || {};
const {gas_limit, selection: builderSelection, boost_factor} = builder || {};

if (graffiti !== undefined && typeof graffiti !== "string") {
throw Error("graffiti is not 'string");
Expand All @@ -79,6 +81,9 @@ function parseProposerConfigSection(
throw Error("(Number.isNaN(Number(gas_limit)) 2");
}
}
if (boost_factor !== undefined && typeof boost_factor !== "string") {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Funny how boost_factor has type bigint | undefined yet we check for a string here. Looks confusing along with string checks on other config fields. Anyway it looks fine for the purpose of this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bigint is jsoned as a string as its not number safe

throw Error("boost_factor is not 'string");
}

return {
graffiti: overrideConfig?.graffiti ?? graffiti,
Expand All @@ -88,7 +93,8 @@ function parseProposerConfigSection(
feeRecipient: overrideConfig?.feeRecipient ?? (fee_recipient ? parseFeeRecipient(fee_recipient) : undefined),
builder: {
gasLimit: overrideConfig?.builder?.gasLimit ?? (gas_limit !== undefined ? Number(gas_limit) : undefined),
selection: overrideConfig?.builder?.selection ?? builderSelection,
selection: overrideConfig?.builder?.selection ?? parseBuilderSelection(builderSelection),
boostFactor: overrideConfig?.builder?.boostFactor ?? parseBuilderBoostFactor(boost_factor),
},
};
}
Expand All @@ -98,3 +104,31 @@ export function readProposerConfigDir(filepath: string, filename: string): Propo
const proposerConfigJSON = JSON.parse(proposerConfigStr) as ProposerConfigFileSection;
return proposerConfigJSON;
}

export function parseBuilderSelection(builderSelection?: string): routes.validator.BuilderSelection | undefined {
if (builderSelection) {
switch (builderSelection) {
case "maxprofit":
break;
case "builderalways":
break;
case "builderonly":
break;
case "executiononly":
break;
default:
throw new YargsError("Invalid input for builder selection, check help");
}
}
return builderSelection as routes.validator.BuilderSelection;
}

export function parseBuilderBoostFactor(boostFactor?: string): bigint | undefined {
if (boostFactor === undefined) return;

if (!/^\d+$/.test(boostFactor)) {
throw new YargsError("Invalid input for builder boost factor, must be a valid number without decimals");
Copy link
Member

@nflaig nflaig Jan 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just came to my mind that we might wanna use a normal Error here now as this can be thrown from multiple places and not just strictly from the CLI (yargs). Having a stacktrace might also be helpful for users to identify the error in that case.

I can address this in another PR, wanted to look into adding executionalways but this is currently conflicts with #6241, so makes sense to wait on that until that is merged.

}

return BigInt(boostFactor);
}
3 changes: 3 additions & 0 deletions packages/cli/test/unit/validator/parseProposerConfig.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const testValue = {
builder: {
gasLimit: 30000000,
selection: undefined,
boostFactor: undefined,
},
},
"0xa4855c83d868f772a579133d9f23818008417b743e8447e235d8eb78b1d8f8a9f63f98c551beb7de254400f89592314d": {
Expand All @@ -26,6 +27,7 @@ const testValue = {
builder: {
gasLimit: 35000000,
selection: routes.validator.BuilderSelection.MaxProfit,
boostFactor: BigInt(18446744073709551616),
},
},
},
Expand All @@ -36,6 +38,7 @@ const testValue = {
builder: {
gasLimit: 30000000,
selection: routes.validator.BuilderSelection.BuilderAlways,
boostFactor: BigInt(100),
},
},
};
Expand Down
2 changes: 2 additions & 0 deletions packages/cli/test/unit/validator/proposerConfigs/validData.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ proposer_config:
builder:
gas_limit: "35000000"
selection: "maxprofit"
boost_factor: "18446744073709551616"
default_config:
graffiti: 'default graffiti'
strict_fee_recipient_check: "true"
fee_recipient: '0xcccccccccccccccccccccccccccccccccccccccc'
builder:
gas_limit: "30000000"
selection: "builderalways"
boost_factor: "100"
Loading