The XYO Foundation provides this source code available in our efforts to advance the understanding of the XYO Procotol and its possible uses. We continue to maintain this software in the interest of developer education. Usage of this source code is not intended for production.
Beta SoftwareThis documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested.
What is the Simple Consensus Smart Contract Library?
It is a library for all nodes in XYO
This package has been built to streamline the dApp build process for anyone ready to integrate XYO into their project. Especially crucial in this library are the
Key contracts are upgradeable using OpenZeppelin's ZOS software
- In the command line go ahead and install using
npx zos link dapp-scsc-solidity
- Familiarity with
- Watch this video on staking a node in XYO
- Check out dApper
- dApper allows you to interact with the smart contracts from the scsc library on the browser
- Follow the walkthrough below to familiarize yourself with the scsc in the dApper environment. This is a good starting point to understanding how our scsc interacts with XYO.
How to add stake on XYO Diviner
Access our SCSC library through IPFS
use this hash
Then direct your browser to use our dAppper tool
with the hash
The contract will load, giving you access to the contracts through the contract simulator.
Start with the XyERC20Token
Connect your metamask wallet on the Kovan network
Check your balance using the
balanceOf() function from the ERC20 contract
Once you have verified that you have enough balance to stake the diviner, select the XyStakingConsensus contract This contract stores all the stake of the network
Approve the stake for the Diviner in the XyERC20 contract (make sure that you have the address for the XyStakingConsensus) using the
Go through metamask to submit the transaction. You have now approved stake, let's keep going.
Create a diviner
The diviner is represented by a Stakable token
Mint one token with your wallet address by selecting the XyBlockProducer and the address below
mint()function and paste your wallet address into the
Confirm the transaction on metamask
This will produce one non-fungible token (ERC721). This is unique to this specific diviner.
Then select the
tokenByIndex() function and enter
0 for your token address.
Copy the token address, this is virtual id of your diviner
Return to the XyStakingConsensusContract and select its address below
- Select the
- Paste the diviner id into the stakee field
- enter an amount to stake (make sure it is in your approved limits!)
You have just successfully added stake to a diviner!
note you are the staker, and the stakingId is the ledger of the stake that you have in the diviner
To check out the data of the stake, select the
stakeData() function, paste in the stakingId in the sole field.
You will now get a returned JSON object with your stake amount, the block it was staked on, the staker, and the stakee.
Sends a specific value of tokens from your XYO account to another
Sends a specific value of tokens from one (not yours) XYO address to another XYO address
Sets an allowance for tokens for another address check out our staking walkthrough for an example
Sets an allowance for tokens for another address with a notification for the other contract
bytes memory _extraData
approval notification with _value and _extraData
Destroys tokens from another account
This contract is used to track ownership of stakable addresses in XYO This contract is upgradeable
Allows a contract governor to add and remove a block producer
Mints a stakable address with the account has as the token id this emits a transfer event to the sender
Burns a token (only a governor can do this)
If the token belongs to a block producer, it deletes the token from its listing
A method to view if a stakee exists
A method to view if a stakee is a block producer
stakee from the blockProducersIndex
A method to view the number of block producers
number of block producers
Manages the stake for multiple clients in a decentralized consensus This contract is upgradeable
Returns the latest block submitted on the chain
Withdraw reward balance
Escrows eth and XYO to ensure that it covers the answer mining cost
Stores the new request in the request pool and emits the submission
Submits a new block at the consensus blockchain, with a verified stake over 51% and returns weiMining for successful creation.
uint memory _requests
bytes memory responses
address memory signers
bytes32 memory sigR
bytes32 memory sigS
uint8 memory sigV
A method to view the number of requests in the consensus block
A method to view the number of blocks in the consensus chain
- A Payment on delivery contract, check out our Payable On Delivery Demo to see how it works
- This contract is upgradeable
Called by the client to request an intersection question (is the item delivered?)
address payable beneficiary
Called by SCSC, if there is an intersection, executes a transfer to beneficiary and deletes the request from the request pool
bytes memory responseData
This contract is called in
submitResponsewith the request Id and who needs to be paid. In the
submitResponsecontract that is the beneficiary. This contract is a refunding mechanism that is utilized as a payment mechanism upon successful completion of a request/response.
address payable payee
Gets the number of requests currently in play
- Kevin Weiler
- Phillip Lorenzo
If you'd like to contribute to the SCSC as a developer or just run the project from source the directions below should help you get started.
First, clone the repository. And set the branch to the develop branch
git clone -b develop https://github.com/XYOracleNetwork/dapp-scsc-solidity
Then change working directory to that of the repository
After installing, go ahead and open in your favorite text editor, ours is Visual Studio Code
➜ dapp-scsc-solidity code .
Execute these truffle steps:
Set up a local Ganache instance
ganache-cli --port 8545 --deterministic < if you want to set the networkID --networkId idNumber>
Using the deterministic flag is a good way to keep consistent when in
keep this terminal window open!
In another terminal window (or tab)
Compile the contracts
Migrate the contracts
You will see transactions for each contract in your Ganache instance and their addressess
Test the contracts
Ganache will work again executing transactions while executing the unit tests.
Note if you did not
migrate, no worries, this command will do that for you.
We recommend testing after any revisions you make to contracts.
Package developed using ZeppelinOS