Reference Source

Typedef

Static Public Summary
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public
public

Static Public

public CreateChainResponse: Object source

Properties:

NameTypeAttributeDescription
chainId string

The ID of the new chain tree

public EstablishTokenResponse: Object source

Properties:

NameTypeAttributeDescription
tip string

The chain tree tip after the transaction.

public ExportChainTreeResponse: Object source

Properties:

NameTypeAttributeDescription
chainTree SerializedChainTree

The serialized chain tree

public GenerateKeyResponse: Object source

Properties:

NameTypeAttributeDescription
keyAddr string

Public key address

public GetTipResponse: Object source

Properties:

NameTypeAttributeDescription
tip string

The chain tree tip as known by the Tupelo signers

public ListChainIdsResponse: Object source

Properties:

NameTypeAttributeDescription
chainIds string[]

Chain tree IDs associated with this wallet.

public ListKeysResponse: Object source

Properties:

NameTypeAttributeDescription
keyAddrs string[]

Public key addresses associated with the connected wallet.

public MintTokenResponse: Object source

Properties:

NameTypeAttributeDescription
tip string

The chain tree tip after the transaction.

public PlayTransactionsResponse: Object source

Properties:

NameTypeAttributeDescription
tip string

The chain tree tip as known by the Tupelo signers after the transactions are applied

public RegisterResponse: Object source

Properties:

NameTypeAttributeDescription
walletName string

The name of the newly registered wallet

public ResolveResponse: Object source

Properties:

NameTypeAttributeDescription
remainingPath string

The path remaining after retrieving the data

data Object

The data retrieved

public RpcError: Object source

Properties:

NameTypeAttributeDescription
code number

A gRPC status

details string

Details about the error

metadata Object
  • nullable: true

Additional information about the error

public SerializedChainTree: Object source

Properties:

NameTypeAttributeDescription
tip string

Hash of the latest root tree node.

dag string[]

base58 encoded string array representing the chain tree dag nodes

signatures Map<String, SerializedSignature>

Map of serialized signatures

public SerializedSignature: Object source

Properties:

NameTypeAttributeDescription
signers boolean[]

Array indicating which signers have signed

signature string

base58 encoded signature

type string

Signature type

public SetDataResponse: Object source

Properties:

NameTypeAttributeDescription
tip string

The chain tree tip after the transaction.

public SetOwnerResponse: Object source

Properties:

NameTypeAttributeDescription
tip string

The chain tree tip after the transaction.

public StorageAdapterConfig: Object source

Properties:

NameTypeAttributeDescription
badger StorageAdapterConfigForBadger

Configure and use the badger storage adapter

ipld StorageAdapterConfigForIpld

Configure and use the ipld storage adapter

public StorageAdapterConfigForBadger: Object source

Properties:

NameTypeAttributeDescription
path string

Path for badger db

public StorageAdapterConfigForIpld: Object source

Properties:

NameTypeAttributeDescription
path string
  • optional

Path to ipld initialized configuration. Either path or address is required.

address string
  • optional

Multiaddr for ipfs http api. Either path or address is required.

online boolean
  • optional
  • default: false

if true, starts IPFS node in online mode

public WalletCredentials: Object source

Properties:

NameTypeAttributeDescription
walletName string

Wallet name

passPhrase string

Wallet passphrase