-
-

-@polkadot/primitives
-Base flow definitions for the base Polkadot types as defined in the specification. It is useful for implementations, applications and libraries, where type-checking of the JavaScript base types is of importance.
-Usage
-Installation -
-npm install --save @polkadot/primitives
-
Usage -
-
-
-import type { AccountId, Balance } from '@polkadot/primitives/base';
-
-function getBalance (accountId: AccountId): Balance {
- ...
-}
-
-Index
-Type aliases
-
-Functions
-
-
-Type aliases
-
-AccountId
-Ƭ AccountId: H256
-Defined in base.d.ts:17
-
-
-Balance
-Ƭ Balance: U128
-Defined in base.d.ts:18
-
-
-Block
-Ƭ Block: object
-Defined in block.d.ts:8
-Type declaration
-
-
-BlockIncomplete
-Ƭ BlockIncomplete: object
-Defined in create/types.d.ts:19
-Type declaration
-
-
-BlockNumber
-Ƭ BlockNumber: U64
-Defined in base.d.ts:19
-
-
-Bytes
-Ƭ Bytes: Uint8Array
-Defined in base.d.ts:7
-
-
-Candidate
-Ƭ Candidate: object
-Defined in candidate.d.ts:7
-Type declaration
-
-
-CandidateReceipt
-Ƭ CandidateReceipt: object
-Defined in candidate.d.ts:17
-Type declaration
-
-
-CandidateReceipt$BalanceUpload
-Ƭ CandidateReceipt$BalanceUpload: [AccountId, Balance]
-Defined in candidate.d.ts:14
-
-
-CandidateReceipt$EgressQueueRoot
-Ƭ CandidateReceipt$EgressQueueRoot: [ChainId, Hash]
-Defined in candidate.d.ts:15
-
-
-ChainId
-Ƭ ChainId: U32
-Defined in base.d.ts:20
-
-
-Digest
-Ƭ Digest: object
-Defined in digest.d.ts:9
-Type declaration
-
-
-Digest$Log
-Ƭ Digest$Log: Bytes
-Defined in digest.d.ts:7
-
-
-ExtrinsicFunction
-Ƭ ExtrinsicFunction: Uint8Array
-Defined in extrinsic.d.ts:8
-
-
-H160
-Ƭ H160: Uint8Array
-Defined in base.d.ts:9
-
-
-H256
-Ƭ H256: Uint8Array
-Defined in base.d.ts:10
-
-
-H512
-Ƭ H512: Uint8Array
-Defined in base.d.ts:11
-
-
-Hash
-Ƭ Hash: Uint8Array
-Defined in base.d.ts:8
-
-
-
-Ƭ Header: object
-Defined in header.d.ts:8
-Type declaration
-
-
-
-Ƭ HeaderHash: H256
-Defined in base.d.ts:21
-
-
-
-Ƭ HeaderIncomplete: object
-Defined in create/types.d.ts:9
-Type declaration
-
-
-Index
-Ƭ Index: U32
-Defined in base.d.ts:22
-
-
-JsonAccountId
-Ƭ JsonAccountId: JsonHash
-Defined in json/types.d.ts:18
-
-
-JsonAuthorityId
-Ƭ JsonAuthorityId: JsonHash
-Defined in json/types.d.ts:19
-
-
-JsonBlock
-Ƭ JsonBlock: object
-Defined in json/types.d.ts:57
-Type declaration
-
-
-JsonBlockNumber
-Ƭ JsonBlockNumber: JsonU64
-Defined in json/types.d.ts:20
-
-
-JsonBnType
-Ƭ JsonBnType: string
-Defined in json/types.d.ts:7
-
-
-JsonBytes
-Ƭ JsonBytes: string | Array<number>
-
-Defined in json/types.d.ts:10
-
-
-JsonDigest
-Ƭ JsonDigest: object
-Defined in json/types.d.ts:37
-Type declaration
-
-
-JsonH160
-Ƭ JsonH160: JsonHash
-Defined in json/types.d.ts:11
-
-
-JsonH256
-Ƭ JsonH256: JsonHash
-Defined in json/types.d.ts:12
-
-
-JsonH512
-Ƭ JsonH512: JsonHash
-Defined in json/types.d.ts:13
-
-
-JsonHash
-Ƭ JsonHash: string
-Defined in json/types.d.ts:8
-
-
-
-Ƭ JsonHeader: object
-Defined in json/types.d.ts:41
-Type declaration
-
-
-
-Ƭ JsonHeaderHash: JsonH256
-Defined in json/types.d.ts:14
-
-
-JsonJustification
-Ƭ JsonJustification: object
-Defined in json/types.d.ts:51
-Type declaration
-
-
-JsonJustification$Signature
-Ƭ JsonJustification$Signature: [string, string]
-Defined in json/types.d.ts:49
-
-
-JsonObjectId
-Ƭ JsonObjectId: JsonU64
-Defined in json/types.d.ts:21
-
-
-JsonParaChainId
-Ƭ JsonParaChainId: JsonU64
-Defined in json/types.d.ts:22
-
-
-JsonSignature
-Ƭ JsonSignature: JsonHash
-Defined in json/types.d.ts:23
-
-
-JsonTransaction
-Ƭ JsonTransaction: object
-Defined in json/types.d.ts:25
-Type declaration
-
-
-JsonU256
-Ƭ JsonU256: JsonBnType
-Defined in json/types.d.ts:16
-
-
-JsonU64
-Ƭ JsonU64: JsonBnType
-Defined in json/types.d.ts:15
-
-
-JsonUnchecked
-Ƭ JsonUnchecked: object
-Defined in json/types.d.ts:32
-Type declaration
-
-
-Justification
-Ƭ Justification: object
-Defined in bft.d.ts:9
-Defined in justification.d.ts:14
-Type declaration
-
-
-Justification$Signature
-Ƭ Justification$Signature: object
-Defined in bft.d.ts:7
-Defined in justification.d.ts:9
-Type declaration
-
-
-MisbehaviorReport
-Ƭ MisbehaviorReport: object
-Defined in misbehavior.d.ts:7
-Type declaration
-
-
-ObjectId
-Ƭ ObjectId: U64
-Defined in base.d.ts:23
-
-
-ParaChainId
-Ƭ ParaChainId: U64
-Defined in base.d.ts:24
-
-
-Proportion
-Ƭ Proportion: U64
-Defined in base.d.ts:25
-
-
-Role
-Ƭ Role: keyof RoleMap
-Defined in role/index.d.ts:12
-
-
-RoleMap
-Ƭ RoleMap: object
-Defined in role/index.d.ts:5
-Type declaration
-
-
-Signature
-Ƭ Signature: H512
-Defined in base.d.ts:26
-
-
-SizeType
-Ƭ SizeType: 32 | 64 | 128
-
-Defined in sizes.ts:5
-
-
-Timestamp
-Ƭ Timestamp: U64
-Defined in base.d.ts:27
-
-
-U128
-Ƭ U128: BN
-Defined in base.d.ts:14
-
-
-U256
-Ƭ U256: BN
-Defined in base.d.ts:15
-
-
-U32
-Ƭ U32: BN
-Defined in base.d.ts:12
-
-
-U64
-Ƭ U64: BN
-Defined in base.d.ts:13
-
-
-Unchecked
-Ƭ Unchecked: object
-Defined in extrinsic.d.ts:10
-Type declaration
-
-
-UncheckedRaw
-Ƭ UncheckedRaw: Uint8Array
-Defined in extrinsic.d.ts:17
-
-Functions
-
-accountIdDecode
-▸ accountIdDecode(value: JsonAccountId): AccountId
-Defined in json/accountId/decode.ts:10
-Parameters:
-
-Returns: AccountId
-
-
-accountIdEncode
-▸ accountIdEncode(value: AccountId): JsonAccountId
-Defined in json/accountId/encode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| value |
-AccountId |
-
-
-
-Returns: JsonAccountId
-
-
-block
-▸ block(__namedParameters: object): Block
-Defined in create/block.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: Block
-
-
-blockDecode
-▸ blockDecode(__namedParameters: object): BlockDecoded
-Defined in json/block/decode.ts:14
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: BlockDecoded
-
-
-bnDecode
-▸ bnDecode(value: JsonBnType, bitLength?: number): BN
-Defined in json/bn/decode.ts:12
-Parameters:
-
-
-
-| Param |
-Type |
-Default value |
-
-
-
-
-| value |
-JsonBnType |
-- |
-
-
-Default value bitLength |
-number |
--1 |
-
-
-
-Returns: BN
-
-
-bnEncode
-▸ bnEncode(value: BN | number, bitLength?: number): JsonBnType
-Defined in json/bn/encode.ts:11
-Parameters:
-
-
-
-| Param |
-Type |
-Default value |
-
-
-
-
-| value |
-BN | number |
-- |
-
-
-Default value bitLength |
-number |
--1 |
-
-
-
-Returns: JsonBnType
-
-
-bytesDecode
-▸ bytesDecode(value: JsonBytes): Bytes
-Defined in json/bytes/decode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| value |
-JsonBytes |
-
-
-
-Returns: Bytes
-
-
-bytesEncode
-▸ bytesEncode(value: Bytes): JsonBytes
-Defined in json/bytes/encode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| value |
-Bytes |
-
-
-
-Returns: JsonBytes
-
-
-decodeArray
-▸ decodeArray(input: Uint8Array): DecodedArray
-Defined in codec/decoder/array.ts:12
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| input |
-Uint8Array |
-
-
-
-Returns: DecodedArray
-
-
-decodeBlock
-▸ decodeBlock(u8a: Uint8Array): Block
-Defined in codec/block/decode.ts:11
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| u8a |
-Uint8Array |
-
-
-
-Returns: Block
-
-
-
-▸ decodeHeader(u8a: Uint8Array): DecodedRaw
-Defined in codec/header/decodeRaw.ts:20
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| u8a |
-Uint8Array |
-
-
-
-Returns: DecodedRaw
-
-
-decodeJustification
-▸ decodeJustification(u8a: Uint8Array): Justification
-Defined in codec/justification/decode.ts:9
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| u8a |
-Uint8Array |
-
-
-
-Returns: Justification
-
-
-decodeRaw
-▸ decodeRaw(u8a: Uint8Array): RawData
-Defined in codec/block/decodeRaw.ts:19
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| u8a |
-Uint8Array |
-
-
-
-Returns: RawData
-
-
-decodeU8a
-▸ decodeU8a(input: Uint8Array): Uint8Array
-Defined in codec/decoder/u8a.ts:7
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| input |
-Uint8Array |
-
-
-
-Returns: Uint8Array
-
-
-encodeArray
-▸ encodeArray(input: Array<Uint8Array>): Uint8Array
-Defined in codec/encoder/array.ts:5
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| input |
-Array<Uint8Array> |
-
-
-
-Returns: Uint8Array
-
-
-encodeBlock
-▸ encodeBlock(__namedParameters: object): Uint8Array
-Defined in codec/block/encode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: Uint8Array
-
-
-encodeBlockRaw
-▸ encodeBlockRaw(header: Uint8Array, extrinsics?: Array<UncheckedRaw>): Uint8Array
-Defined in codec/block/encodeRaw.ts:12
-Parameters:
-
-
-
-| Param |
-Type |
-Default value |
-
-
-
-
-| header |
-Uint8Array |
-- |
-
-
-Default value extrinsics |
-Array<UncheckedRaw> |
-[] |
-
-
-
-Returns: Uint8Array
-
-
-
-▸ encodeHeader(__namedParameters: object, extrinsics?: Array<UncheckedRaw>): Uint8Array
-Defined in codec/header/encode.ts:17
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-Optional extrinsics |
-Array<UncheckedRaw> |
-
-
-
-Returns: Uint8Array
-
-
-encodeU8a
-▸ encodeU8a(input: Uint8Array): Uint8Array
-Defined in codec/encoder/u8a.ts:5
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| input |
-Uint8Array |
-
-
-
-Returns: Uint8Array
-
-
-extrinsicDecode
-▸ extrinsicDecode(extrinsic: Uint8Array): BlockExtrinsicDecoded
-Defined in json/extrinsic/decode.ts:14
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| extrinsic |
-Uint8Array |
-
-
-
-Returns: BlockExtrinsicDecoded
-
-
-extrinsicsRootRaw
-▸ extrinsicsRootRaw(extrinsics?: Array<UncheckedRaw>): Uint8Array
-Defined in create/extrinsic/rootRaw.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-Default value |
-
-
-
-
-Default value extrinsics |
-Array<UncheckedRaw> |
-[] |
-
-
-
-Returns: Uint8Array
-
-
-hashDecode
-▸ hashDecode(value: JsonHash, bitLength?: number): Hash
-Defined in json/hash/decode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-Default value |
-
-
-
-
-| value |
-JsonHash |
-- |
-
-
-Default value bitLength |
-number |
--1 |
-
-
-
-Returns: Hash
-
-
-hashEncode
-▸ hashEncode(value: Hash | string, bitLength?: number): JsonHash
-Defined in json/hash/encode.ts:11
-Parameters:
-
-
-
-| Param |
-Type |
-Default value |
-
-
-
-
-| value |
-Hash | string |
-- |
-
-
-Default value bitLength |
-number |
--1 |
-
-
-
-Returns: JsonHash
-
-
-
-▸ header(__namedParameters: object, extrinsics?: Array<UncheckedRaw>): Header
-Defined in create/header.ts:14
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-Optional extrinsics |
-Array<UncheckedRaw> |
-
-
-
-Returns: Header
-
-
-
-▸ headerDecode(__namedParameters: object): Header
-Defined in json/header/decode.ts:15
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: Header
-
-
-
-▸ headerEncode(__namedParameters: object): JsonHeader
-Defined in json/header/encode.ts:13
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: JsonHeader
-
-
-
-▸ headerHash(header: Header): Uint8Array
-Defined in codec/header/hash.ts:11
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| header |
-Header |
-
-
-
-Returns: Uint8Array
-
-
-justificationDecode
-▸ justificationDecode(__namedParameters: object): BlockJustificationDecoded
-Defined in json/justification/decode.ts:12
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: BlockJustificationDecoded
-
-
-justificationEncode
-▸ justificationEncode(__namedParameters: object): JsonJustification
-Defined in json/justification/encode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| __namedParameters |
-object |
-
-
-
-Returns: JsonJustification
-
-
-objectIdDecode
-▸ objectIdDecode(value: JsonObjectId): ObjectId
-Defined in json/objectId/decode.ts:10
-Parameters:
-
-Returns: ObjectId
-
-
-objectIdEncode
-▸ objectIdEncode(value: ObjectId): JsonObjectId
-Defined in json/objectId/encode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| value |
-ObjectId |
-
-
-
-Returns: JsonObjectId
-
-
-parachainIdDecode
-▸ parachainIdDecode(value: JsonParaChainId): ParaChainId
-Defined in json/parachainId/decode.ts:10
-Parameters:
-
-Returns: ParaChainId
-
-
-parachainIdEncode
-▸ parachainIdEncode(value: ParaChainId): JsonParaChainId
-Defined in json/parachainId/encode.ts:10
-Parameters:
-
-Returns: JsonParaChainId
-
-
-rolesFromId
-▸ rolesFromId(roleId: number): Array<Role>
-Defined in role/fromId.ts:9
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| roleId |
-number |
-
-
-
-Returns: Array<Role>
-
-
-rolesToId
-▸ rolesToId(roles: Array<Role>): number
-Defined in role/toId.ts:9
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| roles |
-Array<Role> |
-
-
-
-Returns: number
-
-
-signatureDecode
-▸ signatureDecode(value: JsonSignature): Signature
-Defined in json/signature/decode.ts:10
-Parameters:
-
-Returns: Signature
-
-
-signatureEncode
-▸ signatureEncode(value: Signature): JsonSignature
-Defined in json/signature/encode.ts:10
-Parameters:
-
-
-
-| Param |
-Type |
-
-
-
-
-| value |
-Signature |
-
-
-
-Returns: JsonSignature
-
-
-
-