Expand description
A collection of objects defining the protocol for NyCypher nodes (Ursulas).
Re-exports§
pub use umbral_pre;pub use ferveo;
Structs§
- Access
Control Policy - Access control policy data for encrypted data.
- Address
- Represents an Ethereum address (20 bytes).
- Authenticated
Data - Authenticated data for encrypted data.
- Conditions
- Access control conditions.
- Context
- Context for reencryption conditions.
- Encrypted
KeyFrag - Encrypted and signed key frag.
- Encrypted
Threshold Decryption Request - An encrypted request for an Ursula to derive a decryption share.
- Encrypted
Threshold Decryption Response - An encrypted response from Ursula with a derived decryption share.
- Encrypted
Threshold Signature Request - An encrypted signature request for Ursula to process and sign.
- Encrypted
Threshold Signature Response - An encrypted response from Ursula with a signature.
- Encrypted
Treasure Map - A treasure map encrypted for Bob.
- Fleet
State Checksum - An identifier of the fleet state.
- HRAC
- “hashed resource access code”.
- Message
Kit - Encrypted message prepared for re-encryption.
- Metadata
Request - A request for metadata exchange.
- Metadata
Response - A response returned by an Ursula containing known node metadata.
- Metadata
Response Payload - Payload of the metadata response.
- Node
Metadata - Signed node metadata.
- Node
Metadata Payload - Node metadata.
- Packed
User Operation - Packed UserOperation for signature requests
- Packed
User Operation Signature Request - Packed UserOperation signature request
- Reencryption
Request - A request for an Ursula to reencrypt for several capsules.
- Reencryption
Response - A response from Ursula with reencrypted capsule frags.
- Retrieval
Kit - An object encapsulating the information necessary for retrieval of cfrags from Ursulas. Contains the capsule and the checksum addresses of Ursulas from which the requester already received cfrags.
- Revocation
Order - Represents a string used by characters to perform a revocation on a specific Ursula.
- Session
Secret Factory - This class handles keyring material for session keys, by allowing deterministic
derivation of
SessionStaticSecretobjects based on labels. - Session
Shared Secret - A Diffie-Hellman shared secret
- Session
Static Key - A session public key.
- Session
Static Secret - A session secret key.
- Signature
Response - Signature response
- Threshold
Decryption Request - A request for an Ursula to derive a decryption share.
- Threshold
Decryption Response - A response from Ursula with a derived decryption share.
- Threshold
Message Kit - Access control metadata for encrypted data.
- Treasure
Map - A structure containing
KeyFragobjects encrypted for Ursulas chosen for this policy. - Uint256
- A wrapper around
U256. - User
Operation - UserOperation for signature requests - https://eips.ethereum.org/EIPS/eip-4337
- User
Operation Signature Request - UserOperation signature request
- Verification
Error - Error returned by various
verify()methods in the crate.
Enums§
- AAVersion
- AA version enum for Account Abstraction versions
- Decryption
Error - Errors during decryption.
- Direct
Signature Request - Enum to hold any type of signature request for direct returns
- Encryption
Error - Errors during encryption.
- Signature
Request Type - Enum for different signature types.
Traits§
- Base
Signature Request - Base trait for signature requests
- Protocol
Object - This is a versioned protocol object.
Functions§
- deserialize_
signature_ request - Utility function to deserialize any signature request from bytes
- encrypt_
for_ dkg - Encrypt data based on conditions and dkg public key.