NAV Navbar
javascript

meterify

Example

const meter = require("meterify").meterify;
const Web3 = require("web3");
const meterify = meter(new Web3(), "http://test.meter.io:8669");

The meterify package is a wrapper to house all Meter related modules, and depends on the web3.js library. If you are writing applications or scripts executing in Node.js or a browser environment, you should use Meterify.

Property Type Description
web3Instance Object A web3 instance.
host String The Meter host url (and port if applicable).
timeout Number Request timeout value.

Returns an Object

{
  eth: {
    _requestManager: RequestManager,
    givenProvider: MetamaskInpageProvider,
    providers: {},
    _provider: MeterProvider, 
    
  },
  givenProvider: {
    mux: ObjectMultiplex,
    publicConfigStore: ObservableStore,
    rpcEngine: RpcEngine,
    send: ƒ
  },
  providers: {
    WebsocketProvider: ƒ,
    HttpProvider: ƒ,
    IpcProvider: ƒ
  },
  utils: {
    _fireError: ƒ,
    _jsonInterfaceMethodToString: ƒ,
    _flattenTypes: ƒ,
    randomHex: ƒ,
    _: ƒ, 
    
  },
  version: "1.0.0-beta.37",
  _provider: {
    _events: Events,
    _eventsCount: 1,
    RESTHost: "http://test.meter.io:8669",
    WSHost: "ws://test.meter.io:8669",
    timeout: 0, 
    
  },
  _requestManager: {
    provider: MeterProvider,
    providers: {},
    subscriptions: {}
  }
  ...
}

Parameters of the meterify return object

Property Type Description
BatchRequest function Sets a RequestManager object and initiates batch requests (see: ).
currentProvider function Get or set the current provider.
eth Object An Eth object (see: eth).
extension extension
givenProvider Object Return the given provider object.
providers Object A list of providers.
provider Object The current provider object.
_requestManager Object A RequestManager object.
setProvider function Set the current provider.
utils Object A utils object (see: )

Notes on meterify and web3

The RESTful API of Meter differs from Ethereum's JSON-RPC, and there are some methods in web3 are not supported by meterify.

Supported Web3 Methods

web3 instance
├── eth
│ ├── getBlockNumber
│ ├── getBalance
│ ├── getStorageAt
│ ├── getCode
│ ├── getBlock
│ ├── getTransaction
│ ├── getTransactionReceipt
│ ├── sendTransaction
│ ├── sendSignedTransaction
│ ├── call
│ ├── estimateGas
│ ├── getPastLogs
│ ├── subscribe
│ ├── clearSubscriptions
│ ├── getEnergy
│ ├── getChainTag
│ ├── getBlockRef
│ ├── accounts
│ └── Contract
│ ├── Constructor(new Contract())
│ ├── clone
│ ├── deploy
│ ├── methods
│ ├── methods.myMethod.call
│ ├── methods.myMethod.send
│ ├── methods.myMethod.estimateGas
│ ├── methods.myMethod.encodeABI
│ ├── events
│ ├── once
│ ├── events.myEvent
│ ├── events.allEvents
│ └── getPastEvents
└── utils

MODULES

eth

For meterify.eth see the eth reference documentation.

utils

For meterify.utils see the utils reference documentation.

module.options

A module does provide several options for configuring the transaction confirmation workflow, or for defining default values.

For the currently available option properties on a module: see the options reference documentation.

METHODS

BatchRequest

currentProvider

setProvider

PROPERTIES

givenProvider

providers

provider

_requestManager

options