1.2.1 • Published 4 years ago
metronome-sdk-status v1.2.1
metronome-sdk-status
Auction and converter status functions for the Metronome SDK.
The status functions can be used as part of the Metronome SDK or standalone, providing the metronome-contracts to the constructor function.
Installation
Minimum requirement of node is v12
npm install metronome-sdk-statusUsage
As a standalone library
const Web3 = require('web3')
const MetronomeContracts = require('metronome-contracts')
const createMetronomeStatus = require('metronome-sdk-status')
const web3 = new Web3()
const metronomeContracts = new MetronomeContracts(web3)
const api = createMetronomeStatus(metronomeContracts)
api.getAuctionStatus().then(console.log)API
createMetronomeStatus(contracts) ⇒ MetronomeStatusApi
Create functions to query the status of the Auctions and Autonomous Converter contracts.
Returns: MetronomeStatusApi - The status getters.
| Param | Type | Description |
|---|---|---|
| contracts | Promise.<MetronomeContracts> | MetronomeContracts | A promise or an instance of Metronome contracts. |
createMetronomeStatus~getAuctionStatus(inMs) ⇒ Promise.<AuctionStatus>
Get the status of the Auctions contract.
Returns: Promise.<AuctionStatus> - The status.
| Param | Type | Description |
|---|---|---|
| inMs | boolean | Whether or not to convert times from sec to ms. |
createMetronomeStatus~getConverterStatus() ⇒ Promise.<AutonomousConverterStatus>
Get the status of the AutonomousConverter contract.
Returns: Promise.<AutonomousConverterStatus> - The status.
MetronomeContracts : Object
Properties
| Name | Type | Description |
|---|---|---|
| Auctions | Object | The Web3 instance of the contract. |
| AutonomousConverter | Object | The Web3 instance of the contract. |
MetronomeStatusApi : Object
Properties
| Name | Type | Description |
|---|---|---|
| getAuctionStatus | function | Get the status of the Auctions contract. |
| getConverterStatus | function | Get the status of the AutonomousConverter contract. |
AuctionStatus : Object
An object representing the auction status.
Properties
| Name | Type | Description |
|---|---|---|
| currAuction | string | The auction number. |
| currentAuctionPrice | string | The MET price. |
| currTick | string | The current tick. |
| dailyAuctionStartTime | number | The daily auctions start time. |
| dailyMintable | string | The amount at the start of the auction. |
| genesisTime | number | The ISA start time. |
| lastPurchasePrice | string | The last purchase price. |
| lastPurchaseTime | number | The last purchase time. |
| minting | string | The coins available in the current auction. |
| nextAuctionTime | number | The next auction start time. |
| totalMET | string | The total supply of MET. |
AutonomousConverterStatus : Object
An object representing the autonomous converter status.
Properties
| Name | Type | Description |
|---|---|---|
| currentConverterPrice | string | The coins returned for 1 MET. 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. |
| coinBalance | string | The contract's coins balance. I.e. ETH. |
| metBalance | string | The contract's MET balance. |
License
MIT