Crate ink

Re-exports

• pub use self::chain_extension::IsResultType;
• pub use ink_env as env;
• pub use ink_metadata as metadata;
• pub use ink_prelude as prelude;
• pub use ink_primitives as primitives;
• pub use scale;
• pub use scale_info;

Modules

• codegen
  Definitions and facilities mainly used by the ink! codegen.
• reflect
  Definitions and utilities for ink! smart contract static reflection.
• storage

Macros

• blake2x256
  Computes and expands into the BLAKE2b 256-bit hash of the string input.
• combine_extensions
  Macro defines the combined chain extension via structure definition. Each sub-extension can be accessed by the corresponding field.
• contract_ref
  Generates a wrapper which can be used for interacting with the contract.
• selector_bytes
  Computes the ink! selector of the string and expands into its byte representation.
• selector_id
  Computes the ink! selector of the string and expands into its u32 representation.

Structs

• EnvAccess
  The API behind the self.env() and Self::env() syntax in ink!.
• ValueReturned
  Represents some abstract value that is returned by a function. Currently acts as a placeholder.

Enums

• LangError
  An error emitted by the smart contracting language.

Constants

• IIP2_WILDCARD_COMPLEMENT_SELECTOR
  A well know selector reserved for the message required to be defined alongside a wildcard selector. See IIP-2.

Traits

• ChainExtensionInstance
  Trait implemented by chain extensions.
• Output
  Only implemented for ValueReturned.
• ToAccountId
  Implemented by contracts that are compiled as dependencies.

Type Definitions

• ConstructorResult
  The Result type for ink! constructors.
• MessageResult
  The Result type for ink! messages.

Attribute Macros

• chain_extension
  Defines the interface for a chain extension.
• contract
  Entry point for writing ink! smart contracts.
• event
  Implements the necessary traits for a struct to be emitted as an event from a contract.
• scale_derive
  Derive the re-exported traits ink::scale::Encode, ink::scale::Decode and ink::scale_info::TypeInfo. It enables using the built in derive macros for these traits without depending directly on the parity-scale-codec and scale-info crates.
• storage_item
  Prepares the type to be fully compatible and usable with the storage. It implements all necessary traits and calculates the storage key for types. Packed types don’t have a storage key, but non-packed types (like Mapping, Lazy etc.) require calculating the storage key during compilation.
• test
  Defines a unit test that makes use of ink!’s off-chain testing capabilities.
• trait_definition
  Marks trait definitions to ink! as special ink! trait definitions.

Derive Macros

• Event
  Derives an implementation of the [ink::Event] trait for the given struct.
• EventMetadata
  Derives the [ink::EventMetadata] trait for the given struct, which provides metadata about the event definition.