| AbstractArray<T extends Codec> |
AbstractArray
This manages codec arrays.
|
| AbstractInt |
|
| AccountFunctions |
|
| AccountFunctions.AccountIdAndIndex |
|
| AccountFunctions.AccountIndexes |
|
| AccountId |
A wrapper around an AccountId/PublicKey representation.
|
| AccountId.AccountIdOf |
The Substrate AccountIdOf representation as a AccountId.
|
| AccountIndex |
A wrapper around an AccountIndex, which is a shortened, variable-length encoding
for an Account.
|
| AccountInfo |
An Account information structure for contracts
|
| Address |
A wrapper around an AccountId and/or AccountIndex that is encoded with a prefix.
|
| AddressCodec |
|
| Amount |
The Substrate Amount representation as a Balance. |
| ApiBase<ApplyResult> |
|
| ApiBase.ApiType |
|
| ApiBase.StorageOnCallFunction |
|
| ApiPromise |
# @polkadot/api/promise
## Overview
ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network.
|
| ApiRx |
# @polkadot/api/rx
|
| ApiUtils |
|
| AssetOf |
The Substrate AssetOf representation as a Balance. |
| AttestedCandidate |
An attested candidate
|
| AttestedCandidate.AvailabilityVote |
|
| AttestedCandidate.BalanceUpload |
|
| AttestedCandidate.CandidateReceipt |
|
| AttestedCandidate.CandidateSignature |
|
| AttestedCandidate.EgressQueueRoot |
|
| AttestedCandidate.ExplicitCandidateSignature |
|
| AttestedCandidate.HeadData |
|
| AttestedCandidate.ValidityAttestation |
|
| AttestedCandidate.ValidityVote |
|
| AuthorityId |
|
| Balance |
The Substrate Balance representation as a U128. |
| Balance.BalanceOf |
|
| BalanceLock |
The Substrate BalanceLock for staking
|
| BalancesFunctions |
|
| Base<T> |
|
| Base58 |
Copy Bitcoin source code, remove Base58 unrelated code
|
| BftAuthoritySignature |
Represents a Bft Hash and Signature pairing, typically used in reporting
network behaviour.
|
| BftAuthoritySignature.BftAuthoritySignatureValue |
|
| BftAuthoritySignature.BftHashSignature |
Represents a Bft Hash and Signature pairing, typically used in reporting
network behaviour.
|
| BftAuthoritySignature.BftHashSignatureValue |
|
| Block |
A block encoded with header and extrinsics
|
| Block.BlockValue |
|
| BlockNumber |
A representation of a Substrate BlockNumber, implemented as a U64 |
| Bool |
|
| Bytes |
A Bytes wrapper for Vec.
|
| Calls |
|
| Calls |
|
| Calls.MetadataCall |
The definition of a call
|
| Calls.MetadataCallArg |
|
| Calls.OuterDispatchCall |
|
| Calls.OuterDispatchMetadata |
|
| ChainFunctions |
|
| ChainFunctions.HeaderAndValidators |
|
| ChainProperties |
Wraps the properties retrieved from the chain via the `system.properties` RPC call.
|
| Codec |
|
| CodecTypes |
|
| CodecUtils |
|
| CodeHash |
|
| Compact |
Compact
A compact length-encoding codec wrapper.
|
| Compactable |
|
| Constants |
|
| ContractAbi |
|
| CreateFunction |
|
| CreateFunction.CreateItemOptions |
|
| CreateType |
|
| CreateType.TypeDef |
|
| CreateType.TypeDefInfo |
|
| CreateUnchecked |
|
| Defaults |
|
| Defaults |
|
| Defaults |
|
| Democracy |
|
| DemocracyFunctions |
|
| DemocracyFunctions.ReferendumInfoExtended |
A ReferendumInfo with an additional `index` field
|
| Digest |
A Header Digest
|
| Digest.AuthoritiesChange |
Log for Authories changed
|
| Digest.ChangesTrieRoot |
Log for changes to the Trie root
|
| Digest.Consensus |
Log item indicating consensus
|
| Digest.DigestItem |
A EnumType the specifies the specific item in the logs of a Digest |
| Digest.Other |
Log item that is just a stream of Bytes |
| Digest.Seal |
Log item indicating a sealing event
|
| E01_SimpleConnect |
|
| E01_SimpleConnect |
|
| E02_ListenToBlocks |
|
| E02_ListenToBlocks |
|
| E03_ListenToBalanceChange |
|
| E03_ListenToBalanceChange |
|
| E04_Unsubscribe |
|
| E04_Unsubscribe |
|
| E05_ReadStorage |
|
| E05_ReadStorage |
|
| E06_MakeTransfer |
|
| E06_MakeTransfer |
|
| E08_SystemEvent |
|
| E08_SystemEvent |
|
| E09_TransferEvents |
|
| E09_TransferEvents |
|
| E10_UpgradeChain |
|
| E10_UpgradeChain |
|
| EmptySR25591 |
|
| Enum |
A codec wrapper for an enum.
|
| EnumType<T> |
This implements an enum, that based on the value wraps a different type.
|
| EnumType.EnumConstructor<T extends Codec> |
|
| Event |
A representation of a system event.
|
| Event.EventData |
Wrapper for the actual data that forms part of an Event
|
| Event.EventData.Builder |
|
| Event.EventIndex |
This follows the same approach as in Method, we have the `[sectionIndex, methodIndex]` pairing
that indicates the actual event fired |
| EventEmitter |
|
| EventEmitter.EventListener |
|
| EventEmitter.EventType |
|
| EventRecord |
A record for an Event (as specified by Metadata) with the specific Phase of
application. |
| EventRecord.ApplyExtrinsic |
The Phase where the extrinsic is applied
|
| EventRecord.Finalization |
The Phase where the extrinsic is being Finalized
|
| EventRecord.Phase |
An EnumType that indicates the specific phase where the EventRecord was generated |
| Events |
|
| Events |
|
| Events.EventMetadata |
|
| Events.MetadataEvent |
The definition of an event
|
| Events.OuterEventMetadata |
|
| Events.OuterEventMetadataEvent |
|
| ExecutorsManager |
|
| Exposure |
A snapshot of the stake backing a single validator in the system
|
| Extrinsic |
Representation of an Extrinsic in the system.
|
| Extrinsic.ExtrinsicValue |
|
| ExtrinsicEra |
The era for an extrinsic, indicating either a mortal or immortal extrinsic
|
| Extrinsics |
|
| ExtrinsicSignature |
|
| ExtrinsicStatus |
|
| ExtrinsicStatus.Broadcast |
|
| ExtrinsicStatus.Dropped |
|
| ExtrinsicStatus.Finalized |
|
| ExtrinsicStatus.Future |
|
| ExtrinsicStatus.Invalid |
|
| ExtrinsicStatus.Ready |
|
| ExtrinsicStatus.Usurped |
|
| FromMetadata |
|
| FromMetadata |
Extend a storage object with the storage modules & module functions present
in the metadata.
|
| Gas |
A gas number type for Substrate, extending U64 |
| H160 |
Hash containing 160 bits (20 bytes), typically used in blocks, extrinsics and
as a sane default for fixed-length hash representations.
|
| H256 |
Hash containing 256 bits (32 bytes), typically used in blocks, extrinsics and
as a sane default for fixed-length hash representations.
|
| H512 |
Hash containing 512 bits (64 bytes), typically used for signatures
|
| Hash |
The default hash that is used accross the system.
|
| Header |
|
| Header.HeaderExtended |
A Block header with an additional `author` field that indicates the block author |
| Header.HeaderValue |
|
| Health |
A system health indicator, reported back over RPC
|
| HttpClient |
|
| HttpClient.HeadOptions |
|
| HttpClient.HttpResp |
|
| HttpClient.Params |
|
| HttpProvider |
# @polkadot/rpc-provider/https
HttpProvider
The HTTP Provider allows sending requests using HTTP to a HTTP RPC server TCP port.
|
| I128 |
An 128-bit signed integer
|
| I16 |
An 16-bit signed integer
|
| I256 |
An 256-bit signed integer
|
| I32 |
An 32-bit signed integer
|
| I64 |
An 64-bit signed integer
|
| I8 |
An 8-bit signed integer
|
| IApi<ApplyResult> |
|
| IFunction<R> |
|
| IModule<S extends ISection> |
|
| Index |
|
| Index |
|
| Index |
|
| Index |
The Nonce or number of transactions sent by a specific account.
|
| Index.Derive |
|
| Index.DeriveCustom |
|
| Index.DeriveCustomSection |
|
| Index.DeriveReal |
|
| Index.DeriveRealSection |
|
| Index.KeyringPairDefault |
|
| IndividualExposure |
The Substrate IndividualExposure for staking
|
| InherentOfflineReport |
Describes the offline-reporting extrinsic
|
| Int |
A generic signed integer codec.
|
| IProvider |
|
| IProvider.CallbackHandler<T,U> |
|
| IProvider.ProviderInterfaceEmitCb |
|
| IProvider.ProviderInterfaceEmitted |
|
| IProvider.SubscriptionHandler |
|
| IRpc |
|
| IRpc.RpcInterfaceSection |
|
| IRpcFunction<T> |
|
| IRpcFunction.SubscribeCallback<T> |
|
| IRpcFunction.Unsubscribe<T> |
|
| IRpcModule |
|
| ISection<F extends IFunction> |
|
| ISR25591 |
|
| IWsProvider |
|
| JniSR25591 |
|
| Json |
Wraps the a JSON structure retrieve via RPC.
|
| JsonAuthor |
|
| JsonChain |
|
| JsonRpc |
|
| JsonRpcMethod |
|
| JsonRpcMethodOpt |
|
| JsonRpcParam |
|
| JsonRpcSection |
|
| JsonState |
|
| JsonSystem |
|
| Justification |
A generic justification as a stream of Bytes, this is specific per consensus implementation |
| Justification.RhdJustification |
Justification for the Rhododendron consensus algorithm
|
| Justification.RhdJustificationValue |
|
| Key |
The Substrate Key representation as a Bytes (`vec `). |
| Keyring |
# @polkadot/keyring
|
| KeyValue |
KeyValue structure.
|
| KeyValue.KeyValueOption |
A key/value change.
|
| Linkage<T extends Codec> |
|
| Linkage.LinkageResult |
|
| LockIdentifier |
|
| LocKPeriods |
|
| MagicNumber |
|
| MapUtils |
|
| Metadata |
The versioned runtime metadata as a decoded structure
|
| MetadataUtils |
|
| MetadataV0 |
The runtime metadata as a decoded structure
|
| MetadataV1 |
|
| MetadataV1.MetadataModule |
The definition of a module in the system
|
| MetadataV2 |
|
| MetadataV2.MetadataModule |
The definition of a module in the system
|
| MetadataV3 |
|
| MetadataV3.MetadataModule |
The definition of a module in the system
|
| MetadataVersioned |
The versioned runtime metadata as a decoded structure
|
| MetadataVersioned.MetadataEnum |
|
| Method |
Extrinsic function descriptor, as defined in
{@link https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node}.
|
| Method.DecodedMethod |
|
| Method.DecodeMethodInput |
|
| Method.MethodFunction |
|
| Method.MethodIndex |
A wrapper around the `[sectionIndex, methodIndex]` value that uniquely identifies a method
|
| Method.Methods |
|
| Method.ModulesWithMethods |
|
| MisbehaviorReport |
A Misbehaviour report of MisbehavioirKind against a specific AuthorityId
|
| MisbehaviorReport.BftAtReport |
A report of a/b hash-signature pairs for a specific index.
|
| MisbehaviorReport.BftAtReportValue |
|
| MisbehaviorReport.BftAtReportValueSingle |
|
| MisbehaviorReport.BftDoubleCommit |
Report of a double-commit
|
| MisbehaviorReport.BftDoublePrepare |
Report of a double-prepare
|
| MisbehaviorReport.BftDoublePropose |
Report of a double-propose
|
| MisbehaviorReport.BftProposeOutOfTurn |
A report for out-of-turn proposals
|
| MisbehaviorReport.MisbehaviorKind |
An EnumType containing a Bft misbehaviour |
| MisbehaviorReport.MisbehaviorReportValue |
|
| Modules |
|
| Modules.CallMetadata |
|
| Modules.FunctionArgumentMetadata |
|
| Modules.FunctionMetadata |
|
| Modules.MapType |
|
| Modules.ModuleMetadata |
|
| Modules.PlainType |
|
| Modules.RuntimeModuleMetadata |
|
| Modules.StorageFunctionMetadata |
|
| Modules.StorageFunctionMetadataValue |
|
| Modules.StorageFunctionModifier |
|
| Modules.StorageFunctionType |
|
| Modules.StorageMetadata |
|
| Moment |
A wrapper around seconds/timestamps.
|
| Moment.MomentOf |
The Substrate MomentOf representation as a Moment.
|
| Nacl |
|
| Nacl.Encrypted |
|
| NaclTest |
|
| NamedThreadFactory |
|
| NetworkState |
Wraps the properties retrieved from the chain via the `system.network_state` RPC call.
|
| NewAccountOutcome |
Enum to track the outcome for creation of an AccountId
|
| Nonce |
The Nonce or number of transactions sent by a specific account.
|
| NonceCompact |
The Compact or number of transactions sent by a specific account.
|
| Null |
Implements a type that does not contain anything (apart from `null`)
|
| Option<T extends Codec> |
An Option is an optional field.
|
| Origin |
Where Origin occurs, it should be ignored as an internal-only value, so it should
never actually be constructed
|
| PackageScanner |
自动扫描包下面的Class
|
| PairCodec |
|
| PairCodec.DecodeResult |
|
| PairCodec.PairStateJson |
|
| Pairs |
|
| Pairs.KeyringPairMap |
|
| ParaId |
Identifier for a deployed parachain implemented as a U32 |
| PeerInfo |
A system peer info indicator, reported back over RPC
|
| PendingExtrinsics |
|
| Perbill |
Parts per billion (see also Permill) |
| Permill |
|
| PrefabWasmModule |
Struct to encode the vesting schedule of an individual account
|
| PrefabWasmModule.PrefabWasmModuleReserved |
|
| PropIndex |
An increasing number that represents a specific public proposal index in the
system, implemented as a U32 |
| Proposal |
A proposal in the system.
|
| ProposalIndex |
|
| ReferendumIndex |
An increasing number that represents a specific referendum in the system.
|
| ReferendumInfo |
Info regarding an ongoing referendum
|
| ReferendumInfo.ReferendumInfoValue |
|
| ReflectionUtils |
|
| RewardDestination |
A destination account for payment
|
| RpcCoder |
|
| RpcCore |
|
| RpcRx |
RpcRx
The RxJS API is a wrapper around the API.
|
| RuntimeVersion |
|
| RuntimeVersion.ApiId |
An identifier for the runtime API
|
| RuntimeVersion.RuntimeVersionApi |
A Tuple that contains the ApiId and U32 version |
| RxUtils |
|
| Schedule |
Definition of the cost schedule and other parameterizations for wasm vm
|
| Schnorrkel |
|
| SeedOf |
|
| SessionFunctions |
|
| SessionKey |
Wrapper for a SessionKey.
|
| Set |
An Set is an array of string values, represented an an encoded type by
a bitwise representation of the values.
|
| Set.SetValues |
|
| Signature |
The default signature that is used accross the system.
|
| Signature.Ed25519Signature |
The default Ed25519 that is used accross the system.
|
| Signature.Sr25519Signature |
The default Sr25519 signature that is used accross the system.
|
| SignaturePayload |
|
| SignaturePayload.SignaturePayloadValue |
|
| SignedBlock |
A Block that has been signed and contains a Justification
|
| SignedBlock.SignedBlockValue |
|
| SR25519 |
|
| Staking |
|
| StakingFunctions |
|
| StakingLedger |
The ledger of a (bonded) stash
|
| StaticMetadata |
|
| Storage |
|
| Storage |
|
| Storage |
|
| Storage.Default |
|
| Storage.Default |
|
| Storage.DoubleMapType |
|
| Storage.MapType |
|
| Storage.MapType |
|
| Storage.MetadataStorageModifier |
|
| Storage.MetadataStorageType |
|
| Storage.MetadataStorageType |
|
| Storage.MetadataStorageType |
|
| Storage.MetadataStorageV1 |
The definition of a storage function
|
| Storage.MetadataStorageV2 |
The definition of a storage function
|
| Storage.MetadataStorageV3 |
The definition of a storage function
|
| Storage.Optional |
|
| Storage.Optional |
|
| Storage.PlainType |
|
| Storage.PlainType |
|
| StorageChangeSet |
A set of storage changes.
|
| StorageData |
Data retrieved via Storage queries and data for KeyValue pairs
|
| StorageKey |
A representation of a storage key (typically hashed) in the system.
|
| StorageKey.StorageFunction |
|
| StoredPendingChange |
Stored pending change for a Grandpa events
|
| StoredPendingChange.NextAuthority |
The next authority available as SessionKey
|
| StoredPendingChange.NextAuthorityValue |
|
| StoredPendingChange.StoredPendingChangeValue |
|
| Struct |
|
| SubmittableExtrinsic<ApplyResult> |
|
| SubmittableExtrinsic.StatusCb |
|
| SubmittableExtrinsic.SubmittableExtrinsicImpl |
|
| SubmittableExtrinsic.SubmittableResult |
|
| Substrate |
|
| Substrate.SubstrateMetadata |
|
| TestingPairs |
|
| Text |
This is a string wrapper, along with the length.
|
| ToV0 |
|
| ToV1 |
|
| ToV2 |
|
| TreasuryProposal |
A Proposal made for Treasury
|
| Tuple |
A Tuple defines an anonymous fixed-length array, where each element has its
own type.
|
| TweetNaCl |
|
| TweetNaCl.InvalidCipherTextException |
|
| TweetNaCl.InvalidSignatureException |
|
| Type |
This is a extended version of String, specifically to handle types.
|
| TypeRegistry |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types |
|
| Types.ApiBaseInterface<ApplyResult> |
|
| Types.ApiInterfacePromise |
|
| Types.ApiOptions |
|
| Types.CodecArg |
export type CodecArg = Codec | BN | Boolean | String | Uint8Array | boolean | number | string | undefined | CodecArgArray | CodecArgObject;
|
| Types.CodecCallback<T extends Codec> |
|
| Types.ConstructorCodec<T extends Codec> |
|
| Types.ConstructorDef |
|
| Types.Contract |
|
| Types.ContractABI |
|
| Types.ContractABIArg |
|
| Types.ContractABIFn |
|
| Types.ContractABIMethod |
|
| Types.ContractABIMethodBase |
|
| Types.DecoratedRpc<ApplyResult> |
|
| Types.DecoratedRpcMethod<ApplyResult> |
|
| Types.DecoratedRpcSection<ApplyResult> |
|
| Types.Derive<ApplyResult> |
|
| Types.DerivedBalances |
|
| Types.DerivedBalancesMap |
|
| Types.DerivedFees |
|
| Types.DerivedReferendumVote |
|
| Types.DeriveMethod<ApplyResult> |
|
| Types.DeriveRealFunction |
|
| Types.DeriveSection<ApplyResult> |
|
| Types.IExtrinsic |
|
| Types.IExtrinsicSignature |
|
| Types.IHash |
|
| Types.IMethod |
|
| Types.IRpcRx |
|
| Types.JsonRpcError |
|
| Types.JsonRpcObject |
|
| Types.JsonRpcRequest |
|
| Types.JsonRpcResponse |
|
| Types.Keypair |
|
| Types.KeyringInstance |
|
| Types.KeyringOptions |
|
| Types.KeyringPair |
|
| Types.KeyringPairJson |
|
| Types.KeyringPairJsonEncoding |
|
| Types.KeyringPairMeta |
|
| Types.KeyringPairs |
|
| Types.MetadataInterface |
|
| Types.ModuleStorage |
|
| Types.OnCallDefinition<ApplyResult> |
|
| Types.OnCallFunction |
|
| Types.PairInfo |
|
| Types.QueryableModuleStorage<ApplyResult> |
|
| Types.QueryableStorage<ApplyResult> |
|
| Types.QueryableStorageFunction<ApplyResult> |
export interface QueryableStorageFunctionBase extends StorageFunction {
(arg?: CodecArg): CodecResult;
at: (hash: Hash | Uint8Array | string, arg?: CodecArg) => CodecResult;
hash: (arg?: CodecArg) => HashResult;
key: (arg?: CodecArg) => string;
size: (arg?: CodecArg) => U64Result;
}
|
| Types.RegistryTypes |
|
| Types.RpcRxInterface |
|
| Types.RpcRxInterfaceMethod |
|
| Types.RpcRxInterfaceSection |
|
| Types.RpcRxOnCb |
|
| Types.RuntimeVersionInterface |
|
| Types.Seedpair |
|
| Types.SignatureOptions |
|
| Types.Signer |
|
| Types.Storage |
|
| Types.SubmittableExtrinsicFunction<ApplyResult> |
|
| Types.SubmittableExtrinsics<ApplyResult> |
|
| Types.SubmittableModuleExtrinsics |
|
| Types.SubscriptionParam |
|
| TypesUtils |
|
| U128 |
An 128-bit unsigned integer
|
| U16 |
An 16-bit unsigned integer
|
| U256 |
An 256-bit unsigned integer
|
| U32 |
An 32-bit unsigned integer
|
| U64 |
An 64-bit unsigned integer
|
| U8 |
An 8-bit unsigned integer
|
| U8a |
A basic wrapper around Uint8Array, with no frills and no fuss.
|
| U8aFixed |
A U8a that manages a a sequence of bytes up to the specified bitLength.
|
| UInt |
UInt
A generic unsigned integer codec.
|
| UnlockChunk |
Just a Balance/BlockNumber tuple to encode when a chunk of funds will be unlocked
|
| USize |
A System default unsigned number, typically used in RPC to report non-consensus
data.
|
| Utils |
|
| UtilsCrypto |
|
| ValidatorPrefs |
Validator preferences
|
| Vector<T extends Codec> |
Vector
This manages codec arrays.
|
| VestingSchedule |
Struct to encode the vesting schedule of an individual account
|
| Vote |
A number of lock periods, plus a vote, one way or the other.
|
| VoteIndex |
|
| VoteThreshold |
Voting threshold, used inside proposals to set change the voting tally
|
| WithdrawReasons |
The Substrate WithdrawReasons for staking
|
| WsProvider |
# @polkadot/rpc-provider/ws
WsProviderDir
The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port.
|
| WsProvider.WsStateAwaiting<T> |
|