Warp readme #1780
Warp readme #1780
Conversation
aaronbuchwald
requested review from
abi87,
danlaine and
StephenButtolph
as code owners
|
@StephenButtolph would you be ok with including a note about special case handling for the Primary Network here or would you prefer to leave that to VMs? |
Co-authored-by: Martin Eckardt <[email protected]> Co-authored-by: rodrigo <[email protected]> Signed-off-by: aaronbuchwald <[email protected]>
Co-authored-by: Stephen Buttolph <[email protected]> Signed-off-by: aaronbuchwald <[email protected]>
| +-----------------+----------+--------------------------+ | ||
| | source_chain_id : [32]byte | 32 bytes | | ||
| +-----------------+----------+--------------------------+ | ||
| | payload : []byte | 4 + size(payload) | |
There was a problem hiding this comment.
4 bytes + size(payload) here?
There was a problem hiding this comment.
the length is encoded as uint32 followed by the payload
vms/platformvm/warp/README.md
Outdated
| +-----------------+----------+--------------------------+ | ||
| | payload : []byte | 4 + size(payload) | | ||
| +-----------------+----------+--------------------------+ | ||
| | 38 + size(payload) bytes| |
There was a problem hiding this comment.
- Whatever we choose for the above we should do here to make it consistent
- What is this? Some header? I currently understand this to be a total, in which case i think this should actually be
4 + 32 + 4 = 40 + size(payload) bytes.
There was a problem hiding this comment.
This was incorrect, updating
|
|
||
| BLS provides a way to aggregate signatures off chain into a single signature that can be efficiently verified on chain. | ||
|
|
||
| ## AWM Serialization |
There was a problem hiding this comment.
For this section we're making our own table diagrams but markdown supports this via https://www.markdownguide.org/extended-syntax/#tables
I'm not sure if you meant to do this if you prefer the ASCII look but this is something else to consider (I love ASCII, but others might hate it).
There was a problem hiding this comment.
This is following the style we've used here: https://docs.avax.network/reference/avalanchego/p-chain/txn-format. Happy to change it to a more standard format throughout our docs, but don't think that should be a requirement for this PR.
vms/platformvm/warp/README.md
Outdated
| - `networkID` is the unique ID of an Avalanche Network (Mainnet/Testnet) and provides replay protection for BLS Signers across different Avalanche Networks | ||
| - `sourceChainID` is the `blockchainID` of the blockchain sending a message. This ensures that each blockchain can only sign a message with its own `blockchainID`. Note: the `blockchainID` is the hash of the transaction that created the blockchain on the Avalanche P-Chain. It serves as the unique identifier for the blockchain across the Avalanche Network. |
There was a problem hiding this comment.
source_chain_id and network_id to be consistent with the diagram
Co-authored-by: Joshua Kim <[email protected]> Signed-off-by: aaronbuchwald <[email protected]>
StephenButtolph
added
the
documentation
This PR adds a README to the Avalanche Warp package.