Options
All
  • Public
  • Public/Protected
  • All
Menu

@iov/lisk Documentation

Index

Variables

Const passphraseToKeypair

passphraseToKeypair: passphraseToKeypair = Derivation.passphraseToKeypair

Lisk-specific passphrase to Ed25519 keypair derivation

"passphrase" is Lisk's word for an autogenerated 12 word english BIP39 mnemonic encoded as a string. Since the BIP39 property is not used for anything but validation in the user interface we work with plain strings here.

Functions

createLiskConnector

  • createLiskConnector(url: string, expectedChainId?: ChainId): ChainConnector<LiskConnection>

generateNonce

  • generateNonce(): Nonce

isValidAddress

  • isValidAddress(address: string): boolean

pubkeyToAddress

  • pubkeyToAddress(pubkey: Uint8Array): Address

Object literals

Const constants

constants: object

addressSuffix

addressSuffix: string = "L"

primaryTokenFractionalDigits

primaryTokenFractionalDigits: number = 8

primaryTokenName

primaryTokenName: string = "Lisk"

primaryTokenTicker

primaryTokenTicker: string & As<"token-ticker"> = "LSK" as TokenTicker

transactionSerializationOptions

transactionSerializationOptions: object

maxMemoLength

maxMemoLength: number = 64

Const liskCodec

liskCodec: object

isValidAddress

isValidAddress: isValidAddress = isValidAddress

bytesToPost

  • bytesToPost(signed: SignedTransaction): PostableBytes

bytesToSign

  • bytesToSign(unsigned: UnsignedTransaction, nonce: Nonce): SigningJob

identifier

  • identifier(signed: SignedTransaction): TransactionId

identityToAddress

  • identityToAddress(identity: Identity): Address
  • ASCII-encoded address string, e.g. 6076671634347365051L

    Addresses cannot be stored as raw uint64 because there are two types of recipient addresses on the Lisk blockchain that cannot be encoded as uint64 :

    1. leading zeros make different addresses ("123L" != "000123L")
    2. some addresses exceed the uint64 range (e.g. "19961131544040416558L") These are bugs we have to deal with.

    Parameters

    • identity: Identity

    Returns Address

parseBytes

  • parseBytes(bytes: PostableBytes, chainId: ChainId): SignedTransaction
  • Recovers bytes (UTF-8 encoded JSON) from the blockchain into a format we can use

    Parameters

    • bytes: PostableBytes
    • chainId: ChainId

    Returns SignedTransaction

Generated using TypeDoc