Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

NPM Package

Proofable Node SDK is the software development kit to help users build solutions around proofable-api service using Node. It provides a set of promise-based APIs as well as more advanced callback and stream based APIs for dealing with the service. The promise-based APIs are convenient to be consumed in most use cases, while the callback and stream based APIs support more advanced features such as canceling and per-call gRPC options.

Index

Classes

Interfaces

Functions

Functions

dataToKeyValues

  • dataToKeyValues(data: Record<string, any>): KeyValue[]

  • Converts a data object to a key-values array

    Parameters

    • data: Record<string, any>

      the data object. Only own properties will be converted

    Returns KeyValue[]

getAuthMetadata

  • getAuthMetadata(): Metadata

  • Get the authentication metadata from user's ProvenDB configuration directory

    Returns Metadata

getEthTrieFromKeyValuesProof

  • getEthTrieFromKeyValuesProof(path: string): Promise<EthTrie>

newAPIClient

  • newAPIClient(hostPort: string, authMetadata?: grpc.Metadata, secure?: boolean): APIClient

  • Creates a new API Service client

    Parameters

    • hostPort: string
    • Optional authMetadata: grpc.Metadata
    • Default value secure: boolean = true

    Returns APIClient

sortKeyValues

stripCompoundKeyAnchorTriePart

  • Strips away the anchor trie part from the compound key. The anchor trie part of a key is added by Anchor Service after a successful anchoring

    Parameters

    Returns KeyValue

Generated using TypeDoc