Modules§
Structs§
- Aggregate
Signature - Blob
- A Blob is a binary-serialized action that the contract has to parse An action is often written as an enum representing the call of a specific contract function.
- Blob
Data - Blob
Hash - Blob
Index - Blob
Proof Output - Blob
Proof Output Hash - Blob
Transaction - Blobs
Hashes - Block
Height - Block
Staking Data - Calldata
- This struct is passed from the application backend to the contract as an input. It contains the data that the contract will use to run the blob’s action on its state.
- Consensus
Info - Consensus
Proposal - Consensus
Proposal Hash - Contract
- Contract
Name - CutDisplay
- Data
Proposal - Data
Proposal Hash - Delete
Contract Action - Used as a blob action to delete a contract.
- Drop
EndOf Reader - Struct used to be able to deserialize a StructuredBlobData
without knowing the concrete type of
Actionwarning: this will drop the end of the reader, thus, you can’t deserialize a structure that contains aStructuredBlobData<DropEndOfReader>Unless this struct is at the end of your data structure. It’s not meant to be used outside the sdk internal logic. - Handled
Blob Proof Output - Hyli
Output - This struct has to be the zkvm committed output. It will be used by hyli node to verify & settle the blob transaction.
- Hyli
Output Hash - Identity
- An identity is a string that identifies the person that sent the BlobTransaction
- Indexed
Blobs - Blob of the transactions the contract uses to validate its transition
- Lane
Bytes Size - LaneId
- Node
State Block - Onchain
Effect Hash - Program
Id - Proof
- Proof
Data - Proof
Data Hash - Proof
Metadata - Proof
Transaction - Register
Contract Action - Used as a blob action to register a contract.
- Register
Contract Effect - Used by the Hyli node to recognize contract registration. Simply output this struct in your HyliOutput registered_contracts. See uuid-tld for examples.
- Rewards
Claim - Signature
- Signed
- Signed
Block - State
Commitment - State commitment of the contract.
- Stateful
Events - Structured
Blob - Structured
Blob Data - This struct allows to define cross-contract calls (aka contract composition).
A contract
Acan “call” an other contractBby being it’s “caller”: - Transaction
- Transaction
Metadata - TxContext
- TxHash
- TxId
- Unsettled
Blob Transaction - Update
Contract Program IdAction - Update
Contract Timeout Window Action - Validator
Candidacy - Validator
Public Key - Validator
Signature - Verified
Proof Transaction - Verifier
Enums§
- Consensus
Staking Action - Represents the operations that can be performed by the consensus
- Data
Availability Event - Data
Availability Request - Data
Event - Data
Proposal Parent - Mempool
Block Event - Mempool
Status Event - Node
State Event - Onchain
Effect - Enum for various side-effects blobs can have on the chain. This is implemented as an enum for easier forward compatibility.
- Staking
Action - Enum representing the actions that can be performed by the Staking contract.
- Stateful
Event - Timeout
Window - Transaction
Data - Transaction
Kind - Auto-generated discriminant enum variants
- Transaction
State Event