Crate sov_modules_api

Modules

• default_context
• default_signature
• hooks
• transaction

Structs

• Address
• AddressBech32
• CallResponse
  Response type for the Module::call method.
• Prefix
  A unique identifier for each state variable in a module.

Enums

• Error
  General error type in the Module System.
• NonInstantiable
  A type that can’t be instantiated.
• SigVerificationError

Traits

• AddressTrait
• Context
  A context contains information which is passed to modules during transaction execution. Currently, context includes the sender of the transaction as recovered from its signature.
• DispatchCall
  A trait that needs to be implemented for any call message.
• Genesis
  Methods from this trait should be called only once during the rollup deployment.
• Hasher
  A minimal trait representing a hash function. We implement our own rather than relying on Digest for broader compatibility.
• Module
  Every module has to implement this trait. All the methods have a default implementation that can’t be invoked (because they take NonInstantiable parameter). This allows developers to override only some of the methods in their implementation and safely ignore the others.
• ModuleInfo
  Every module has to implement this trait.
• PublicKey
  PublicKey used in the Module System.
• RpcRunner
  A StateTransitionRunner needs to implement this if the RPC service is needed
• Signature
  Signature used in the Module System.
• Spec
  The Spec trait configures certain key primitives to be used by a by a particular instance of a rollup. Spec is almost always implemented on a Context object; since all Modules are generic over a Context, rollup developers can easily optimize their code for different environments by simply swapping out the Context (and by extension, the Spec).