Options
All
  • Public
  • Public/Protected
  • All
Menu

Module lib/proto/confio/proofs

Index

Type aliases

DeepPartial

DeepPartial<T>: T extends Builtin ? T : T extends infer U[] ? DeepPartial<U>[] : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {[ K in keyof T]: DeepPartial<T[K]> } : Partial<T>

Type parameters

  • T

Variables

BatchEntry

BatchEntry: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
    • decode(input: Uint8Array | Reader, length?: number): BatchEntry
  • encode: function
    • encode(message: BatchEntry, writer?: Writer): Writer
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }; nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; ... }): BatchEntry
    • Parameters

      • object: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }; nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; ... }
        • Optional exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }
        • Optional nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; ...

      Returns BatchEntry

  • toJSON: function

BatchProof

BatchProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
    • decode(input: Uint8Array | Reader, length?: number): BatchProof
  • encode: function
    • encode(message: BatchProof, writer?: Writer): Writer
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } | undefined; nonexist?: { ....[] }): BatchProof
    • Parameters

      • object: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } | undefined; nonexist?: { ....[] }
        • Optional entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } | undefined; nonexist?: { ....[]

      Returns BatchProof

  • toJSON: function

CommitmentProof

CommitmentProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
  • encode: function
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { batch?: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } | undefined; no...; compressed?: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } | undefined; none...; exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }; nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; ... }): CommitmentProof
    • Parameters

      • object: { batch?: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } | undefined; no...; compressed?: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } | undefined; none...; exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }; nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; ... }
        • Optional batch?: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } | undefined; no...
        • Optional compressed?: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } | undefined; none...
        • Optional exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }
        • Optional nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; ...

      Returns CommitmentProof

  • toJSON: function

CompressedBatchEntry

CompressedBatchEntry: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
  • encode: function
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }; nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } ... }): CompressedBatchEntry
    • Parameters

      • object: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }; nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } ... }
        • Optional exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }
        • Optional nonexist?: { key?: Uint8Array | undefined; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } ...

      Returns CompressedBatchEntry

  • toJSON: function

CompressedBatchProof

CompressedBatchProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
  • encode: function
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } | undefined; nonexist?: { ......[]; lookupInners?: { hash?: HashOp | undefined; prefix?: Uint8Array | undefined; suffix?: Uint8Array | undefined; }[] }): CompressedBatchProof
    • Parameters

      • object: { entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } | undefined; nonexist?: { ......[]; lookupInners?: { hash?: HashOp | undefined; prefix?: Uint8Array | undefined; suffix?: Uint8Array | undefined; }[] }
        • Optional entries?: { exist?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } | undefined; nonexist?: { ......[]
        • Optional lookupInners?: { hash?: HashOp | undefined; prefix?: Uint8Array | undefined; suffix?: Uint8Array | undefined; }[]

      Returns CompressedBatchProof

  • toJSON: function

CompressedExistenceProof

CompressedExistenceProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

CompressedNonExistenceProof

CompressedNonExistenceProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
  • encode: function
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { key?: Uint8Array; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }; right?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } }): CompressedNonExistenceProof
    • Parameters

      • object: { key?: Uint8Array; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }; right?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; } }
        • Optional key?: Uint8Array

          TODO: remove this as unnecessary??? we prove a range

        • Optional left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }
        • Optional right?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: number[] | undefined; }

      Returns CompressedNonExistenceProof

  • toJSON: function

ExistenceProof

ExistenceProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
  • encode: function
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { key?: Uint8Array; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; }; path?: { hash?: HashOp | undefined; prefix?: Uint8Array | undefined; suffix?: Uint8Array | undefined; }[]; value?: Uint8Array }): ExistenceProof
    • Parameters

      • object: { key?: Uint8Array; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; }; path?: { hash?: HashOp | undefined; prefix?: Uint8Array | undefined; suffix?: Uint8Array | undefined; }[]; value?: Uint8Array }
        • Optional key?: Uint8Array
        • Optional leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; }
        • Optional path?: { hash?: HashOp | undefined; prefix?: Uint8Array | undefined; suffix?: Uint8Array | undefined; }[]
        • Optional value?: Uint8Array

      Returns ExistenceProof

  • toJSON: function

