Crate gclient::ext::sp_runtime

Substrate Runtime Primitives.

This crate, among other things, contains a large library of types and utilities that are used in the Substrate runtime, but are not particularly FRAME-oriented.

Block, Header and Extrinsics

Most notable, this crate contains some of the types and trait that enable important communication between the client and the runtime. This includes:

• A set of traits to declare what any block/header/extrinsic type should provide.
  • traits::Block, traits::Header, traits::Extrinsic
• A set of types that implement these traits, whilst still providing a high degree of configurability via generics.
  • generic::Block, generic::Header, generic::UncheckedExtrinsic and generic::CheckedExtrinsic

Runtime API Types

This crate also contains some types that are often used in conjuncture with Runtime APIs. Most notable:

• ApplyExtrinsicResult, and DispatchOutcome, which dictate how the client and runtime communicate about the success or failure of an extrinsic.
• transaction_validity, which dictates how the client and runtime communicate about the validity of an extrinsic while still in the transaction-queue.

Modules

• app_crypto
  Traits and macros for constructing application specific strongly typed crypto wrappers.
• biguint
  Infinite precision unsigned integer for substrate runtime.
• codec
  Parity SCALE Codec
• curve
  Provides some utilities to define a piecewise linear function.
• generic
  Generic implementations of crate::traits::Header, crate::traits::Block and crate::traits::Extrinsic.
• helpers_128bit
  Some helper functions to work with 128bit numbers. Note that the functionality provided here is only sensible to use with 128bit numbers because for smaller sizes, you can always rely on assumptions of a bigger type (u128) being available, or simply create a per-thing and use the multiplication implementation provided there.
• legacy
  Runtime types that existed in old API versions.
• offchain
  A collection of higher lever helpers for offchain calls.
• runtime_logger
  A logger that can be used to log from the runtime.
• scale_info
  Efficient and space-efficient serialization of Rust types.
• testing
  Testing utilities.
• traits
  Primitives for the runtime modules.
• transaction_validity
  Transaction validity interface.
• type_with_default
  Provides a type that wraps another type and provides a default value.

Macros

• assert_eq_error_rate
  Checks that $x is equal to $y with an error rate of $error.
• assert_eq_error_rate_float
  Same as assert_eq_error_rate, but intended to be used with floating point number, or generally those who do not have over/underflow potentials.
• bounded_btree_map
  Build a bounded btree-map from the given literals.
• bounded_vec
  Build a bounded vec from the given literals.
• count
  Calls a given macro a number of times with a set of fixed params and an incrementing numeral. e.g.
• create_runtime_str
  Create a const RuntimeString.
• format
  Creates a String using interpolation of runtime expressions.
• format_runtime_string
  Convenience macro to use the format! interface to get a RuntimeString::Owned
• impl_opaque_keys
  Implement OpaqueKeys for a described struct.
• morph_types
  Create a Morph and/or TryMorph impls with a simple closure-like expression.

Structs

• AccountId32
  An opaque 32-byte cryptographic identifier.
• AnySignature
  Signature verify that can work with any known signature types..
• BoundedBTreeMap
  A bounded map based on a B-Tree.
• BoundedBTreeSet
  A bounded set based on a B-Tree.
• BoundedSlice
  A bounded slice.
• BoundedVec
  A bounded vector.
• CryptoTypeId
  An identifier for a specific cryptographic algorithm used by a key pair
• Digest
  Generic header digest.
• DispatchErrorWithPostInfo
  Result of a Dispatchable which contains the DispatchResult and additional information about the Dispatchable that is only known post dispatch.
• FixedI64
  A fixed point number representation in the range. Fixed Point 64 bits signed, range = [-9223372036.854775808, 9223372036.854775807]
• FixedI128
  A fixed point number representation in the range. Fixed Point 128 bits signed, range = [-170141183460469231731.687303715884105728, 170141183460469231731.687303715884105727]
• FixedU64
  A fixed point number representation in the range. Fixed Point 64 bits unsigned, range = [0.000000000, 18446744073.709551615]
• FixedU128
  A fixed point number representation in the range. Fixed Point 128 bits unsigned, range = [0.000000000000000000, 340282366920938463463.374607431768211455]
• Justifications
  Collection of justifications for a given block, multiple justifications may be provided by different consensus engines for the same block.
• KeyTypeId
  An identifier for a type of cryptographic key.
• ModuleError
  Reason why a pallet call failed.
• OpaqueExtrinsic
  Simple blob to hold an extrinsic without committing to its format and ensure it is serialized correctly.
