@nimiq/core-web
Table of contents
Enumerations
Classes
- Address
- BLSKeyPair
- BLSPublicKey
- BLSSecretKey
- Client
- ClientConfiguration
- Hash
- KeyPair
- Policy
- PrivateKey
- PublicKey
- Signature
- SignatureProof
- Transaction
- TransactionBuilder
Interfaces
- InitOutput
- PlainAddStakeData
- PlainBasicAccount
- PlainBlockCommonFields
- PlainClientConfiguration
- PlainCreateStakerData
- PlainCreateValidatorData
- PlainEmptyProof
- PlainHtlcContract
- PlainHtlcData
- PlainHtlcEarlyResolveProof
- PlainHtlcRegularTransferProof
- PlainHtlcTimeoutResolveProof
- PlainMacroBlock
- PlainMicroBlock
- PlainPeerInfo
- PlainRawData
- PlainSetInactiveStakeData
- PlainStaker
- PlainStakingContract
- PlainStandardProof
- PlainTransaction
- PlainTransactionDetails
- PlainTransactionReceipt
- PlainUpdateStakerData
- PlainUpdateValidatorData
- PlainValidator
- PlainValidatorData
- PlainVestingContract
- PlainVestingData
Type Aliases
- ConsensusState
- InitInput
- PlainAccount
- PlainAccountType
- PlainBlock
- PlainTransactionFormat
- PlainTransactionProof
- PlainTransactionRecipientData
- PlainTransactionSenderData
- SyncInitInput
- TransactionState
Functions
Type Aliases
ConsensusState
Ƭ ConsensusState: "connecting" | "syncing" | "established"
Describes the state of consensus of the client.
Defined in
web.d.ts:156
InitInput
Ƭ InitInput: RequestInfo | URL | Response | BufferSource | WebAssembly.Module
Defined in
web.d.ts:1960
PlainAccount
Ƭ PlainAccount: { type: "basic" } & PlainBasicAccount | { type: "vesting" } & PlainVestingContract | { type: "htlc" } & PlainHtlcContract | { type: "staking" } & PlainStakingContract
Defined in
web.d.ts:48
PlainAccountType
Ƭ PlainAccountType: "basic" | "vesting" | "htlc" | "staking"
Defined in
web.d.ts:158
PlainBlock
Ƭ PlainBlock: { type: "macro" } & PlainMacroBlock | { type: "micro" } & PlainMicroBlock
Defined in
web.d.ts:242
PlainTransactionFormat
Ƭ PlainTransactionFormat: "basic" | "extended"
Defined in
web.d.ts:160
PlainTransactionProof
Ƭ PlainTransactionProof: { type: "empty" } & PlainEmptyProof | { type: "standard" } & PlainStandardProof | { type: "regular-transfer" } & PlainHtlcRegularTransferProof | { type: "timeout-resolve" } & PlainHtlcTimeoutResolveProof | { type: "early-resolve" } & PlainHtlcEarlyResolveProof
Enum over all possible meanings of a transaction's proof.
Defined in
web.d.ts:360
PlainTransactionRecipientData
Ƭ PlainTransactionRecipientData: { type: "raw" } & PlainRawData | { type: "vesting" } & PlainVestingData | { type: "htlc" } & PlainHtlcData | { type: "create-validator" } & PlainCreateValidatorData | { type: "update-validator" } & PlainUpdateValidatorData | { type: "deactivate-validator" } & PlainValidatorData | { type: "reactivate-validator" } & PlainValidatorData | { type: "retire-validator" } & PlainRawData | { type: "create-staker" } & PlainCreateStakerData | { type: "add-stake" } & PlainAddStakeData | { type: "update-staker" } & PlainUpdateStakerData | { type: "set-inactive-stake" } & PlainSetInactiveStakeData
Enum over all possible meanings of a transaction's recipient data.
Defined in
web.d.ts:258
PlainTransactionSenderData
Ƭ PlainTransactionSenderData: { type: "raw" } & PlainRawData | { type: "delete-validator" } & PlainRawData | { type: "remove-stake" } & PlainRawData
Enum over all possible meanings of a transaction's sender data.
Defined in
web.d.ts:253
SyncInitInput
Ƭ SyncInitInput: BufferSource | WebAssembly.Module
Defined in
web.d.ts:2183
TransactionState
Ƭ TransactionState: "new" | "pending" | "included" | "confirmed" | "invalidated" | "expired"
Describes the state of a transaction as known by the client.
Defined in
web.d.ts:523
Functions
default
▸ default(module_or_path?): Promise<InitOutput>
If module_or_path is {RequestInfo} or {URL}, makes a request and for everything else, calls WebAssembly.instantiate directly.
Parameters
| Name | Type |
|---|---|
module_or_path? | InitInput | Promise<InitInput> |
Returns
Promise<InitOutput>
Defined in
web.d.ts:2202
initSync
▸ initSync(module): InitOutput
Instantiates the given module, which can either be bytes or a precompiled WebAssembly.Module.
Parameters
| Name | Type |
|---|---|
module | SyncInitInput |
Returns
Defined in
web.d.ts:2192