Verified Open Randomness

A suite of Ethereum smart contracts, and accompanying Provider Oracle software for running VOR, and integrating VOR into your own smart contracts.

VOR Integration Quickstart

1. Install the package

yarn add @unification-com/xfund-vor

or

npm i @unification-com/xfund-vor

2. Import VORConsumerBase.sol into your contract and pass parameters to your constructor

import "@unification-com/xfund-vor/contracts/VORConsumerBase.sol";

contract MyRandomNumberContract is VORConsumerBase {
    constructor(address _vorCoordinator, address _xfund)
    public VORConsumerBase(_vorCoordinator, _xfund) {
        // other stuff...
    }
}

3. Implement a requestRandomness function

    function requestRandomness(uint256 _userProvidedSeed, bytes32 _keyHash, unit256 _fee) 
    external
    returns (bytes32 requestId) {
        requestId = requestRandomness(_keyHash, _fee, _userProvidedSeed);
        // other stuff...
    }

4. Implement the fulfillRandomness function for data Providers to send data

    function fulfillRandomness(bytes32 requestId, uint256 randomness) internal override {
        // do something with the received number
        uint256 randVal = randomness.mod(999).add(1);
        // other stuff...
    }

Development and Testing

Clone of fork

git clone https://github.com/unification-com/xfund-vor
npx truffle compile

Dev Environment

A complete Dockerised development environment is available, which is useful for both contributing to the development of VOR and when developing your own VOR-enabled smart contracts.

The development environment can be run using:

make dev-env

Alternatively, run the docker commands as follows:

docker build -t vor_dev_env -f docker/dev.Dockerfile .
docker run -it -p 8545:8545 -p 8445:8445 vor_dev_env

The environment will:

1. Spawn a deterministic ganache-cli development chain with 20 accounts funded with 100 ETH
2. Compile and deploy the necessary VOR smart contracts
3. Initialise the test accounts, send test tokens and register the Oracle's proving key
4. Run the oracle application

The container exposes port 8545 allowing the Ganache chain to be accessible via http://127.0.0.1:8545

Additionally, port 8445 is exposed, allowing the oracle to be accessed using the oracle-cli tool.

Dev environment configuration

• Ganache CLI wallet mnemonic: myth like bonus scare over problem client lizard pioneer submit female collect
• Ganache CLI URL: http://127.0.0.1:8545
• Ganache CLI Network/Chain ID: 696969
• VORCoordinator Contract address: 0xCfEB869F69431e42cdB54A4F4f105C19C080A601
• BlockHashStore contract address: 0x5b1869D9A4C187F2EAa108f3062412ecf0526b24
• VOR Oracle Wallet Address: 0xFFcf8FDEE72ac11b5c542428B35EEF5769C409f0
• VOR Oracle KeyHash: 0x1a7a24165e904cb38eb8344affcf8fdee72ac11b5c542428b35eef5769c409f0
• VOR Oracle API key: 0pear3uoznba36fwzoaspwrvc164bkjd

oraclecli in the Dev environment

You will need to build the tool:

make build-oracle-cli

The oracle-cli commands should now be available when the dev environment is running, for example:

./oracle-cli/build/oraclecli about -c ./docker/assets/oracle-cli_settings.json

Note: you will need to pass the -c ./docker/assets/oracle-cli_settings.json flag with each command in order to use the correct connection settings.

Unit Testing

Run smart contract tests:

yarn test

Run oracle tests:

make test-oracle

This will run the go tests in a self-contained, dockerised environment. A Ganache network will be run within the container for the tests to run against.

Polygon Mumbai

TestXFUND: 0xb07C72acF3D7A5E9dA28C56af6F93862f8cc8196
BlockHashStore: 0xf6b5d6eafE402d22609e685DE3394c8b359CaD31
VORCoordinator: 0xc12678b997ce94e9f3921B65AD144565dC20Aefc

Provider: 0x06b5959C3D8212a5718c4b5d6827aa7b2f29E2D5
Public Key: 0x0499d4b80d710ad8ca1ae12ac0682a3e3e004637cd10ccf47a6badc1f45b56cfcbc7504ed77f062e2b9922c13daeb001004a19ca632a8354f6c65d4b00991c85c8
Key Hash: 0x91c07383e58d6a27a1e8d89806b5959c3d8212a5718c4b5d6827aa7b2f29e2d5
Global Fee: 0.000001 xFUNDMOCK
Wait Time: 10 block confirmations