forked from zeropoolnetwork/zeropool-client-js
-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
Decentralized sequencer support #182
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Feb 26, 2024
AllFi
approved these changes
Feb 28, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
AllFi
approved these changes
Aug 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The changes introduced by this PR are intended to implement the decentralized sequencer architecture as described here
The following major changes were made:
sequencer
was introduced. It's unify relayer and proxy subsystemsproxyUrls
was added to thePool
config (relayerUrls
field is also optional now). Depending on which of the fields defined the library selects obsolete relayer-based interaction scheme or the modern one based on proxies and provers. The Pool config must include one ofproxyUrls
ORrelayerUrls
field. Defining both of these properties will cause an internal error. Also thedelegatedProverUrls
field becomes optionalProxyFee
interface which extendsRelayerFee
withproxyAddress: string
andproverFee: bigint
fields:RelayerFee
entries was substituted withSequencesFee = RelayerFee | ProxyFee
. It describes the fee returned by a sequencerTxFee
interface which described atomic transaction fee properties. It consist of proxy/prover/total fee, and proxy address. It's an universal interface for the any sequencer. In case of relayer the proxy address and prover fee aren't used and proxy fee interpret as a relayer feeZkBobClient.getRelayerFee
was renamed toZkBobClient.getSequencerFee
ZkBobClient.atomicTxFee
returnsTxFee
object instead ofbigint
minTxAmount
routine now returns 1/20 part of the token as a minimal transaction amount. You can override it with the associated optional property of thePool
definition (as before)ZkBobClient.getRelayerState
was renamed toZkBobClient.getSequencerState
ZkBobClient.getRelayerOptimisticState
was renamed toZkBobClient.getSequencerOptimisticState
ZkBobClient.getRelayerVersion
was renamed toZkBobClient.getSequencerVersion
ZkBobClient.getProverVersion
was renamed toZkBobClient.getDelegatedProverVersion
FeeAmont.relayerFee
was replaced withFeeAmont.sequencerFee
zkbob_sepolia:
was substituted withzkbob_sepold:
The library was published as a beta and using in the following chain: