add transaction lifecycle

worldcoin · Oct 30, 2024 · 741e95c · 741e95c
1 parent 5b3564f
commit 741e95c
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/world-chain-builder/docs/README.md b/world-chain-builder/docs/README.md
@@ -10,11 +10,18 @@ The builder defines a custom transaction envelope for PBH transactions while ret
 
 A detailed outline of the PBH transaction envelope can be found [here](PbhEnvelope.md). 
 
-This custom transaction envelope enables a custom ordering policy during block construction that disjoins the fee markets between orb verified humans, and all other transactions on the network. This significantly mitigates the negative extranalities of Mev, and optimizes time of inclusion for verified humans on world-chain.
+This custom transaction envelope enables a custom ordering policy during block construction that disjoins the fee markets between orb verified humans, and all other transactions on the network. This significantly mitigates the negative extranalities of Mev, and optimizes time to inclusion for verified humans on world-chain.
 
-### Appendix
-[World Chain Network](Network.md)
+### PBH Transaction Lifecycle
+
+Because a PBH transaction has a custom transaction envelope this means that a PBH transaction may only be sent to the `world-chain-builder`. Further the transaction will not be peered by the builder to the _sequencer_, or any other clients on the network. 
+
+The `world-chain-builder` implements a custom [WorldChainEthApi](https://github.com/worldcoin/world-chain/blob/c44417727fcf510597aaf247dc1e2d8dca03a3b7/world-chain-builder/src/rpc/mod.rs#L52) that allows it to recieve PBH transaction envelopes over RPC through an `eth_sendRawTransaction` request. If a semaphore proof is attached to the transaction the [WorldChainTransactionValidator](https://github.com/worldcoin/world-chain/blob/c44417727fcf510597aaf247dc1e2d8dca03a3b7/world-chain-builder/src/pool/validator.rs#L37) will first validate the integrity of the proof, and if valid insert the transaction into the transaction pool with an associated bool indicating the pooled transaction is human verified. 
 
-[PBH Transaction Envelope](Envelope.md)
+For a detailed look at the custom transaction envelope, and validation rules see [PBH Transaction Envelope](Envelope.md).
+
+
+### Additional References
+[World Chain Network](Network.md)
 
 [Creating Human Verified Transactions](../crates/toolkit/README.md)