npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pollum-io/rollex-governance

v0.0.2

Published

Rollex Governance smart contracts

Downloads

4

Readme

License: AGPL v3 Build pass codecov

Rollex Governance

Architecture

governance-v2-architecture

Audits

The Rex Governance V2 has been audited by Peckshied, with the final report here

Planned configurations for mainnet

RexGovernance

  • voting delay: 7200 blocks (using 12s per block = 1 day) between proposal creation and proposal voting
  • guardian: Rex Guardian multisig
  • executors whitelisted: Executor (short) and Executor (long)
  • owner (entity able to change the strategy, voting delay and authorize/unauthorize executors): Executor 2, the long timelock

Executor (short)

It will control the whole Rex protocol v1, the token distributor used in v1, the contract collecting the fees of v1, the Reserve Ecosystem of REX and any change in this timelock itself

  • admin (the only address enable to interact with this executor): Rex Governance v2
  • delay (time between a proposals passes and its actions get executed): 1 day
  • grace period (time after the delay during which the proposal can be executed): 5 days
  • proposition threshold: 0.5%
  • voting duration: 3 days
  • vote differential: 0.5%
  • quorum: 2%

Executor (long)

It will control the upgradeability of the REX token, the stkREX, any change in the parameters of the Governance v2 and any change in the parameters of this timelock itself

Current configuration (voted on Proposal 106): Code, tests and deployement scripts can be found here.

  • admin: Rex Governance v2
  • delay: 7 days
  • grace period: 5 days
  • proposition threshold: 1.25%
  • voting duration: 10 days
  • vote differential: 6.5%
  • quorum: 6.5%

Deprecated configuration:

  • admin: Rex Governance v2
  • delay: 7 days
  • grace period: 5 days
  • proposition threshold: 2%
  • voting duration: 10 days
  • vote differential: 15%
  • quorum: 20%

Governance strategy (the contract determining how the voting/proposition powers are calculated)

  • Based on REX+stkREX
  • Voting and proposition power are: balanceOfREX + delegationReceivedOfREX + balanceOfstkREX + delegationReceivedOfstkREX (with delegation being voting or proposition depending on the case)
  • Total voting and proposition supply: REX supply

Getting Started

You can install @pollum-io/rollex-governace as an NPM package in your Hardhat, Buidler or Truffle project to import the contracts and interfaces:

npm install @pollum-io/rollex-governace

Import at Solidity files:

import {IRexGovernanceV2} from "@pollum-io/rollex-governace/contracts/interfaces/IRexGovernanceV2.sol";

contract Misc {

  function vote(uint256 proposal, bool support) {
    IRexGovernanceV2(pool).submitVote(proposal, support);
    {...}
  }
}

The JSON artifacts with the ABI and Bytecode are also included into the bundled NPM package at artifacts/ directory.

Import JSON file via Node JS require:

const GovernanceV2Artifact = require('@pollum-io/rollex-governace/artifacts/contracts/governance/RexGovernanceV2.sol/RexGovernanceV2.json');

// Log the ABI into console
console.log(GovernanceV2Artifact.abi)

Setup

The repository uses Docker Compose to manage sensitive keys and load the configuration. Prior any action like test or deploy, you must run docker-compose up to start the contracts-env container, and then connect to the container console via docker-compose exec contracts-env bash.

Follow the next steps to setup the repository:

  • Install docker and docker-compose
  • Create an enviroment file named .env and fill the next enviroment variables
# Mnemonic, only first address will be used
MNEMONIC=""

# Add Alchemy or Infura provider keys, alchemy takes preference at the config level
ALCHEMY_KEY=""
INFURA_KEY=""

# Optional Etherscan key, for automatize the verification of the contracts at Etherscan
ETHERSCAN_KEY=""

# Optional, if you plan to use Tenderly scripts
TENDERLY_PROJECT=""
TENDERLY_USERNAME=""

Test

For running the test suite, run:

docker-compose run contracts-env npm run test

For running coverage, run:

docker-compose run contracts-env npm run coverage