@kosu/gov-portal-helper v0.1.25-patch.1

Classes

Typedefs

Gov

Kind: global class

• Gov
  • new Gov()
  • instance
    • .init()
    • .currentProposals() ⇒ Map.<Proposal>
    • .currentValidators() ⇒ Map.<Validator>
    • .currentChallenges() ⇒ Map.<StoreChallenge>
    • .weiToEther(wei) ⇒ string
    • .etherToWei(ether) ⇒ string
    • .commitVote(challengeId, value, amount) ⇒ Promise.<string>
    • .hasCommittedVote(challengeId) ⇒ boolean
    • .revealVote(challengeId) ⇒ Promise.<string>
    • .hasRevealedVote(challengeId) ⇒ boolean
    • .estimateFutureBlockTimestamp(blockNumber) ⇒ Promise.<number>
    • .getPastBlockTimestamp(blockNumber) ⇒ Promise.<number>
    • .getHistoricalChallenges() ⇒ Promise.<Array.<PastChallenge>>
    • .getChallengeInfo(challengeId) ⇒ Promise.<ChallengeInfo>
    • .currentBlockNumber() ⇒ number
    • .getPastGovernanceActivity(address) ⇒ Promise.<Array.<PastGovernanceActivity>>
  • static
    • .ZERO
    • .ONE
    • .ONE_HUNDRED
    • .BLOCKS_PER_DAY

new Gov()

gov.init()

Kind: instance method of Gov

gov.currentProposals() ⇒ Map.<Proposal>

Kind: instance method of Gov
Returns: Map.<Proposal> - a map where the key is the listing public key, and the value is a proposal object
Example

const proposals = gov.currentProposals();

gov.currentValidators() ⇒ Map.<Validator>

Kind: instance method of Gov
Returns: Map.<Validator> - a map where the key is the listing public key, and the value is a validator object
Example

const validators = gov.currentValidators();

gov.currentChallenges() ⇒ Map.<StoreChallenge>

Kind: instance method of Gov
Returns: Map.<StoreChallenge> - a map where the key is the listing public key, and the value is a challenge object
Example

const challenges = gov.currentChallenges();

gov.weiToEther(wei) ⇒ string

Kind: instance method of Gov
Returns: string - the same amount in ether, string used for precision

Example

gov.weiToEther("100000000000000000000"); // > "100"
gov.weiToEther(100000000000000000000); // > "100"

gov.etherToWei(ether) ⇒ string

Kind: instance method of Gov
Returns: string - the same amount in wei, string used for precision

Example

gov.etherToWei(10); // > "10000000000000000000"
gov.etherToWei("1"); // > "1000000000000000000"

gov.commitVote(challengeId, value, amount) ⇒ Promise.<string>

Kind: instance method of Gov
Returns: Promise.<string> - the transaction hash of the commit tx

Example

// we are looking at challenge #13, and want to vote AGAINST it with 10 tokens
const pollId = new BigNumber(13);
const amount = new BigNumber(gov.etherToWei("10"));
const value = "0";

// will prompt for MetaMask signature
const commitVoteTxId = await gov.commitVote(pollId, value, amount);

// ... some time passes, we now want to reveal ...

// load vote from cookie and reveal
const revealTxId = await gov.revealVote(new BigNumber("13"));

// ... wait for Tx's to confirm or whatever, etc.

gov.hasCommittedVote(challengeId) ⇒ boolean

Kind: instance method of Gov
Returns: boolean - the boolean representing the presence of a commit vote

gov.revealVote(challengeId) ⇒ Promise.<string>

Kind: instance method of Gov
Returns: Promise.<string> - the transaction hash of the reveal tx.

gov.hasRevealedVote(challengeId) ⇒ boolean

Kind: instance method of Gov
Returns: boolean - the boolean representing the presence of a reveal vote

gov.estimateFutureBlockTimestamp(blockNumber) ⇒ Promise.<number>

Kind: instance method of Gov
Returns: Promise.<number> - the block's estimated UNIX timestamp (in seconds)

Example

const block = 6102105;
const unixTs = gov.estimateFutureBlockTimestamp(block);

// use as a normal date object (multiply by 1000 to get ms)
const blockDate = new Date(ts * 1000);

gov.getPastBlockTimestamp(blockNumber) ⇒ Promise.<number>

Kind: instance method of Gov
Returns: Promise.<number> - the Unix timestamp of the specified blockNumber

Example

await gov.getPastBlockTimestamp(515237); // > 1559346404

gov.getHistoricalChallenges() ⇒ Promise.<Array.<PastChallenge>>

Kind: instance method of Gov
Returns: Promise.<Array.<PastChallenge>> - all historical challenges.

gov.getChallengeInfo(challengeId) ⇒ Promise.<ChallengeInfo>

Kind: instance method of Gov
Returns: Promise.<ChallengeInfo> - the block numbers for this challenge

Example

const info = await gov.getChallengeInfo(new BigNumber(1));
const currentBlock = await gov.currentBlockNumber();

if (currentBlock < endCommitPeriod && currentBlock >= challengeStart) {
    // in "commit" period; voters may submit votes
} else if (currentBlock >= endCommitPeriod && currentBlock <= challengeEnd) {
    // in "reveal" period; voters may reveal votes
} else {
    // challenge has ended (or issues with block numbers)
}

gov.currentBlockNumber() ⇒ number

Kind: instance method of Gov
Returns: number - The current (or most recent) Ethereum block height.

gov.getPastGovernanceActivity(address) ⇒ Promise.<Array.<PastGovernanceActivity>>

Kind: instance method of Gov
Returns: Promise.<Array.<PastGovernanceActivity>> - An array of snippets about past governance activity.

Gov.ZERO

Kind: static property of Gov

Gov.ONE

Kind: static property of Gov

Gov.ONE_HUNDRED

Kind: static property of Gov

Gov.BLOCKS_PER_DAY

Kind: static property of Gov

Validator

Kind: global typedef
Properties

Proposal

Kind: global typedef
Properties

StoreChallenge

Kind: global typedef
Properties

PastChallenge

Kind: global typedef
Properties

ListingSnapshot

Kind: global typedef
Properties

Vote

Kind: global typedef
Properties

ChallengeInfo

Kind: global typedef
Properties

PastGovernanceActivity

Kind: global typedef
Properties