Skip to content

Commit

Permalink
Merge pull request #56 from worldcoin/kit/readme
Browse files Browse the repository at this point in the history
chore(docs): Fix readme
  • Loading branch information
0xKitsune authored Oct 31, 2024
2 parents 04c33f5 + e7cf51d commit 67e4d9a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

The World Chain Builder is a custom block builder for the OP Stack that provides Priority Blockspace for Humans (PBH). PBH enables verified World ID users to execute transactions with top of block priority, enabling a more frictionless user experience. This mechanism is designed to ensure that ordinary users aren’t unfairly disadvantaged by automated systems and greatly mitigates the impact of negative impacts of MEV. PBH also enables future flexibility, allowing for a separate EIP-1559-style fee market mechanism for verified transactions.

![World Chain Builder Architecture](assets/pbh-op-stack.png)

<div align="center">
<img src="assets/pbh-op-stack.png" alt="World Chain Builder Architecture" width="70%">
</div>
To learn more about how PBH works, check out the docs detailing [the PBH Transaction Lifecycle](world-chain-builder/docs/pbh_tx_lifecycle.md), [World's blog post covering World Chain's builder architecture](https://world.org/blog/engineering/introducing-pbh-priority-blockspace-for-humans), and [the PBH architecture](world-chain-builder/docs/pbh_architecture.md).
To learn more about how PBH works, check out the docs detailing [the PBH transaction lifecycle](world-chain-builder/docs/pbh_tx_lifecycle.md) and [PBH builder architecture](world-chain-builder/docs/pbh_architecture.md) as well as [World's blog post covering World Chain's builder architecture](https://world.org/blog/engineering/introducing-pbh-priority-blockspace-for-humans)


<!-- ## Installing -->
Expand Down
2 changes: 1 addition & 1 deletion world-chain-builder/docs/pbh_tx_lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The builder introduces a new [EIP-2718 RLP encoded transaction envelope](https:/

## Creating a PBH transaction

The contents of the PBH tx envelope simply consists of an [Ethereum typed transaction ](https://eips.ethereum.org/EIPS/eip-2718) and optional semaphore proof ensuring that the sender is verified World ID user. In order to create a PBH transaction envelope, first generate an [Ethereum transaction](https://ethereum.org/en/developers/docs/transactions/).
The contents of the PBH tx envelope simply consist of an [Ethereum typed transaction ](https://eips.ethereum.org/EIPS/eip-2718) and optional semaphore proof ensuring that the sender is verified World ID user. In order to create a PBH transaction envelope, first generate an [Ethereum transaction](https://ethereum.org/en/developers/docs/transactions/).

Next, [create a World ID proof](), **setting the `signal` to the transaction hash of the tx you are verifying**, and set the `externalNullifier` to the following schema `vv-mmyyyy-nn` where:

Expand Down

0 comments on commit 67e4d9a

Please sign in to comment.