• OpaqueValue
  Simple blob that hold a value in an encoded form without committing to its type.
• PerU16
  A fixed point representation of a number in the range [0, 1].
• Perbill
  A fixed point representation of a number in the range [0, 1].
• Percent
  A fixed point representation of a number in the range [0, 1].
• Permill
  A fixed point representation of a number in the range [0, 1].
• Perquintill
  A fixed point representation of a number in the range [0, 1].
• Rational128
  A wrapper for any rational number with a 128 bit numerator and denominator.
• Storage
  Struct containing data needed for a storage.
• StorageChild
  Child trie storage data.
• Vec
  A contiguous growable array type, written as Vec<T>, short for ‘vector’.
• WeakBoundedVec
  A weakly bounded vector.

Enums

• ArithmeticError
  Arithmetic errors.
• DigestItem
  Digest item that is able to encode/decode ‘system’ digest items and provide opaque access to other items.
• DispatchError
  Reason why a dispatch call failed.
• Either
  The enum Either with variants Left and Right is a general purpose sum type with two cases.
• ExtrinsicInclusionMode
  Confines the kind of extrinsics that can be included in a block.
• MultiAddress
  A multi-format address wrapper for on-chain accounts.
• MultiSignature
  Signature verify that can work with any known signature types.
• MultiSigner
  Public key for any known crypto algorithm.
• Rounding
  The rounding method to use for unsigned quantities.
• RuntimeString
  A string that wraps a &'static str in the runtime and String/Vec<u8> on decode.
• StateVersion
  Different possible state version.
• TokenError
  Description of what went wrong when trying to complete an operation on a token.
• TransactionOutcome
  Describes on what should happen with a storage transaction.
• TransactionalError
  Errors related to transactional storage layers.

Constants

• MAX_MODULE_ERROR_ENCODED_SIZE
  The number of bytes of the module-specific error field defined in ModuleError. In FRAME, this is the maximum encoded size of a pallet error type.

Traits

• BoundToRuntimeAppPublic
  Something that is bound to a fixed RuntimeAppPublic.
• BuildModuleGenesisStorageDeprecated
  Something that can build the genesis storage of a module.
• BuildStorage
  Complex storage builder stuff.
• CryptoType
  Type which has a particular kind of crypto associated with it.
• Deserialize
  A data structure that can be deserialized from any data format supported by Serde.
• DeserializeOwned
  A data structure that can be deserialized without borrowing any data from the deserializer.
• FixedPointNumber
  Something that implements a decimal fixed point number.
• FixedPointOperand
  Integer types that can be used to interact with FixedPointNumber implementations.
• PerThing
  Something that implements a fixed point ration with an arbitrary granularity X, as parts per X.
• RuntimeAppPublic
  Runtime interface for an application’s public key.
• SaturatedConversion
  Convenience type to work around the highly unergonomic syntax needed to invoke the functions of overloaded generic traits, in this case SaturatedFrom and SaturatedInto.
• Saturating
  Saturating arithmetic operations, returning maximum or minimum values instead of overflowing.
• Serialize
  A data structure that can be serialized into any data format supported by Serde.
• TypeId
  Provide a simple 4 byte identifier for a type.

Functions

• print
  Print something that implements Printable from the runtime.
• str_array
  Utility function to declare string literals backed by an array of length N.
• verify_encoded_lazy
  Verify a signature on an encoded value in a lazy manner. This can be an optimization if the signature scheme has an “unsigned” escape hash.

Type Aliases

• ApplyExtrinsicResult
  The result of applying of an extrinsic.
• ApplyExtrinsicResultWithInfo
  Same as ApplyExtrinsicResult but augmented with PostDispatchInfo on success.
• ConsensusEngineId
  Consensus engine unique ID.
• DispatchOutcome
  This type specifies the outcome of dispatching a call to a module.
• DispatchResult
  This is the legacy return type of Dispatchable. It is still exposed for compatibility reasons. The new return type is DispatchResultWithInfo. FRAME runtimes should use frame_support::dispatch::DispatchResult.
• DispatchResultWithInfo
  Return type of a Dispatchable which contains the DispatchResult and additional information about the Dispatchable that is only known post dispatch.
• EncodedJustification
  The encoded justification specific to a consensus engine.
• InnerOf
  Get the inner type of a PerThing.
• Justification
  An abstraction over justification for a block’s validity under a consensus algorithm.
• TryRuntimeError
  The error type used as return type in try runtime hooks.
• UpperOf
  Get the upper type of a PerThing.

Derive Macros

• Deserialize
• RuntimeDebug
• Serialize