Rubicon Protocol
An Open Order Book Protocol for Ethereum
Welcome to the Rubicon Docs!
For Users and Casually Interested Readers
Check out our FAQ to see common questions about Rubicon. Our team will continue adding more resources to these docs to make learning about Rubicon even easier! If you need support, please go to the #support channel in our Discord server.
For Developers
Here you will find technical documentation for the Rubicon protocol. This includes:
- Dedicated pages for each of Rubicon's contracts (e.g. Rubicon Market) with an outline of key functions and parameters within each respective smart contract
- A list of Rubicon Protocol Deployments with contract addresses
- A list of Audits on the Rubicon Protocol
- Instructions for starting the Rubicon Protocol locally
What is Rubicon?
The Rubicon Protocol is a decentralized exchange protocol on the Ethereum blockchain. It enables the peer-to-peer exchange of ERC20 tokens. On the Rubicon protocol, you can trade cryptocurrencies like ETH and WBTC, stablecoins like USDC or DAI, governance tokens like COMP or AAVE, or anything in between!
Our hope is that the Rubicon protocol can replace traditional intermediaries and costly third parties with open-source code in order to democratize, open, and accelerate global financial markets. This is achieved through the deployment, development, and management of the Rubicon protocol's smart contracts, which are described throughout these docs.
The Rubicon App is a simple web application for users to interact with and trade on the Rubicon protocol. Our development company built the Rubicon App so you do not have to manually interact with Rubicon's smart contracts using bytecode.
Rubicon will utilize layer 2 scaling solutions for increased transaction throughput and reduced transaction fees. The first scaling solution Rubicon will launch on is Optimism. If you are interested in learning more, developing on the Rubicon protocol, joining the core team, or just want to reach us send a note to [email protected].
Protocol Overview
There are a number of key smart contracts that facilitate the operations of the Rubicon protocol. Please see below for an overview of our current smart contract infrastructure.
Rubicon Protocol Structure
At a high level, Rubicon revolves around a core smart contract (RubiconMarket.sol) that facilitates the peer-to-peer exchange of digital assets. Additionally, Rubicon Pools has its own system of smart contracts that enables users to provide passive liquidity on the Rubicon order books.
Developers: Start Rubicon Protocol Locally
1
$ git clone https://www.github.com/RubiconDeFi/rubicon_protocol.git
2
$ cd rubicon_protocol && npm i
3
$ npm i --save-dev [email protected]
4
$ truffle init
5
$ 'n' for overwriting contracts
6
$ 'n' for overwriting migrations
7
$ (in separate terminal) ganache-cli
Copied!
Also make sure that you comment out the lines in truffle-config.js that say 'development: ' and include localhost under networks so that you can connect to Ganache.
1
$ truffle migrate -- deploys contracts to development network, i.e. localhost
2
$ truffle test -- run the set of tests provided in the test folder of repo
Copied!
Last modified 2mo ago