InnerOp

InnerOp: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

InnerSpec

InnerSpec: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
    • decode(input: Uint8Array | Reader, length?: number): InnerSpec
  • encode: function
    • encode(message: InnerSpec, writer?: Writer): Writer
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { childOrder?: number[]; childSize?: number; emptyChild?: Uint8Array; hash?: HashOp; maxPrefixLength?: number; minPrefixLength?: number }): InnerSpec
    • Parameters

      • object: { childOrder?: number[]; childSize?: number; emptyChild?: Uint8Array; hash?: HashOp; maxPrefixLength?: number; minPrefixLength?: number }
        • Optional childOrder?: number[]

          Child order is the ordering of the children node, must count from 0 iavl tree is [0, 1] (left then right) merk is [0, 2, 1] (left, right, here)

        • Optional childSize?: number
        • Optional emptyChild?: Uint8Array

          empty child is the prehash image that is used when one child is nil (eg. 20 bytes of 0)

        • Optional hash?: HashOp

          hash is the algorithm that must be used for each InnerOp

        • Optional maxPrefixLength?: number
        • Optional minPrefixLength?: number

      Returns InnerSpec

  • toJSON: function

LeafOp

LeafOp: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

NonExistenceProof

NonExistenceProof: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
  • encode: function
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { key?: Uint8Array; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }; right?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } }): NonExistenceProof
    • Parameters

      • object: { key?: Uint8Array; left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }; right?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; } }
        • Optional key?: Uint8Array

          TODO: remove this as unnecessary??? we prove a range

        • Optional left?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }
        • Optional right?: { key?: Uint8Array | undefined; value?: Uint8Array | undefined; leaf?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; } | undefined; path?: { ...; }[] | undefined; }

      Returns NonExistenceProof

  • toJSON: function

ProofSpec

ProofSpec: { decode: any; encode: any; fromJSON: any; fromPartial: any; toJSON: any }

Type declaration

  • decode: function
    • decode(input: Uint8Array | Reader, length?: number): ProofSpec
  • encode: function
    • encode(message: ProofSpec, writer?: Writer): Writer
  • fromJSON: function
  • fromPartial: function
    • fromPartial(object: { innerSpec?: { childOrder?: number[] | undefined; childSize?: number | undefined; minPrefixLength?: number | undefined; maxPrefixLength?: number | undefined; emptyChild?: Uint8Array | undefined; hash?: HashOp | undefined; }; leafSpec?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; }; maxDepth?: number; minDepth?: number }): ProofSpec
    • Parameters

      • object: { innerSpec?: { childOrder?: number[] | undefined; childSize?: number | undefined; minPrefixLength?: number | undefined; maxPrefixLength?: number | undefined; emptyChild?: Uint8Array | undefined; hash?: HashOp | undefined; }; leafSpec?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; }; maxDepth?: number; minDepth?: number }
        • Optional innerSpec?: { childOrder?: number[] | undefined; childSize?: number | undefined; minPrefixLength?: number | undefined; maxPrefixLength?: number | undefined; emptyChild?: Uint8Array | undefined; hash?: HashOp | undefined; }
        • Optional leafSpec?: { hash?: HashOp | undefined; prehashKey?: HashOp | undefined; prehashValue?: HashOp | undefined; length?: LengthOp | undefined; prefix?: Uint8Array | undefined; }

          any field in the ExistenceProof must be the same as in this spec. except Prefix, which is just the first bytes of prefix (spec can be longer)

        • Optional maxDepth?: number

          max_depth (if > 0) is the maximum number of InnerOps allowed (mainly for fixed-depth tries)

        • Optional minDepth?: number

          min_depth (if > 0) is the minimum number of InnerOps allowed (mainly for fixed-depth tries)

      Returns ProofSpec

  • toJSON: function

Const protobufPackage

protobufPackage: "ics23" = 'ics23'

Functions

hashOpFromJSON

  • hashOpFromJSON(object: any): HashOp

hashOpToJSON

  • hashOpToJSON(object: HashOp): string

lengthOpFromJSON

  • lengthOpFromJSON(object: any): LengthOp

lengthOpToJSON

  • lengthOpToJSON(object: LengthOp): string

Generated using TypeDoc