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.

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

chore(taiko-client): update some comments #18908

Merged
merged 4 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/taiko-client--pages.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "Taiko Client Soft Blocks Documentation"
name: "Taiko Client Preconf Blocks Documentation"

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion packages/taiko-client/driver/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ type Driver struct {
l1HeadCh chan *types.Header
l1HeadSub event.Subscription

// P2P network for soft block propagation
// P2P network for preconf block propagation
p2pNode *p2p.NodeP2P
p2pSigner p2p.Signer
p2pSetup p2p.SetupP2P
Expand Down
8 changes: 4 additions & 4 deletions packages/taiko-client/driver/preconf_blocks/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ type ExecutableData struct {
}

// BuildPreconfBlockRequestBody represents a request body when handling
// soft blocks creation requests.
// preconf blocks creation requests.
type BuildPreconfBlockRequestBody struct {
// @param ExecutableData engine.ExecutableData the data necessary to execute an EL payload.
ExecutableData *ExecutableData `json:"executableData"`
Expand All @@ -59,11 +59,11 @@ type BuildPreconfBlockRequestBody struct {
// BuildPreconfBlockResponseBody represents a response body when handling preconf
// blocks creation requests.
type BuildPreconfBlockResponseBody struct {
// @param blockHeader types.Header of the soft block
// @param blockHeader types.Header of the preconf block
BlockHeader *types.Header `json:"blockHeader"`
}

// BuildSoftBlock handles a preconfirmation block creation request,
// BuildPreconfBlock handles a preconfirmation block creation request,
// if the preconfirmation block creation body in request are valid, it will insert the correspoinding the
// preconfirmation block to the backend L2 execution engine and return a success response.
//
Expand Down Expand Up @@ -194,7 +194,7 @@ type RemovePreconfBlocksResponseBody struct {
HeadsRemoved uint64 `json:"headsRemoved"`
}

// RemoveSoftBlocks removes the backend L2 execution engine preconf head.
// RemovePreconfBlocks removes the backend L2 execution engine preconf head.
//
// @Description Remove all preconf blocks from the blockchain beyond the specified block height,
// @Description ensuring the latest block ID does not exceed the given height. This method will fail if
Expand Down
2 changes: 1 addition & 1 deletion packages/taiko-client/driver/preconf_blocks/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type PreconfBlockAPIServer struct {
rpc *rpc.Client
txListDecompressor *txListDecompressor.TxListDecompressor
checkSig bool
// P2P network for soft block propagation
// P2P network for preconf block propagation
p2pNode *p2p.NodeP2P
p2pSigner p2p.Signer
}
Expand Down
1 change: 1 addition & 0 deletions packages/taiko-client/proposer/transaction_builder/blob.go
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ func (b *BlobTransactionBuilder) BuildPacaya(
blockParams = append(blockParams, pacayaBindings.ITaikoInboxBlockParams{
NumTransactions: uint16(len(txs)),
TimeShift: 0,
SignalSlots: make([][32]byte, 0),
})
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ func (b *CalldataTransactionBuilder) BuildPacaya(
blockParams = append(blockParams, pacayaBindings.ITaikoInboxBlockParams{
NumTransactions: uint16(len(txs)),
TimeShift: 0,
SignalSlots: make([][32]byte, 0),
})
}

Expand Down