Crate aleph_client

API for aleph-node chain.

This crate provides a Rust application interface for submitting transactions to aleph-node chain. Most of the pallets are common to any Substrate chain, but there are some unique to aleph-node, e.g. pallets::elections::ElectionsApi.

Re-exports

• pub use contract_transcode;
• pub use subxt::ext::codec;
• pub use subxt::ext::sp_core;
• pub use subxt::ext::sp_runtime;

Modules

• contract
  Contains types and functions simplifying common contract-related operations.
• pallets
  API for pallets.
• utility
  Block / session / era API.
• waiting
  Waiting for some events API.

Structs

• Connection
  Capable of communicating with a live Aleph chain.
• KeyPair
  Used for signing extrinsic payload
• RootConnection
  Specific connection that is signed by the sudo key.
• SignedConnection
  Any connection that is signed by some key.
• TxInfo
  Data regarding submitted transaction.

Enums

• TxStatus
  When submitting a transaction, wait for given status before proceeding.

Constants

• MILLISECS_PER_BLOCK
  We target 1 block per 1 second.

Traits

• AsConnection
  Castability to a plain connection.
• AsSigned
  Castability to a signed connection.
• ConnectionApi
  Any connection should be able to request storage and submit RPC calls
• Pair
  Trait suitable for typical cryptographic PKI key pair type.
• SignedConnectionApi
  Signed connection should be able to sends transactions to chain
• SudoCall
  API for sudo pallet.

Functions

• account_from_keypair
  Converts a key pair object to AccountId.
• aleph_keypair_from_string
  Converts given seed phrase to a ed25519 AlephKeyPair object.
• keypair_from_string
  Converts given seed phrase to a sr25519 KeyPair object.
• raw_keypair_from_string
  Converts given seed phrase to a sr25519 RawKeyPair object.

Type Definitions

• AccountId
  An alias for an account id type.
• AlephKeyPair
  An alias for a pallet aleph keys.
• Balance
  An alias for token amount.
• BlockHash
  An alias for a block hash type.
• BlockNumber
  An alias for block index.
• CodeHash
  An alias for a hash type.
• EraIndex
  An alias for counter for the number of eras that have passed.
• RawKeyPair
  An alias for a type of a key pair that signs chain transactions.
• SessionCount
  An alias for index type with which we can count sessions.
• SessionIndex
  An alias for index type with which we can index sessions.
• SubxtClient
  An alias for an RPC client type.
• TxHash
  An alias for a transaction hash type.
• Version
  An alias for finality version.