Preparing search index...
The search index is not available
Dedot API References - v
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Dedot API References
@dedot/shape
Context
Class Context
Index
Constructors
constructor
Methods
get
Constructors
constructor
new
Context
(
)
:
Context
Returns
Context
Methods
get
get
<
T
>
(
T
)
:
T
Type Parameters
T
Parameters
T
:
(
new
(
)
=>
T
)
new
(
)
:
T
Returns
T
Returns
T
On This Page
Constructors
constructor
Methods
get
Dedot API
References
@dedot/api
Retry
Strategy
Chain
Head
Chain
Head
Block
Not
Pinned
Error
Chain
Head
Block
Pruned
Error
Chain
Head
Error
Chain
Head
Invalid
Runtime
Error
Invalid Runtime Error
Chain
Head
Limit
Reached
Error
Limit Reached Error
Chain
Head
Operation
Error
Operation Error
Chain
Head
Operation
Inaccessible
Error
Operation Inaccessible Error
Chain
Head
Stop
Error
Stop Error
Chain
Spec
Constant
Executor
Dedot
Client
Error
Executor
Event
Executor
Executor
Extra
Signed
Extension
Invalid
Tx
Error
This throws out if the extrinsic is invalid
Json
Rpc
Client
A generic interface for JSON-RPC clients
Json
Rpc
Group
Legacy
Client
Queryable
Storage
Runtime
Api
Executor
Runtime
Api
Executor
V2
Signed
Extension
Storage
Query
Executor
Storage
Query
Executor
V2
Submittable
Extrinsic
Submittable
Extrinsic
V2
Submittable
Result
Transaction
A generic interface for broadcasting transactions
Transaction
Watch
A generic interface for broadcasting transactions
Tx
Executor
Tx
Executor
V2
Api
Options
IJson
Rpc
Client
A generic interface for JSON-RPC clients
ISigned
Extension
ISubstrate
Client
A generic interface for Substrate clients
ISubstrate
Client
At
A generic interface for Substrate clients at a specific block
Json
Rpc
Client
Options
Json
Rpc
Group
Options
State
Call
Params
Submittable
Result
Inputs
Substrate
Runtime
Version
Tx
Broadcaster
A generic interface for broadcasting transactions
Any
Signed
Extension
Api
Event
Chain
Head
Event
Json
Rpc
Group
Version
Metadata
Key
Notification
Method
Operation
Handler
Pinned
Block
Subscribe
Method
Subscriptions
Info
Unsubscribe
Method
Fallback
Runtime
Apis
Fallback
Runtime
Api
Specs
known
Signed
Extensions
MIN_
FINALIZED_
QUEUE_
SIZE
scaled
Responses
subscriptions
Info
is
Event
Record
Checks if the provided object is a valid `IEventRecord`.
is
Json
Rpc
Provider
is
Pallet
Event
Checks if the provided object is a valid `PalletEvent`.
@dedot/cli
dedot
@dedot/codecs
Account
Id20
Account
Id32
Consensus
Engine
Id
Ethereum
Address
Extrinsic
Extrinsic
V4
Metadata
Portable
Registry
Codec registry for portable types from metadata
Type
Registry
Extrinsic
Signature
Extrinsic
Signature
V4
Pallet
Error
Metadata
Latest
Pallet
Error
Metadata
V14
Pallet
Error
Metadata
V15
Pallet
Event
Metadata
Latest
Pallet
Event
Metadata
V14
Pallet
Event
Metadata
V15
Pallet
Info
Pallet
Item
Metadata
Pallet
Storage
Entry
Metadata
Latest
Pallet
Tx
Metadata
Latest
Pallet
Tx
Metadata
V14
Pallet
Tx
Metadata
V15
Account
Id20
Like
Account
Id32
Like
Allowed
Slots
Apply
Extrinsic
Result
Approval
Voting
Params
Arithmetic
Error
Async
Backing
Params
Authority
List
Babe
Authority
Weight
Babe
Configuration
Babe
Configuration
V1
Babe
Epoch
Babe
Epoch
Configuration
Babe
Equivocation
Proof
Backing
State
Balance
Beefy
Authority
Set
Beefy
Equivocation
Proof
Beefy
Next
Authority
Set
Beefy
Payload
Id
Bit
Sequence
Block
Block
Hash
Block
Number
bool
Bytes
Bytes
Like
Candidate
Commitments
Candidate
Descriptor
Candidate
Event
Candidate
Hash
Candidate
Pending
Availability
Candidate
Receipt
Check
Inherents
Result
Collator
Id
Collator
Signature
Commitment
Committed
Candidate
Receipt
Compact
Signed
Commitment
Consensus
Engine
Id
Like
Constant
Def
V14
Constant
Def
V15
Constraints
Core
Index
Core
State
Data
Data
Raw
Digest
Digest
Item
Dispatch
Class
Dispatch
Error
Dispatch
Info
Dispatch
Outcome
Dispute
Proof
Dispute
State
Dispute
Statement
Dispute
Statement
Set
Disputes
Time
Slot
Downward
Message
Enum
Type
Def
Era
Era
Like
Ethereum
Address
Like
Executor
Param
Executor
Params
Extrinsic
Def
V14
Extrinsic
Def
V15
Extrinsic
Version
Fee
Details
Field
Fixed
Array
Fixed
Bytes
Fixed
I128
Fixed
I64
Fixed
U128
Fixed
U64
Generated
Mmr
Proof
Result
Grandpa
Equivocation
Proof
Group
Index
Group
Rotation
Info
H128
H160
H256
H384
H512
H768
Hash
Head
Data
Header
Horizontal
Messages
i128
i16
i256
i32
i64
i8
Inbound
Downward
Message
Inbound
Hrmp
Limitations
Inbound
Hrmp
Message
Inclusion
Fee
Inherent
Data
Invalid
Dispute
Statement
Kind
Justification
Justifications
Key
Type
Id
Leaf
Index
Metadata
Latest
Metadata
V14
Metadata
V15
Metadata
Versioned
Mmr
Batch
Proof
Mmr
Encodable
Opaque
Leaf
Mmr
Error
Module
Error
Mortal
Inputs
Multi
Address
Multi
Address
Like
Multi
Dispute
Statement
Set
Node
Features
Node
Index
Nonce
Np
Pool
Id
Null
Occupied
Core
Occupied
Core
Assumption
Opaque
Extrinsic
Opaque
Extrinsic
Like
Opaque
Key
Ownership
Proof
Opaque
Metadata
Option
Outbound
Hrmp
Channel
Limitations
Outbound
Hrmp
Message
Pallet
Def
Latest
Pallet
Def
V14
Pallet
Def
V15
Para
Id
Para
Validator
Index
Payload
Pays
Pending
Slashes
Perbill
Percent
Permill
Perquintill
Persisted
Validation
Data
Per
U16
Phase
Portable
Type
Prefixed
Storage
Key
Prefixed
Storage
Key
Like
Primitive
Kind
Pvf
Check
Statement
Pvf
Exec
Kind
Pvf
Prep
Kind
Randomness
Raw
Bytes
Raw
Bytes
Like
Result
Runtime
Api
Def
V15
Runtime
Api
Method
Def
Latest
Runtime
Api
Method
Def
V15
Runtime
Api
Method
Param
Def
V15
Runtime
Dispatch
Info
Runtime
Version
Scheduled
Core
Scraped
On
Chain
Votes
Session
Index
Session
Info
Set
Id
Signed
Block
Signed
Extension
Def
Latest
Signed
Extension
Def
V14
Signed
Extension
Def
V15
Slashing
Offence
Kind
Slot
Storage
Data
Storage
Data
Like
Storage
Entry
Latest
Storage
Entry
V14
Storage
Entry
V15
Storage
Key
Storage
Key
Like
str
Text
Token
Error
Transactional
Error
Transaction
Longevity
Transaction
Priority
Transaction
Source
Transaction
Status
Transaction
Tag
Transaction
Validity
Type
Def
Type
Id
Type
Param
Type
Params
u128
U128
u16
u256
U256
u32
u64
u8
Unchecked
Extrinsic
Unchecked
Extrinsic
Like
Upgrade
Restriction
Upward
Message
Upward
Messages
Validation
Code
Validation
Code
Hash
Validator
Id
Validator
Set
Validator
Set
Id
Validator
Signature
Valid
Dispute
Statement
Kind
Validity
Attestation
Valid
Transaction
Versioned
Finality
Proof
Vote
Message
Weight
$
Account
Id20
$
Account
Id32
$
Allowed
Slots
$
Api
Id
$
Apis
Vec
A vector of pairs of `ApiId` and a `u32` for version.
$
Apply
Extrinsic
Result
Ref: https://github.com/paritytech/polkadot-sdk/blob/bdf186870dc4a7d74d59cad338baf8478d0715b4/substrate/primitives/runtime/src/lib.rs#L800-L819
$
Approval
Voting
Params
Approval voting configuration parameters
$
Arithmetic
Error
$
Async
Backing
Params
Candidate's acceptance limitations for asynchronous backing per relay parent.
$
Authority
List
A list of Grandpa authorities with associated weights.
$
Authority
Weight
The weight of an authority.
$
Babe
Authority
Weight
$
Babe
Configuration
$
Babe
Configuration
V1
$
Babe
Epoch
$
Babe
Epoch
Configuration
$
Babe
Equivocation
Proof
$
Backing
State
$
Balance
$
Beefy
Authority
Set
Details of a BEEFY authority set.
$
Beefy
Equivocation
Proof
Proof of voter misbehavior on a given set id. Misbehavior/equivocation in
$
Beefy
Next
Authority
Set
Details of the next BEEFY authority set.
$
Beefy
Payload
Id
$
Block
$
Block
Hash
$
Block
Number
$
Bytes
$
Candidate
Commitments
$
Candidate
Descriptor
Candidate's acceptance limitations for asynchronous backing per relay parent.
$
Candidate
Event
An even concerning a candidate.
$
Candidate
Hash
Unit type wrapper around [ `type@Hash` ] that represents a candidate hash.
$
Candidate
Pending
Availability
A candidate pending availability.
$
Candidate
Receipt
A candidate-receipt.
$
Check
Inherents
Result
The result of checking inherents.
$
Collator
Id
Identity that collators use.
$
Collator
Signature
Signature on candidate's block data by a collator.
$
Commitment
$
Committed
Candidate
Receipt
A candidate-receipt with commitments directly included.
$
Compact
Signed
Commitment
$
Consensus
Engine
Id
$
Constant
Def
V14
$
Constant
Def
V15
$
Constraints
Constraints on the actions that can be taken by a new parachain
$
Core
Index
The unique (during session) index of a core.
$
Core
State
The state of a particular availability core.
$
Data
$
Data
Raw
$
Digest
$
Digest
Item
Digest item that is able to encode/decode 'system' digest items and
$
Dispatch
Class
A generalized group of dispatch types.
$
Dispatch
Error
$
Dispatch
Info
$
Dispatch
Outcome
$
Dispute
Proof
We store most of the information about a lost dispute on chain. This struct
$
Dispute
State
The entire state of a dispute.
$
Dispute
Statement
A statement about a candidate, to be used within the dispute resolution process.
$
Dispute
Statement
Set
A set of statements about a specific candidate.
$
Disputes
Time
Slot
Timeslots should uniquely identify offences and are used for the offence
$
Downward
Message
A message sent from the relay-chain down to a parachain.
$
Enum
Type
Def
$
Equivocation
Wrapper object for GRANDPA equivocation proofs, useful for unifying prevote
$
Era
$
Ethereum
Address
$
Executor
Param
The different executor parameters for changing the execution environment semantics.
$
Executor
Params
Deterministically serialized execution environment semantics
$
Extrinsic
Def
V14
$
Extrinsic
Def
V15
$
Extrinsic
Version
$
Fee
Details
The `FeeDetails` is composed of:
$
Field
$
Fixed
I128
$
Fixed
I64
$
Fixed
U128
$
Fixed
U64
$
Generated
Mmr
Proof
Result
$
Grandpa
Equivocation
An equivocation (double-vote) in a given round.
$
Grandpa
Equivocation
Proof
Proof of voter misbehavior on a given set id. Misbehavior/equivocation in
$
Group
Index
The unique (during session) index of a validator group.
$
Group
Rotation
Info
A helper data-type for tracking validator-group rotations.
$
H128
$
H160
$
H256
$
H384
$
H512
$
H768
$
Hash
$
Hasher
$
Head
Data
Parachain head data included in the chain.
$
Header
$
Header
Block
Number
$
Horizontal
Messages
$
Inbound
Downward
Message
A wrapped version of `DownwardMessage`. The difference is that it has attached the block number
$
Inbound
Hrmp
Limitations
Constraints on inbound HRMP channels.
$
Inbound
Hrmp
Message
$
Inclusion
Fee
The base fee and adjusted weight and length fees constitute the _inclusion fee_.
$
Inherent
Data
$
Inherent
Identifier
An identifier for an inherent.
$
Invalid
Dispute
Statement
Kind
Different kinds of statements of invalidity on a candidate.
$
Invalid
Transaction
$
Justification
$
Justifications
$
Key
Type
Id
An identifier for a type of cryptographic key.
$
Leaf
Index
A type to describe leaf position in the MMR.
$
Metadata
$
Metadata
Latest
$
Metadata
V14
Ref: https://github.com/paritytech/frame-metadata/blob/a07b2451b82809501fd797691046c1164f7e8840/frame-metadata/src/v14.rs#L45-L54
$
Metadata
V15
Ref: https://github.com/paritytech/frame-metadata/blob/a07b2451b82809501fd797691046c1164f7e8840/frame-metadata/src/v15.rs#L48-L63
$
Metadata
Versioned
$
Mmr
Batch
Proof
An MMR proof data for a group of leaves.
$
Mmr
Encodable
Opaque
Leaf
A type-safe wrapper for the concrete leaf type.
$
Mmr
Error
Merkle Mountain Range operation error.
$
Module
Error
$
Multi
Address
$
Multi
Address
Base
A multi-format address wrapper for on-chain accounts.
$
Multi
Dispute
Statement
Set
A set of dispute statements.
$
Node
Features
Bit indices in the `HostConfiguration.node_features` that correspond to different node features.
$
Node
Index
A type to describe node position in the MMR (node index).
$
Nonce
Nonce of a transaction on the Polkadot-like chains.
$
Not
Supported
$
Np
Pool
Id
Type used for unique identifier of each pool.
$
Occupied
Core
Information about a core which is currently occupied.
$
Occupied
Core
Assumption
An assumption being made about the state of an occupied core.
$
Opaque
Extrinsic
$
Opaque
Key
Ownership
Proof
$
Opaque
Metadata
$
Outbound
Hrmp
Channel
Limitations
Constraints on outbound HRMP channels.
$
Outbound
Hrmp
Message
An HRMP message seen from the perspective of a sender.
$
Pallet
Def
Latest
$
Pallet
Def
V14
$
Pallet
Def
V15
$
Para
Id
Unique identifier of a parachain.
$
Para
Validator
Index
Index of the validator is used as a lightweight replacement of the `ValidatorId` when
$
Payload
$
Pays
$
Pending
Slashes
Slashes that are waiting to be applied once we have validator key
$
Perbill
$
Percent
$
Permill
$
Perquintill
$
Persisted
Validation
Data
The validation data provides information about how to create the inputs for validation of a
$
Per
U16
$
Phase
$
Portable
Type
$
Precommit
A precommit for a block and its ancestors.
$
Prefixed
Storage
Key
$
Prevote
A prevote for a block and its ancestors.
$
Primitive
Kind
$
Pvf
Check
Statement
A statement from the specified validator whether the given validation code passes PVF
$
Pvf
Exec
Kind
Type discriminator for PVF execution.
$
Pvf
Prep
Kind
Type discriminator for PVF preparation
$
Randomness
$
Raw
Bytes
$
Runtime
Api
Def
V15
$
Runtime
Api
Method
Def
Latest
$
Runtime
Api
Method
Def
V15
$
Runtime
Api
Method
Param
Def
V15
$
Runtime
Dispatch
Info
Information related to a dispatchable's class, weight, and fee that can be queried from the
$
Runtime
Version
Runtime version.
$
Scheduled
Core
Information about a core which is currently occupied.
$
Scraped
On
Chain
Votes
$
Session
Index
Simple index type with which we can count sessions.
$
Session
Info
Information about validator sets of a session.
$
Set
Id
The monotonic identifier of a GRANDPA set of authorities.
$
Signed
Block
$
Signed
Extension
Def
Latest
$
Signed
Extension
Def
V14
$
Signed
Extension
Def
V15
$
Slashing
Offence
Kind
The kind of the dispute offence.
$
Slot
$
Storage
Data
$
Storage
Entry
Latest
$
Storage
Entry
V14
$
Storage
Entry
V15
$
Storage
Key
$
Text
$
Token
Error
DispatchError
$
Transactional
Error
$
Transaction
Longevity
Minimum number of blocks a transaction will remain valid for.
$
Transaction
Priority
Priority for a transaction. Additive. Higher is better.
$
Transaction
Source
The source of the transaction.
$
Transaction
Status
Possible transaction status events.
$
Transaction
Tag
Tag for a transaction. No two transactions with the same tag should be placed on-chain.
$
Transaction
Validity
Information on a transaction's validity and, if valid, on how it relates to other transactions.
$
Transaction
Validity
Error
$
Type
Def
$
Type
Id
$
Type
Param
$
U128
$
U256
$
Unchecked
Extrinsic
$
Unknown
Transaction
$
Upgrade
Restriction
A possible upgrade restriction that prevents a parachain from performing an upgrade.
$
Upward
Message
A message from a parachain to its Relay Chain.
$
Upward
Messages
$
Validation
Code
Parachain validation code.
$
Validation
Code
Hash
Unit type wrapper around [ `type@Hash` ] that represents the blake2-256 hash
$
Validator
Id
Identity that parachain validators use when signing validation messages.
$
Validator
Set
A set of BEEFY authorities, a.k.a. validators.
$
Validator
Set
Id
A typedef for validator set id.
$
Validator
Signature
Signature with which parachain validators sign blocks.
$
Valid
Dispute
Statement
Kind
Different kinds of statements of validity on a candidate.
$
Validity
Attestation
An either implicit or explicit attestation to the validity of a parachain
$
Valid
Transaction
Information concerning a valid transaction.
$
Versioned
Finality
Proof
$
Vote
Message
BEEFY vote message.
$
Weight
EXTRINSIC_
FORMAT_
VERSION
MAGIC_
NUMBER
$
Extrinsic
account
Id20
To
Hex
account
Id32
To
Hex
next
Power
Of
Two
Returns the smallest power of two greater than or equal to n.
not
Supported
Codec
num
Of
Trailing
Zeroes
Returns the number of trailing zeros in the binary representation of `n`.
@dedot/codegen
Generated
Result
generate
Contract
Types
generate
Types
generate
Types
From
Endpoint
@dedot/contracts
Constructor
Tx
Executor
Contract
Contract
Deployer
Contract
Dispatch
Error
Represents an error that occurred during the execution of a smart contract call due to a dispatch error.
Contract
Execution
Error
Represents an error that occurred during the execution of a smart contract call.
Contract
Executor
Contract
Instantiate
Dispatch
Error
Represents an error that occurred during the dispatch phase of contract instantiation.
Contract
Instantiate
Error
Represents an error that occurred during the instantiation of a smart contract.
Contract
Instantiate
Lang
Error
Represents an error that occurred during the instantiation of a smart contract due to a language-specific error.
Contract
Lang
Error
Represents an error that occurred during the execution of a smart contract call due to a language-specific error.
Deployer
Executor
Event
Executor
Executor
Query
Executor
Tx
Executor
Typink
Registry
Array
Type
Build
Info
Composite
Type
Contract
Call
Message
Contract
Constructor
Message
Contract
Event
Arg
Contract
Information
Contract
Message
Contract
Message
Arg
Contract
Source
Contract
Storage
Contract
Type
Contract
Type
Def
Contract
Type
Info
Execution
Options
Generic
Constructor
Call
Result
Generic
Constructor
Query
Generic
Constructor
Tx
Generic
Contract
Api
Generic
Contract
Call
Result
Generic
Contract
Event
Generic
Contract
Events
Generic
Contract
Query
Generic
Contract
Tx
Param
Info
Sequence
Type
Variant
Type
Wasm
Opt
Settings
Call
Options
Constructor
Call
Options
Constructor
Tx
Options
Contract
Call
Options
Contract
Call
Result
Contract
Event
Contract
Event
Meta
Contract
Instantiate
Result
Contract
Metadata
Contract
Submittable
Extrinsic
Contract
Tx
Options
Generic
Constructor
Query
Call
Generic
Constructor
Tx
Call
Generic
Contract
Query
Call
Generic
Contract
Tx
Call
Generic
Ink
Lang
Error
Generic
Instantiate
Submittable
Extrinsic
Instantiate
Submittable
Extrinsic
Instantiate
With
Code
Submittable
Extrinsic
Return
Flags
Flags used by a contract to customize exit behaviour.
ensure
Support
Contracts
Pallet
extract
Contract
Types
is
Contract
Dispatch
Error
Checks if the provided error is an instance of `ContractDispatchError`.
is
Contract
Execution
Error
Checks if the provided error is an instance of `ContractExecutionError`.
is
Contract
Instantiate
Dispatch
Error
Checks if the provided error is an instance of `ContractInstantiateDispatchError`.
is
Contract
Instantiate
Error
Checks if the provided error is an instance of `ContractInstantiateError`.
is
Contract
Instantiate
Lang
Error
Checks if the provided error is an instance of `ContractInstantiateLangError`.
is
Contract
Lang
Error
Checks if the provided error is an instance of `ContractLangError`.
new
Proxy
Chain
normalize
Contract
Type
Def
normalize
Label
parse
Raw
Metadata
to
Return
Flags
dedot
$
Assert
State
Bit
Sequence
Context
Decode
Buffer
Encode
Buffer
Shape
Shape
Assert
Error
Shape
Decode
Error
Shape
Encode
Error
Shape
Error
Shape
Map
Shape
Set
Shape
Visitor
Variant
Decoder
Encoder
Enum
Options
Predicate
Any
Shape
Any
Variant
Enum
Members
Expand
Indexed
Enum
Member
Input
Input
Enum
Shape
Input
Object
Input
Struct
Shape
Input
Tagged
Union
Input
Tuple
In
Shape
Metadata
Narrow
Object
Members
Output
Output
Enum
Shape
Output
Object
Output
Struct
Shape
Output
Tagged
Union
Output
Tuple
Out
Shape
Result
Struct
Members
U2I
bit
Sequence
bool
compact
U128
compact
U16
compact
U256
compact
U32
compact
U64
compact
U8
compact
Visitor
f64
i128
i16
i256
i32
i64
i8
never
Null
option
Bool
Prefixed
Hex
Raw
Hex
str
u128
u16
u256
u32
u64
u8
U8a
uint8
Array
array
Array
assert
Asserts that the value is valid for the specified shape
compact
constant
create
Shape
decode
Hex
deferred
documented
encode
Hex
encode
Hex
Prefixed
Enum
field
Fixed
Hex
Fixed
Str
Flat
Enum
hex
instance
int
is
iterable
len
Prefixed
literal
Union
map
metadata
Metadata for an atomic shape
object
option
Option
optional
Field
promise
record
result
Result
set
sized
Array
Sized
U8a
sized
Uint8
Array
Sized
Vec
Struct
tagged
Union
transform
tuple
Tuple
variant
Vec
with
Metadata
Retry
Strategy
Chain
Head
Chain
Head
Block
Not
Pinned
Error
Chain
Head
Block
Pruned
Error
Chain
Head
Error
Chain
Head
Invalid
Runtime
Error
Invalid Runtime Error
Chain
Head
Limit
Reached
Error
Limit Reached Error
Chain
Head
Operation
Error
Operation Error
Chain
Head
Operation
Inaccessible
Error
Operation Inaccessible Error
Chain
Head
Stop
Error
Stop Error
Chain
Spec
Constant
Executor
Dedot
Client
Error
Executor
Event
Executor
Executor
Extra
Signed
Extension
Invalid
Tx
Error
This throws out if the extrinsic is invalid
Json
Rpc
Client
A generic interface for JSON-RPC clients
Json
Rpc
Error
Json
Rpc
Group
Legacy
Client
Queryable
Storage
Runtime
Api
Executor
Runtime
Api
Executor
V2
Signed
Extension
Smoldot
Provider
Storage
Query
Executor
Storage
Query
Executor
V2
Submittable
Extrinsic
Submittable
Extrinsic
V2
Submittable
Result
Transaction
A generic interface for broadcasting transactions
Transaction
Watch
A generic interface for broadcasting transactions
Tx
Executor
Tx
Executor
V2
Ws
Provider
Api
Options
IJson
Rpc
Client
A generic interface for JSON-RPC clients
ISigned
Extension
ISubstrate
Client
A generic interface for Substrate clients
ISubstrate
Client
At
A generic interface for Substrate clients at a specific block
Json
Rpc
Client
Options
Json
Rpc
Error
Object
Json
Rpc
Group
Options
Json
Rpc
Provider
Json
Rpc
Request
Json
Rpc
Response
Error
Json
Rpc
Response
Notification
Json
Rpc
Response
Success
Json
Rpc
V2
State
Call
Params
Submittable
Result
Inputs
Substrate
Runtime
Version
Tx
Broadcaster
A generic interface for broadcasting transactions
Ws
Provider
Options
Any
Signed
Extension
Api
Event
Chain
Head
Event
Connection
Status
Json
Rpc
Group
Version
Json
Rpc
Request
Id
Json
Rpc
Response
Json
Rpc
Subscription
Json
Rpc
Subscription
Callback
Json
Rpc
Subscription
Input
Metadata
Key
Notification
Method
Operation
Handler
Pinned
Block
Provider
Event
Subscribe
Method
Subscriptions
Info
Unsubscribe
Method
Fallback
Runtime
Apis
Fallback
Runtime
Api
Specs
known
Signed
Extensions
MIN_
FINALIZED_
QUEUE_
SIZE
scaled
Responses
subscriptions
Info
UNKNOWN_
ERROR_
CODE
is
Event
Record
Checks if the provided object is a valid `IEventRecord`.
is
Json
Rpc
Provider
is
Pallet
Event
Checks if the provided object is a valid `PalletEvent`.
@dedot/providers
Json
Rpc
Error
Smoldot
Provider
Ws
Provider
Json
Rpc
Error
Object
Json
Rpc
Provider
Json
Rpc
Request
Json
Rpc
Response
Error
Json
Rpc
Response
Notification
Json
Rpc
Response
Success
Json
Rpc
V2
Ws
Provider
Options
Connection
Status
Json
Rpc
Request
Id
Json
Rpc
Response
Json
Rpc
Subscription
Json
Rpc
Subscription
Callback
Json
Rpc
Subscription
Input
Provider
Event
UNKNOWN_
ERROR_
CODE
@dedot/runtime-
specs
Account
Nonce
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/6a29a70a927de1017b5c54626c88c3fa439aef48/substrate/frame/system/rpc/runtime-api/src/lib.rs#L26-L35
Authority
Discovery
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/bc53b9a03a742f8b658806a01a7bf853cb9a86cd/substrate/primitives/authority-discovery/src/lib.rs#L40-L49
Babe
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/1f023deab8d021c5bab08731e13aa12590ed4026/substrate/primitives/consensus/babe/src/lib.rs#L377-L427
Beefy
Api
Reference:
Beefy
Mmr
Api
Block
Builder
Ref: https://github.com/paritytech/polkadot-sdk/blob/bc53b9a03a742f8b658806a01a7bf853cb9a86cd/substrate/primitives/block-builder/src/lib.rs#L25-L52
Core
Ref: https://github.com/paritytech/polkadot-sdk/blob/eaf1bc5633ebbacce97e4f167ebe1d0d268c4b24/substrate/primitives/api/src/lib.rs#L799-L809
Genesis
Builder
Ref: https://github.com/paritytech/polkadot-sdk/blob/9a5d9a586e5a1c27bf29d3727b5edc89c59f0398/substrate/primitives/genesis-builder/src/lib.rs#L35-L45
Grandpa
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/ebcf0a0f1cab2d43718ba96d26e5687f4d14580a/substrate/primitives/consensus/grandpa/src/lib.rs#L483-L535
Metadata
Ref: https://github.com/paritytech/polkadot-sdk/blob/eaf1bc5633ebbacce97e4f167ebe1d0d268c4b24/substrate/primitives/api/src/lib.rs#L811-L827
Mmr
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/0e49ed72aa365475e30069a5c30e251a009fdacf/substrate/primitives/merkle-mountain-range/src/lib.rs#L423-L426
Nomination
Pools
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/bc53b9a03a742f8b658806a01a7bf853cb9a86cd/substrate/frame/nomination-pools/runtime-api/src/lib.rs#L26-L41
Offchain
Worker
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/bc53b9a03a742f8b658806a01a7bf853cb9a86cd/substrate/primitives/offchain/src/lib.rs#L25-L37
Parachain
Host
Ref https://github.com/paritytech/polkadot-sdk/blob/a84dd0dba58d51503b8942360aa4fb30a5a96af5/polkadot/primitives/src/runtime_api.rs#L129-L134
Runtime
Apis
Session
Keys
Ref: https://github.com/paritytech/polkadot-sdk/blob/43415ef58c143b985e09015cd000dbd65f6d3997/substrate/primitives/session/src/runtime_api.rs#L21-L31
Staking
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/00b85c51dfbc0fecbb8a4dd3635d4c177a6527a6/substrate/frame/staking/runtime-api/src/lib.rs#L25-L33
Tagged
Transaction
Queue
Ref: https://github.com/paritytech/polkadot-sdk/blob/bc53b9a03a742f8b658806a01a7bf853cb9a86cd/substrate/primitives/transaction-pool/src/runtime_api.rs#L25-L30
Transaction
Payment
Api
Ref: https://github.com/paritytech/polkadot-sdk/blob/36957d676033b23b46edb66e6d7dcd13da11e19a/substrate/frame/transaction-payment/rpc/runtime-api/src/lib.rs#L26-L36
Transaction
Payment
Call
Api
get
Runtime
Api
Method
Specs
get
Runtime
Api
Names
get
Runtime
Api
Specs
to
Runtime
Api
Methods
to
Runtime
Api
Specs
@dedot/shape
Assert
State
Bit
Sequence
Context
Decode
Buffer
Encode
Buffer
Shape
Shape
Assert
Error
Shape
Decode
Error
Shape
Encode
Error
Shape
Error
Shape
Map
Shape
Set
Shape
Visitor
Variant
Decoder
Encoder
Enum
Options
Predicate
Any
Shape
Any
Variant
Enum
Members
Expand
Indexed
Enum
Member
Input
Input
Enum
Shape
Input
Object
Input
Struct
Shape
Input
Tagged
Union
Input
Tuple
In
Shape
Metadata
Narrow
Object
Members
Output
Output
Enum
Shape
Output
Object
Output
Struct
Shape
Output
Tagged
Union
Output
Tuple
Out
Shape
Result
Struct
Members
U2I
bit
Sequence
bool
compact
U128
compact
U16
compact
U256
compact
U32
compact
U64
compact
U8
compact
Visitor
f64
i128
i16
i256
i32
i64
i8
never
Null
option
Bool
Prefixed
Hex
Raw
Hex
str
u128
u16
u256
u32
u64
u8
U8a
uint8
Array
array
Array
assert
Asserts that the value is valid for the specified shape
compact
constant
create
Shape
decode
Hex
deferred
documented
encode
Hex
encode
Hex
Prefixed
Enum
field
Fixed
Hex
Fixed
Str
Flat
Enum
hex
instance
int
is
iterable
len
Prefixed
literal
Union
map
metadata
Metadata for an atomic shape
object
option
Option
optional
Field
promise
record
result
Result
set
sized
Array
Sized
U8a
sized
Uint8
Array
Sized
Vec
Struct
tagged
Union
transform
tuple
Tuple
variant
Vec
with
Metadata
@dedot/storage
Local
Storage
A wrapper for localStorage
IStorage
Generic storage interface
@dedot/types
Generic
Chain
Consts
Generic
Chain
Errors
Generic
Chain
Storage
Generic
Chain
Tx
Generic
Json
Rpc
Apis
Generic
Pallet
Error
Generic
Pallet
Event
Generic
Runtime
Api
Generic
Runtime
Apis
Generic
Substrate
Api
IEvent
Record
IRuntime
Event
IRuntime
Tx
Call
ISubmittable
Extrinsic
ISubmittable
Extrinsic
Legacy
ISubmittable
Result
Pagination
Options
Pallet
Event
Payload
Options
Runtime
Api
Method
Param
Spec
Runtime
Api
Method
Spec
Runtime
Api
Spec
Signer
Options
Storage
Multi
Query
Method
Storage
Query
Method
Versioned
Generic
Substrate
Api
Address
Or
Pair
Any
Func
Append
Async
Method
Callback
Dry
Run
Result
Generic
Chain
Events
Generic
Runtime
Api
Method
Generic
Storage
Query
Generic
Tx
Call
Rpc
Legacy
Rpc
V2
Rpc
Version
Runtime
Api
Method
Name
Runtime
Api
Methods
Spec
Runtime
Api
Name
Tx
Payment
Info
Tx
Status
Unsub
@dedot/utils
Async
Queue
Dedot
Error
Event
Emitter
Unknown
Api
Error
Throwing when a api is unknown upon evaluation
IEvent
Emitter
Deferred
Hash
Fn
Hex
String
SS58
Format
Prefix
Work
Item
ALLOWED_
DECODED_
LENGTHS
ALLOWED_
ENCODED_
LENGTHS
CC_
TO_
LO
CC_
TO_
UP
DEFAULT_
SUBSTRATE_
ADDRESS_
PREFIX
EVM_
ADDRESS_
REGEX
HASHERS
HEX_
REGEX
assert
assert
False
Throw out error if condition is undefined, false, null, '' or 0
blake2_
128
blake2_
128
Concat
blake2_
256
blake2
As
Hex
blake2
As
U8a
bn
Abs
Return the absolute value of a bigint
bn
Max
Return the bigger bigint value
bn
Min
Return the smaller bigint value
bn
To
Hex
Convert bigint to hex
bn
To
U8a
Convert bigint to Uint8Array
calc
Runtime
Api
Hash
Calculate runtime api hash
check
Address
Checksum
concat
U8a
Concat multiple Uint8Array instances into a single Uint8Array.
decode
Address
deferred
encode
Address
ensure
Presence
Ensure presence for value, else throw an error!
hex
Add
Prefix
Add '0x' prefix to a hex string if it doesn't have one
hex
Strip
Prefix
Remove '0x' prefix from a hex string if it has one
hex
To
String
Converts a hex string to a string.
hex
To
U8a
Converts a hex string to a Uint8Array.
identity
is
Big
Int
is
Boolean
is
Evm
Address
is
Evm
Checksum
is
Function
is
Hex
Checks if the given input is a hex string.
is
Null
is
Number
is
Object
is
String
is
U8a
is
Undefined
is
Wasm
@Ref: https://github.com/polkadot-js/common/blob/master/packages/util/src/is/wasm.ts
is
Zero
Hex
Check if a hex is zero
keccak
As
Hex
keccak
As
U8a
noop
Simply does nothing
normalize
Name
Normalize object field's name from metadata
number
To
Hex
Convert a number to a hex string
number
To
U8a
Convert a number to a Uint8Array
shorten
Address
sshash
string
Camel
Case
string
Dash
Case
string
Lower
First
string
Pascal
Case
string
Snake
Case
string
To
Hex
string
To
U8a
string
Upper
First
to
Hex
Converts the input to a hex string.
to
U8a
Converts the input to a Uint8Array.
trim
Off
Url
Protocol
trim
Trailing
Slash
twox128
twox256
twox64
Concat
u8a
Eq
Compare two Uint8Arrays for equality
u8a
To
Hex
Convert a Uint8Array to a hex string
u8a
To
String
Convert a Uint8Array to a string
wait
For
Wait for a certain amount of time in milliseconds
xxhash
As
Hex
xxhash
As
U8a