https://github.com/devalpha18/xfund-vor
A suite of Ethereum smart contracts, and accompanying Provider Oracle software for running VOR, and integrating VOR into your own smart contracts.
https://github.com/devalpha18/xfund-vor
Last synced: 10 months ago
JSON representation
A suite of Ethereum smart contracts, and accompanying Provider Oracle software for running VOR, and integrating VOR into your own smart contracts.
- Host: GitHub
- URL: https://github.com/devalpha18/xfund-vor
- Owner: devalpha18
- Created: 2023-01-03T10:34:40.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-03T10:35:11.000Z (about 3 years ago)
- Last Synced: 2025-02-03T11:51:11.642Z (12 months ago)
- Language: Go
- Homepage: https://vor.unification.io
- Size: 1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/unification-com/xfund-vor/releases/latest)
[](https://www.npmjs.com/package/@unification-com/xfund-vor)
# 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
```bash
yarn add @unification-com/xfund-vor
```
or
```bash
npm i @unification-com/xfund-vor
```
2. Import `VORConsumerBase.sol` into your contract and pass
parameters to your `constructor`
```solidity
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
```solidity
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
```solidity
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
```bash
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:
```bash
make dev-env
```
Alternatively, run the docker commands as follows:
```bash
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 `ganach-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:
```bash
make build-oracle-cli
```
The `oracle-cli` commands should now be available when the dev environment is running, for example:
```bash
./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:
```bash
yarn test
```
Run `oracle` tests:
```bash
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.