Global

Methods

defineProperties(self, fields, data)

Source:

Defines properties on a Object. It make the assumption that underlying data is binary.

Parameters:
Name Type Description
self Object

the Object to define properties on
fields Array

an array fields to define. Fields can contain:

  • name - the name of the properties
  • length - the number of bytes the field can have
  • allowLess - if the field can be less than the length
  • allowEmpty
data *

data to be validated against the definitions

generatePrivacyGroup(options)

Source:

Generate a privacyGroupId

Parameters:
Name Type Description
options

Options passed into eea_sendRawTransaction
Returns:

String

PollingSubscription(subscription)

Source:

Manage creating/destroying filter and polling for new logs using priv_getFilterChanges

Parameters:
Name Type Description
subscription PrivateSubscription

PrivateSubscription(web3, privacyGroupId, filter)

Source:

Controls the lifecycle of a private subscription

Parameters:
Name Type Description
web3 *
privacyGroupId *
filter *

PubSubSubscription(subscription)

Source:

Manage persistent pub-sub subscriptions over WebSocket

Parameters:
Name Type Description
subscription PrivateSubscription

SubscriptionManager(subscription)

Source:

Manage a specific type of subscription

Parameters:
Name Type Description
subscription PrivateSubscription

toBuffer(v)

Source:

Attempts to turn a value into a Buffer. As input it supports Buffer, String, Number, null/undefined, BN and other objects with a toArray() method.

Parameters:
Name Type Description
v *

the value