Class Ledger

constructor

• new Ledger(
      config: LedgerConfig,
      node?: Node,
      existingStorage?: LedgerStorageAPI,
  ): Ledger

  Parameters

  • config: LedgerConfig
  • Optionalnode: Node
  • OptionalexistingStorage: LedgerStorageAPI

  Returns Ledger

ReadonlybaseToken

ReadonlyinitialTrustedAccount

ReadonlynetworkAddress

Optional Readonlynode

StaticisInstance

StaticKind

ledgerWriteMode

• get ledgerWriteMode(): NonNullable<
      undefined
      | "bootstrap-only"
      | "read-only"
      | "read-write"
      | "no-voting",
  >

  Returns NonNullable<
      undefined
      | "bootstrap-only"
      | "read-only"
      | "read-write"
      | "no-voting",
  >

_testingRunStorageFunction

• _testingRunStorageFunction<T>(
      code: (
          storage: LedgerStorageAPI,
          transaction: LedgerStorageTransactionBase,
      ) => Promise<T>,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • code: (
        storage: LedgerStorageAPI,
        transaction: LedgerStorageTransactionBase,
    ) => Promise<T>

  Returns Promise<T>

add

• add(...args: [votesAndBlocks: VoteStaple, from?: string]): Promise<BlockHash[]>

  Parameters

  • ...args: [votesAndBlocks: VoteStaple, from?: string]

  Returns Promise<BlockHash[]>

beginTransaction

• beginTransaction(
      identifier: string,
      readOnly?: boolean,
  ): Promise<LedgerAtomicInterface>

  Parameters

  • identifier: string
  • readOnly: boolean = false

  Returns Promise<LedgerAtomicInterface>

copy

• copy(newNode: Node): Ledger

  Parameters

  • newNode: Node

  Returns Ledger

gc

• gc(...args: []): Promise<boolean>

  Parameters

  • ...args: []

  Returns Promise<boolean>

getAccountInfo

• getAccountInfo(
      ...args: [account: string | GenericAccount],
  ): Promise<AccountInfo>

  Parameters

  • ...args: [account: string | GenericAccount]

  Returns Promise<AccountInfo>

getAccountRep

• getAccountRep(
      ...args: [
          account: string
          | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>,
      ],
  ): Promise<null | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>>

  Parameters

  • ...args: [account: string | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>]

  Returns Promise<null | Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>>

getAllBalances

• getAllBalances(
      ...args: [account: GenericAccount],
  ): Promise<GetAllBalancesResponse>

  Parameters

  • ...args: [account: GenericAccount]

  Returns Promise<GetAllBalancesResponse>

getBalance

• getBalance(
      ...args: [account: GenericAccount, token: TokenAddress],
  ): Promise<bigint>

  Parameters

  • ...args: [account: GenericAccount, token: TokenAddress]

  Returns Promise<bigint>

getBlock

• getBlock(
      ...args: [blockhash: BlockHash, from: LedgerSelector],
  ): Promise<null | Block>

  Parameters

  • ...args: [blockhash: BlockHash, from: LedgerSelector]

  Returns Promise<null | Block>

getBlockFromPrevious

• getBlockFromPrevious(
      ...args: [block: BlockHash, from: LedgerSelector],
  ): Promise<null | Block>

  Parameters

  • ...args: [block: BlockHash, from: LedgerSelector]

  Returns Promise<null | Block>

getHeadBlock

• getHeadBlock(
      ...args: [account: GenericAccount, from: LedgerSelector],
  ): Promise<null | Block>

  Parameters

  • ...args: [account: GenericAccount, from: LedgerSelector]

  Returns Promise<null | Block>

getHeadBlocks

• getHeadBlocks(
      ...args: [accounts: GenericAccount[], from: LedgerSelector],
  ): Promise<{ [account: string]: null | Block }>

  Parameters

  • ...args: [accounts: GenericAccount[], from: LedgerSelector]

  Returns Promise<{ [account: string]: null | Block }>

getHistory

• getHistory(
      ...args: [
          account: GenericAccount,
          start: null
          | VoteBlockHash,
          limit: number,
      ],
  ): Promise<VoteStaple[]>

  Parameters

  • ...args: [account: GenericAccount, start: null | VoteBlockHash, limit: number]

  Returns Promise<VoteStaple[]>

getStaplesFromBlockHashes

• getStaplesFromBlockHashes(...args: [hashes: BlockHash[]]): Promise<VoteStaple[]>

  Parameters

  • ...args: [hashes: BlockHash[]]

  Returns Promise<VoteStaple[]>

getVotes

• getVotes(
      ...args: [block: BlockHash, from: LedgerStorage],
  ): Promise<null | Vote[]>

  Parameters

  • ...args: [block: BlockHash, from: LedgerStorage]

  Returns Promise<null | Vote[]>

getVotesFromMultiplePrevious

• getVotesFromMultiplePrevious(
      ...args: [
          prevBlocks: BlockHash[],
          from: LedgerSelector,
          issuer?: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>,
      ],
  ): Promise<{ [hash: string]: null | Vote[] }>

  Parameters

  • ...args: [
        prevBlocks: BlockHash[],
        from: LedgerSelector,
        issuer?: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>,
    ]

  Returns Promise<{ [hash: string]: null | Vote[] }>

getVoteStaple

• getVoteStaple(
      ...args: [stapleBlockHash: VoteBlockHash, from: LedgerSelector],
  ): Promise<null | VoteStaple>

  Parameters

  • ...args: [stapleBlockHash: VoteBlockHash, from: LedgerSelector]

  Returns Promise<null | VoteStaple>

getVoteStaples

• getVoteStaples(
      ...args: [stapleBlockHashes: VoteBlockHash[], from: LedgerSelector],
  ): Promise<VoteBlockHashMap<null | VoteStaple>>

  Parameters

  • ...args: [stapleBlockHashes: VoteBlockHash[], from: LedgerSelector]

  Returns Promise<VoteBlockHashMap<null | VoteStaple>>

getVoteStaplesAfter

• getVoteStaplesAfter(
      ...args: [moment: Date, limit: number, options: GetVotesAfterOptions],
  ): Promise<VoteStaple[]>

  Parameters

  • ...args: [moment: Date, limit: number, options: GetVotesAfterOptions]

  Returns Promise<VoteStaple[]>

listACLsByEntity

• listACLsByEntity(...args: [entity: GenericAccount]): Promise<ACLRow[]>

  Parameters

  • ...args: [entity: GenericAccount]

  Returns Promise<ACLRow[]>

listACLsByPrincipal

• listACLsByPrincipal(
      ...args: [principal: GenericAccount, entityList?: GenericAccount[]],
  ): Promise<ACLRow[]>

  Parameters

  • ...args: [principal: GenericAccount, entityList?: GenericAccount[]]

  Returns Promise<ACLRow[]>

run

• run<T>(
      identifier: string,
      code: (transaction: LedgerAtomicInterface) => Promise<T>,
      readOnly?: boolean,
  ): Promise<T>

  Execute some code with a transaction held, if the code fails the transaction is aborted, otherwise it is committed

  Type Parameters

  • T

  Parameters

  • identifier: string
  • code: (transaction: LedgerAtomicInterface) => Promise<T>

    Code to run
  • OptionalreadOnly: boolean

  Returns Promise<T>

  The return value from "code"

runPostAdjustHeapDequeue

• runPostAdjustHeapDequeue(
      ...args: [blockPrevHashes?: string[] | BlockHash[]],
  ): Promise<BlockHash[]>

  Parameters

  • ...args: [blockPrevHashes?: string[] | BlockHash[]]

  Returns Promise<BlockHash[]>

runReadOnly

• runReadOnly<T>(
      identifier: string,
      code: (transaction: LedgerAtomicInterface) => Promise<T>,
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • identifier: string
  • code: (transaction: LedgerAtomicInterface) => Promise<T>

  Returns Promise<T>

stats

• stats(): Promise<LedgerStatistics>

  Returns Promise<LedgerStatistics>

vote

• vote(...args: [blocks: Block[], otherVotes?: Vote[]]): Promise<Vote>

  Parameters

  • ...args: [blocks: Block[], otherVotes?: Vote[]]

  Returns Promise<Vote>

votingPower

• votingPower(
      ...args: [rep?: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>],
  ): Promise<bigint>

  Parameters

  • ...args: [rep?: Account<ECDSA_SECP256K1 | ED25519 | ECDSA_SECP256R1>]

  Returns Promise<bigint>