Skip to content
This repository has been archived by the owner on Jan 31, 2025. It is now read-only.

feat: Adding READMEs throughout the codebase #248

Merged
merged 9 commits into from
Dec 1, 2023

Conversation

davidterpay
Copy link
Contributor

No description provided.

@davidterpay davidterpay added backport/v1.x.x Backport your PR to the v1.x.x release backport/v2.x.x Backport your PR to the v2.x.x release labels Nov 29, 2023
@davidterpay davidterpay marked this pull request as ready for review November 29, 2023 17:11
abci/README.md Outdated Show resolved Hide resolved
abci/README.md Outdated Show resolved Hide resolved
abci/README.md Outdated Show resolved Hide resolved
abci/README.md Outdated Show resolved Hide resolved
abci/README.md Outdated Show resolved Hide resolved
adapters/signer_extraction_adapter/README.md Outdated Show resolved Hide resolved
block/README.md Outdated Show resolved Hide resolved
block/README.md Show resolved Hide resolved
block/README.md Outdated Show resolved Hide resolved
block/README.md Outdated Show resolved Hide resolved

After a given lane executes its `PrepareLaneHandler` or `ProcessLaneHandler`, it will return a set of transactions that need to be added to the current proposal that is being constructed. To update the proposal, `Update` is called with the lane that needs to add transactions to the proposal as well as the transactions that need to be added.

Proposals are updated iff:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Proposals are updated iff:
Proposals are updated _iff_:

@davidterpay davidterpay merged commit d2a7626 into main Dec 1, 2023
8 checks passed
@davidterpay davidterpay deleted the terpay/readmes-everywhere branch December 1, 2023 15:38
mergify bot pushed a commit that referenced this pull request Dec 1, 2023
* abci readme

* done wit example for abci.go

* SEA

* base lane done

* proposals

* block readme

* fixes

* proposals fix

(cherry picked from commit d2a7626)
mergify bot pushed a commit that referenced this pull request Dec 1, 2023
* abci readme

* done wit example for abci.go

* SEA

* base lane done

* proposals

* block readme

* fixes

* proposals fix

(cherry picked from commit d2a7626)
davidterpay added a commit that referenced this pull request Dec 1, 2023
* abci readme

* done wit example for abci.go

* SEA

* base lane done

* proposals

* block readme

* fixes

* proposals fix

(cherry picked from commit d2a7626)

Co-authored-by: David Terpay <[email protected]>
davidterpay added a commit that referenced this pull request Dec 1, 2023
* abci readme

* done wit example for abci.go

* SEA

* base lane done

* proposals

* block readme

* fixes

* proposals fix

(cherry picked from commit d2a7626)

Co-authored-by: David Terpay <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport/v1.x.x Backport your PR to the v1.x.x release backport/v2.x.x Backport your PR to the v2.x.x release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants