metronome-lib v1.0.0

metronome-lib

A JavaScript library for the Metronome Token.

This library is a thin wrapper around web3, metronome-contracts and metronome-ops to easy even more the interaction with the Metronome contracts. Operations like buying MET tokens in an auction, converting or porting tokens is mostly a one-liner.

Installation

npm install metronome-lib

Basic usage

const Metronome = require('metronome-lib')

// Get the status of the Metronome auction and converter contracts
const met = new Metronome(web3Instance)
met.getStatus().then(status => { /* ... */ })

// But MET in the ongoing auction
met.setAccount(myPrivateKeyOrMnemonic)
met.buyMet('1000000000000000000').then(purchase => { /* ... */ })

// Check my MET balance
met.getMetBalance().then(balance => { /* ... */ })

// Send MET to another account
met.sendMet(destinationAddress).then(transfer => { /* ... */ })

// Convert ether to MET
met.convertCoinsToMet('1000000000000000000').then(conv => { /* ... */ })

// Convert MET back to ether
met.convertMetToCoins('1000000000000000000').then(back => { /* ... */ })

// Port MET to another chain
const destMet = new Metronome(web3InstanceOnDestinationChain) // I.e. ETC
Promise.all([destMet.getDestinationChainData(), met.getOriginChainData()])
  .then(([destChainData, origChainData]) => met.exportMet(destChainData, '1000000000000000000')
    .then(exp => met.getExportProof(exp.data)
      .then(proof => destMet.importMet(origChainData, exp.data, proof))
    )
  )
  .then(imp => { /* ... */ })

API

new Metronome(web3)

Create a Metronome object ready to work with the Metronome contracts.

The proper contracts-set will be selected based on which chain the web3 instance is connected to.

metronome.getContracts() ⇒ Promise.<MetronomeContractsInstance>

Get the Metronome contracts of the library instance.

metronome.getMetChainName() ⇒ Promise.<string>

Get the Metronome chain name.

Returns: Promise.<string> - The name i.e. 'ETH'.

metronome.getAuctionStatus() ⇒ Promise.<AuctionStatus>

Get the status of the Auctions contract.

Returns: Promise.<AuctionStatus> - The status.

metronome.getConverterStatus() ⇒ Promise.<AutonomousConverterStatus>

Get the status of the AutonomousConverter contract.

Returns: Promise.<AutonomousConverterStatus> - The status.

metronome.getStatus() ⇒ Promise.<AuctionAndConverterStatus>

Get the status of both the Auctions and AutonomousConverter contracts.

Returns: Promise.<AuctionAndConverterStatus> - The statuses.

metronome.getMetBalance(owner) ⇒ Promise.<string>

Get the MET balance of an account.

Returns: Promise.<string> - The MET balance.

metronome.getCoinsToMetResult(depositAmount) ⇒ Promise.<string>

Calculate the coin to MET return conversion.

Returns: Promise.<string> - The MET amount that would be returned.

metronome.getMetToCoinsResult(depositAmount) ⇒ Promise.<string>

Calculate the MET to coin return conversion.

Returns: Promise.<string> - The coin amount that would be returned.

metronome.getDestinationChainData() ⇒ Promise.<DestinationChainData>

Get the destination chain data to perform an export.

Returns: Promise.<DestinationChainData> - The chain data.

metronome.getOriginChainData() ⇒ Promise.<OriginChainData>

Get the destination chain data to perform an export.

Returns: Promise.<OriginChainData> - The chain data.

metronome.getExportProof(exportData) ⇒ Promise.<string>

Get the Merkle root of a last 16 burns.

Returns: Promise.<string> - The Merkle root hash.

metronome.setAccount(privKeyOrMnemonic, options) ⇒ Metronome

Set the default account for this library instance.

All transactions will be signed and sent using the default account.

Returns: Metronome - The library instance.

metronome.buyMet(value) ⇒ Promise.<OperationResult>

Buy MET in auction.

Returns: Promise.<OperationResult> - The purchase result.

metronome.sendMet(to, value) ⇒ Promise.<OperationResult>

Transfer MET.

Returns: Promise.<OperationResult> - The transfer result.

metronome.approveMet(spender, value) ⇒ Promise.<OperationResult>

Set MET allowance.

Returns: Promise.<OperationResult> - The allowance result.

metronome.convertCoinsToMet(value, minReturn) ⇒ Promise.<OperationResult>

Convert coins to MET.

Returns: Promise.<OperationResult> - The conversion result.

metronome.convertMetToCoins(amount, minReturn) ⇒ Promise.<OperationResult>

Convert MET to coins.

This function can result in up to 3 transactions depending on the previous allowance level granted to the AutonomousConverter contract. Only the last operation -the conversion- will be returned as the result of calling this function.

Returns: Promise.<OperationResult> - The conversion result.

metronome.exportMet(destinationData, amount) ⇒ Promise.<OperationResult>

Initiate an export of MET to another chain and obtain the burn data.

Returns: Promise.<OperationResult> - The export result.

metronome.importMet(originData, exportData, proof) ⇒ Promise.<OperationResult>

Request the import of MET burned on another chain.

Returns: Promise.<OperationResult> - The import request result.

MetronomeContractsInstance : Object

A Metronome contracts set.

Properties

AuctionStatus : Object.<string, any>

An object representing the auction status.

Properties

AutonomousConverterStatus : Object

An object representing the autonomous converter status.

The converter price returned is for informational purposes only as the conversion price will change depending on the amount sent and the contract's balance.

Properties

AuctionAndConverterStatus : Object

A combined status.

Properties

DestinationChainData : Object

An object having destination contracts data.

Properties

OriginChainData : Object

An object having destination contracts data.

Properties

OperationResult : Object

The result of any library operation.

Properties

License

MIT