Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlasmaOptions

Options used to construct a new Plasma client instance.

Hierarchy

  • PlasmaOptions

Index

Properties

contractAddress

contractAddress: string

The address of the Plasma smart contract on the root chain.

Optional privateKey

privateKey: string | Buffer

Your private key, either hex-encoded or as a Buffer.

Optional rootCredentials

rootCredentials: ChannelCredentials

gRPC credentials to use to connect to the root node. Will default to HTTP transport.

rootURL

rootURL: string

URL to the root node. The URL should not include a protocol.

example

localhost:6545

useREST

useREST: boolean

Whether or not to use the REST API over the gRPC API. You should set this to true if you are using a web browser.

web3

web3: Web3

An instance of Web3. To transact, your Web3 instance must support signing using the same privateKey provided to the Plasma client.

Generated using TypeDoc