Preparing search index...
The search index is not available
Klayr SDK - v0.1.0
Klayr SDK
klayr-framework
PluginOptions
Interface PluginOptions
Hierarchy
Record
<
string
,
unknown
>
PluginOptions
Index
Properties
load
As
Child
Process?
Properties
Optional
Readonly
load
As
Child
Process
load
As
Child
Process
?:
boolean
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
load
As
Child
Process
Klayr SDK -
v0.1.0
@klayr/api-
client -
v6.0.3
APIClient
create
Client
createIPCClient
createWSClient
@klayr/chain -
v0.5.2
Block
Block
Assets
Block
Header
Chain
Data
Access
Event
Not
Found
Error
SMTStore
State
Store
Transaction
Block
Asset
Block
Header
Attrs
BlockJSON
Current
State
Event
Attr
Iterate
Options
Raw
Block
Transaction
Attrs
Block
AssetJSON
Block
HeaderJSON
TransactionJSON
DB_
KEY_
BLOCKS_
HEIGHT
DB_
KEY_
BLOCKS_
ID
DB_
KEY_
BLOCK_
ASSETS_
BLOCK_
ID
DB_
KEY_
BLOCK_
EVENTS
DB_
KEY_
DIFF_
STATE
DB_
KEY_
FINALIZED_
HEIGHT
DB_
KEY_
INCLUSION_
PROOFS
DB_
KEY_
STATE_
SMT
DB_
KEY_
STATE_
STORE
DB_
KEY_
TEMPBLOCKS_
HEIGHT
DB_
KEY_
TRANSACTIONS_
BLOCK_
ID
DB_
KEY_
TRANSACTIONS_
ID
EMPTY_
BUFFER
EVENT_
KEY_
LENGTH
EVENT_
MAX_
EVENT_
SIZE_
BYTES
EVENT_
MAX_
TOPICS_
PER_
EVENT
MAX_
CROSS_
CHAIN_
COMMAND_
NAME_
LENGTH
MAX_
EVENTS_
PER_
BLOCK
MAX_
MODULE_
NAME_
LENGTH
MIN_
CROSS_
CHAIN_
COMMAND_
NAME_
LENGTH
MIN_
MODULE_
NAME_
LENGTH
NAME_
REGEX
TAG_
BLOCK_
HEADER
TAG_
TRANSACTION
block
Asset
Schema
block
Header
Schema
block
Schema
event
Schema
signing
Block
Header
Schema
standard
Event
Data
Schema
state
Diff
Schema
transaction
Schema
concatDBKeys
@klayr/codec -
v0.4.2
Codec
Schema
codec
empty
Schema
validate
Schema
@klayr/cryptography -
v4.0.2
address
get
Address
From
Klayr32
Address
get
Address
From
Private
Key
get
Address
From
Public
Key
get
Klayr32
Address
From
Address
get
Klayr32
Address
From
Public
Key
validate
Klayr32
Address
bls
BLS_
SUPPORTED
create
Agg
Sig
generate
Private
Key
get
Private
Key
From
Phrase
And
Path
get
Public
Key
From
Private
Key
pop
Prove
pop
Verify
sign
Data
validate
Key
verify
Agg
Sig
verify
Data
verify
Weighted
Agg
Sig
constants
BINARY_
ADDRESS_
LENGTH
DEFAULT_
KLAYR32_
ADDRESS_
PREFIX
ED25519_
CURVE
EMPTY_
BUFFER
EMPTY_
SALT
HARDENED_
OFFSET
HASH_
LENGTH
KLAYR32_
ADDRESS_
LENGTH
KLAYR32_
CHARSET
L
MAX_
UINT32
MESSAGE_
TAG_
NON_
PROTOCOL_
MESSAGE
SHA256
ed
Signed
Message
Signed
Message
With
Private
Key
get
Private
Key
From
Phrase
And
Path
get
Public
Key
From
Private
Key
print
Signed
Message
sign
And
Print
Message
sign
Data
sign
Data
With
Private
Key
sign
Message
With
Private
Key
verify
Data
verify
Message
With
Public
Key
encrypt
Cipher
KDF
Encrypted
Message
Object
ARGON2_
MEMORY
decryptAES128GCMWith
Password
decrypt
Message
With
Password
encryptAES128GCMWith
Password
encrypt
Message
With
Password
parse
Encrypted
Message
stringify
Encrypted
Message
legacy
get
Keys
get
Private
And
Public
Key
From
Passphrase
legacy
Address
get
First
Eight
Bytes
Reversed
get
Legacy
Address
And
Public
Key
From
Passphrase
get
Legacy
Address
From
Passphrase
get
Legacy
Address
From
Private
Key
get
Legacy
Address
From
Public
Key
utils
BIG_
ENDIAN
LITTLE_
ENDIAN
create
Message
Tag
generate
Hash
Onion
Seed
get
Random
Bytes
hash
hash
Onion
hex
To
Buffer
int
To
Buffer
parse
Key
Derivation
Path
tag
Message
@klayr/p2p -
v0.9.2
constants
Connection
Kind
Peer
Kind
DEFAULT_
ACK_
TIMEOUT
DEFAULT_
BAN_
TIME
DEFAULT_
CONNECT_
TIMEOUT
DEFAULT_
CONTROL_
MESSAGE_
LIMIT
DEFAULT_
EVICTION_
THRESHOLD_
TIME
DEFAULT_
FALLBACK_
SEED_
PEER_
DISCOVERY_
INTERVAL
DEFAULT_
HTTP_
PATH
DEFAULT_
LOCALHOST_
IP
DEFAULT_
MAX_
INBOUND_
CONNECTIONS
DEFAULT_
MAX_
OUTBOUND_
CONNECTIONS
DEFAULT_
MAX_
PEER_
DISCOVERY_
RESPONSE_
LENGTH
DEFAULT_
MAX_
PEER_
INFO_
SIZE
DEFAULT_
MAX_
RECONNECT_
TRIES
DEFAULT_
MESSAGE_
ENCODING_
FORMAT
DEFAULT_
MIN_
PEER_
DISCOVERY_
THRESHOLD
DEFAULT_
MIN_
TRIED_
PEER_
COUNT
DEFAULT_
NEW_
BUCKET_
COUNT
DEFAULT_
NEW_
BUCKET_
SIZE
DEFAULT_
NODE_
HOST_
IP
DEFAULT_
NONCE_
LENGTH_
BYTES
DEFAULT_
OUTBOUND_
SHUFFLE_
INTERVAL
DEFAULT_
PEER_
PROTECTION_
FOR_
LATENCY
DEFAULT_
PEER_
PROTECTION_
FOR_
LONGEVITY
DEFAULT_
PEER_
PROTECTION_
FOR_
NETGROUP
DEFAULT_
PEER_
PROTECTION_
FOR_
USEFULNESS
DEFAULT_
PEER_
STATUS_
MESSAGE_
RATE
DEFAULT_
PING_
INTERVAL_
MAX
DEFAULT_
PING_
INTERVAL_
MIN
DEFAULT_
POPULATOR_
INTERVAL
DEFAULT_
PRODUCTIVITY
DEFAULT_
PRODUCTIVITY_
RESET_
INTERVAL
DEFAULT_
RANDOM_
SECRET
DEFAULT_
RATE_
CALCULATION_
INTERVAL
DEFAULT_
REPUTATION_
SCORE
DEFAULT_
SEND_
PEER_
LIMIT
DEFAULT_
TRIED_
BUCKET_
COUNT
DEFAULT_
TRIED_
BUCKET_
SIZE
DEFAULT_
WS_
MAX_
MESSAGE_
RATE
DEFAULT_
WS_
MAX_
MESSAGE_
RATE_
PENALTY
DEFAULT_
WS_
MAX_
PAYLOAD
DUPLICATE_
CONNECTION
DUPLICATE_
CONNECTION_
REASON
EVICTED_
PEER_
CODE
FORBIDDEN_
CONNECTION
FORBIDDEN_
CONNECTION_
REASON
INCOMPATIBLE_
NETWORK_
CODE
INCOMPATIBLE_
NETWORK_
REASON
INCOMPATIBLE_
PEER_
CODE
INCOMPATIBLE_
PEER_
INFO_
CODE
INCOMPATIBLE_
PEER_
INFO_
CODE_
REASON
INCOMPATIBLE_
PEER_
UNKNOWN_
REASON
INCOMPATIBLE_
PROTOCOL_
VERSION_
CODE
INCOMPATIBLE_
PROTOCOL_
VERSION_
REASON
INTENTIONAL_
DISCONNECT_
CODE
INVALID_
CONNECTION_
ADDRESS_
CODE
INVALID_
CONNECTION_
ADDRESS_
REASON
INVALID_
CONNECTION_
QUERY_
CODE
INVALID_
CONNECTION_
QUERY_
REASON
INVALID_
CONNECTION_
SELF_
CODE
INVALID_
CONNECTION_
SELF_
REASON
INVALID_
CONNECTION_
URL_
CODE
INVALID_
CONNECTION_
URL_
REASON
INVALID_
PEER_
INFO_
LIST_
REASON
INVALID_
PEER_
INFO_
PENALTY
INVALID_
PEER_
LIST_
PENALTY
PEER_
INFO_
LIST_
TOO_
LONG_
REASON
SEED_
PEER_
DISCONNECTION_
REASON
errors
Existing
Peer
Error
Invalid
Disconnect
Event
Error
Invalid
Node
Info
Error
Invalid
Payload
Error
Invalid
Peer
Info
Error
Invalid
Peer
Info
List
Error
Invalid
Protocol
Message
Error
InvalidRPCRequest
Error
InvalidRPCResponse
Error
Peer
Inbound
Duplicate
Connection
Error
Peer
Inbound
Handshake
Error
RPCResponse
Already
Sent
Error
RPCResponse
Error
Request
Fail
Error
Send
Fail
Error
events
EVENT_
BAN_
PEER
EVENT_
CLOSE_
INBOUND
EVENT_
CLOSE_
OUTBOUND
EVENT_
CONNECT_
ABORT_
OUTBOUND
EVENT_
CONNECT_
OUTBOUND
EVENT_
DISCOVERED_
PEER
EVENT_
FAILED_
PEER_
INFO_
UPDATE
EVENT_
FAILED_
TO_
ADD_
INBOUND_
PEER
EVENT_
FAILED_
TO_
COLLECT_
PEER_
DETAILS_
ON_
CONNECT
EVENT_
FAILED_
TO_
FETCH_
PEERS
EVENT_
FAILED_
TO_
FETCH_
PEER_
INFO
EVENT_
FAILED_
TO_
PUSH_
NODE_
INFO
EVENT_
FAILED_
TO_
SEND_
MESSAGE
EVENT_
INBOUND_
SOCKET_
ERROR
EVENT_
INVALID_
MESSAGE_
RECEIVED
EVENT_
INVALID_
REQUEST_
RECEIVED
EVENT_
MESSAGE_
RECEIVED
EVENT_
NETWORK_
READY
EVENT_
NEW_
INBOUND_
PEER
EVENT_
NEW_
INBOUND_
PEER_
CONNECTION
EVENT_
OUTBOUND_
SOCKET_
ERROR
EVENT_
REMOVE_
PEER
EVENT_
REQUEST_
RECEIVED
EVENT_
UPDATED_
PEER_
INFO
PROTOCOL_
EVENTS_
TO_
RATE_
LIMIT
REMOTE_
EVENT_
PING
REMOTE_
EVENT_
PONG
REMOTE_
EVENT_
POST_
NODE_
INFO
REMOTE_
EVENT_
RPC_
GET_
NODE_
INFO
REMOTE_
EVENT_
RPC_
GET_
PEERS_
LIST
REMOTE_
SC_
EVENT_
MESSAGE
REMOTE_
SC_
EVENT_
RPC_
REQUEST
p2p
Request
P2PRequest
p2p
Schemas
defaultRPCSchemas
node
Info
Schema
peer
Info
Schema
peer
Request
Response
Schema
merge
Custom
Schema
p2p
Types
Base
Request
Response
Packet
Incoming
Peer
Connection
Network
Stats
P2PClose
Packet
P2PCompatibility
Check
Return
Type
P2PConfig
P2PInternal
State
P2PMessage
Packet
P2PMessage
Packet
Buffer
Data
P2PNode
Info
P2PPeer
Info
P2PPeer
Selection
For
Connection
Input
P2PPeer
Selection
For
Request
Input
P2PPeer
Selection
For
Send
Input
P2PPeers
Count
P2PPenalty
P2PRaw
Message
Packet
P2PRaw
Request
Packet
P2PRequest
Packet
P2PRequest
Packet
Buffer
Data
P2PResponse
Packet
P2PResponse
Packet
Buffer
Data
P2PShared
State
Peer
Config
Peer
Lists
Peer
Pool
Config
Peer
Server
Config
Protocol
Peer
Info
RPCSchemas
Request
Options
UnknownKVPair
P2PCheck
Peer
Compatibility
P2PEnhanced
Peer
Info
P2PPeer
Selection
For
Connection
Function
P2PPeer
Selection
For
Request
Function
P2PPeer
Selection
For
Send
Function
Peer
Info
P2P
@klayr/passphrase -
v4.0.2
Mnemonic
wordlists
entropy
To
Mnemonic
generate
Mnemonic
get
Default
Wordlist
mnemonic
To
Entropy
mnemonic
To
Seed
mnemonic
To
Seed
Sync
set
Default
Wordlist
validate
Mnemonic
validation
count
Passphrase
Whitespaces
count
Passphrase
Words
count
Uppercase
Characters
get
Passphrase
Validation
Errors
locate
Consecutive
Whitespaces
locate
Uppercase
Characters
@klayr/transaction-
pool -
v0.7.2
Transaction
Status
Job
Transaction
Pool
Transaction
Object
Transaction
Pool
Config
Pooled
Transaction
DEFAULT_
EXPIRE_
INTERVAL
DEFAULT_
EXPIRY_
TIME
DEFAULT_
MAX_
TRANSACTIONS
DEFAULT_
MAX_
TRANSACTIONS_
PER_
ACCOUNT
DEFAULT_
MINIMUM_
REPLACEMENT_
FEE_
DIFFERENCE
DEFAULT_
MIN_
ENTRANCE_
FEE_
PRIORITY
DEFAULT_
REORGANIZE_
TIME
events
@klayr/transactions -
v6.0.2
Multi
Signature
Keys
Options
DEFAULT_
MIN_
FEE_
PER_
BYTE
DEFAULT_
NUMBER_
OF_
SIGNATURES
DEFAULT_
SIGNATURE_
BYTE_
SIZE
TAG_
TRANSACTION
base
Transaction
Schema
compute
Min
Fee
convert
Beddows
ToKLY
convertKLYTo
Beddows
get
Bytes
get
Signing
Bytes
sign
Multi
Signature
Transaction
sign
Multi
Signature
Transaction
With
Private
Key
sign
Transaction
sign
Transaction
With
Private
Key
validate
Transaction
@klayr/tree -
v0.4.2
Merkle
Tree
regular
Merkle
Tree
@klayr/utils -
v0.4.2
data
Structures
Buffer
Map
Buffer
Set
Max
Heap
Min
Heap
job
Handlers
Mutex
Scheduler
math
Q_
OPERATION
Q
q
q96
objects
buffer
Array
Contains
buffer
Array
Contains
Some
buffer
Array
Equal
buffer
Array
Includes
buffer
Array
Subtract
buffer
Array
Unique
Items
clone
Deep
is
Buffer
Array
Ordered
merge
Deep
@klayr/validator -
v0.8.2
Klayr
Validation
Error
Klayr
Validator
Error
Object
MAX_
SINT32
MAX_
SINT64
MAX_
UINT32
MAX_
UINT64
MIN_
SINT32
MIN_
SINT64
klayr
Schema
Identifier
validator
convert
Errors
To
Legacy
Format
is
Boolean
is
Bytes
is
Csv
is
Encrypted
Passphrase
is
Greater
Than
Ranged
Version
is
Hex
String
isIP
isIPV4
isIPV6
is
Less
Than
Ranged
Version
is
Number
String
is
Port
is
Protocol
String
is
Ranged
Sem
Ver
isSInt32
isSInt64
is
Sem
Ver
is
String
is
String
Ends
With
isUInt32
isUInt64
is
Valid
Integer
is
Version
Match
klayr-
commander -
v6.0.5
Base
Genesis
Block
Command
BaseIPCClient
Command
Base
Start
Command
Block
Get
Command
Blockchain
Export
Command
Blockchain
Hash
Command
Blockchain
Import
Command
Blockchain
Reset
Command
Config
Create
Command
Config
Show
Command
Console
Command
Generator
Disable
Command
Generator
Enable
Command
Generator
Export
Command
Generator
Import
Command
Generator
Status
Command
Hash
Onion
Command
Invoke
Command
Keys
Create
Command
Keys
Encrypt
Command
Keys
Export
Command
Keys
Import
Command
List
Command
Message
Decrypt
Command
Message
Encrypt
Command
Message
Sign
Command
Message
Verify
Command
Node
Info
Command
Node
Metadata
Command
Passphrase
Create
Command
Passphrase
Decrypt
Command
Passphrase
Encrypt
Command
Transaction
Create
Command
Transaction
Get
Command
Transaction
Send
Command
Transaction
Sign
Command
run
klayr-
framework -
v0.11.4
testing
fixtures
Keys
block
AssetsJSON
default
Config
default
Faucet
Account
default
Passphrase
keys
List
get
Generator
Private
Key
From
Default
Config
get
Keys
From
Default
Config
mocks
channel
Mock
logger
Mock
Application
Env
In
Memory
Prefixed
StateDB
Block
Processing
Env
Create
Genesis
Block
Context
Params
create
Before
RecoverCCMsg
Method
Context
create
Block
create
Block
Context
create
Block
Generate
Context
create
Block
Header
With
Defaults
create
Cross
Chain
Message
Context
create
Default
Application
Env
create
Fake
Block
Header
create
Genesis
Block
Context
create
RecoverCCMsg
Method
Context
create
Transaction
create
Transaction
Context
create
Transient
Method
Context
create
Transient
Module
Endpoint
Context
get
Block
Processing
Env
CCMProcessed
Code
CCMProcessed
Result
Chain
Status
Channel
Type
Transaction
Execution
Result
Transaction
Verify
Result
Verify
Status
Application
Auth
Method
Auth
Module
BaseCCCommand
BaseCCMethod
Base
Channel
Base
Command
Base
Endpoint
Base
Event
Base
Internal
Method
Base
Interoperable
Module
Base
Method
Base
Module
Base
Offchain
Store
Base
Plugin
Base
Plugin
Endpoint
Base
Store
Block
Block
Header
Dynamic
Reward
Method
Dynamic
Reward
Module
Fee
Method
Fee
Module
IPCChannel
Initialize
State
Recovery
Command
Mainchain
Interoperability
Method
Mainchain
Interoperability
Module
Named
Registry
PoSMethod
PoSModule
Random
Method
Random
Module
Recover
Message
Command
Recover
State
Command
Register
Mainchain
Command
Register
Sidechain
Command
Report
Misbehavior
Command
Reward
Method
Reward
Module
Sidechain
Interoperability
Method
Sidechain
Interoperability
Module
Stake
Command
Submit
Mainchain
Cross
Chain
Update
Command
Submit
Sidechain
Cross
Chain
Update
Command
Terminate
Sidechain
For
Liveness
Command
Token
Method
Token
Module
Transaction
Transfer
Command
Unlock
Command
Update
Generator
Key
Command
Validator
Registration
Command
Validators
Method
Validators
Module
Active
Validator
Active
Validators
Update
Aggregate
Commit
Application
Config
BFTHeights
BFTParameters
BFTValidator
Block
Execute
Context
BlockJSON
Block
Verify
Context
CCMsg
Ccm
Processed
Event
Data
Ccm
Send
Success
Event
Data
Certificate
Chain
Account
Chain
AccountJSON
Channel
Data
Channel
DataJSON
Command
Execute
Context
Command
Verify
Context
Cross
Chain
Message
Context
Cross
Chain
Update
Transaction
Params
Endpoint
Info
Event
Event
Queuer
Generator
Config
Genesis
Block
Execute
Context
Genesis
Config
Immutable
Method
Context
Immutable
Offchain
Store
Getter
Immutable
Store
Getter
Inbox
Update
Insert
Asset
Context
Last
Certificate
Last
CertificateJSON
Legacy
Config
Method
Context
Module
Endpoint
Context
Module
Init
Args
Module
Metadata
Network
Config
Offchain
Store
Getter
Outbox
Root
Witness
Own
Chain
Account
Own
Chain
AccountJSON
Plugin
Config
Plugin
Endpoint
Context
Plugin
Init
Context
Plugin
Options
Proof
Prove
Response
Query
Proof
RPCConfig
Recover
Context
Registered
Schema
Schema
With
Default
Socket
Paths
Store
Getter
System
Config
Transaction
Execute
Context
Transaction
Pool
Config
Transaction
Verify
Context
Unsigned
Certificate
Validator
Config
Verification
Result
Application
Config
For
Plugin
Block
After
Execute
Context
Block
AssetJSON
Block
HeaderJSON
Endpoint
Handler
Endpoint
Handlers
Engine
Config
Event
Callback
EventJSON
Events
Definition
Inbox
InboxJSON
JSONObject
Module
MetadataJSON
Outbox
OutboxJSON
Partial
Application
Config
TransactionJSON
BLS_
PUBLIC_
KEY_
LENGTH
BLS_
SIGNATURE_
LENGTH
CHAIN_
ID_
LENGTH
CROSS_
CHAIN_
COMMAND_
NAME_
TRANSFER
EMPTY_
BYTES
LIVENESS_
LIMIT
MAX_
CCM_
SIZE
MAX_
CHAIN_
NAME_
LENGTH
MAX_
NUM_
VALIDATORS
MESSAGE_
TAG_
CERTIFICATE
MESSAGE_
TAG_
CHAIN_
REG
MIN_
CHAIN_
NAME_
LENGTH
MODULE_
NAME_
INTEROPERABILITY
NUMBER_
ACTIVE_
VALIDATORS_
MAINCHAIN
aggregate
Commit
Schema
application
Config
Schema
auth
Genesis
Store
Schema
block
Header
Schema
block
Schema
ccm
Schema
ccu
Params
Schema
certificate
Schema
genesis
Interoperability
Schema
mainchain
Reg
Params
message
Recovery
Initialization
Params
Schema
message
Recovery
Params
Schema
multisig
Reg
Msg
Schema
pos
Genesis
Store
Schema
registrationCCMParams
Schema
registration
Signature
Message
Schema
sidechain
Reg
Params
sidechain
TerminatedCCMParams
Schema
signing
Block
Header
Schema
standard
Event
Data
Schema
state
Recovery
Init
Params
Schema
state
Recovery
Params
Schema
terminate
Sidechain
For
Liveness
Params
Schema
token
Genesis
Store
Schema
transaction
Schema
unsigned
Certificate
Schema
validators
Hash
Input
Schema
are
Distinct
Headers
Contradicting
compute
Unsigned
Certificate
From
Block
Header
get
MainchainID
system
Dirs
@klayr/dashboard-
plugin -
v0.3.4
Dashboard
Plugin
@klayr/chain-
connector-
plugin -
v0.1.4
Chain
Connector
Plugin
@klayr/generator-
plugin -
v0.4.4
Forger
Plugin
@klayr/faucet-
plugin -
v0.3.5
Faucet
Plugin
@klayr/report-
misbehavior-
plugin -
v0.4.4
Report
Misbehavior
Plugin
@klayr/monitor-
plugin -
v0.4.4
Monitor
Plugin
Generated using
TypeDoc