Swapy Exchange Protocol
NOTE: The protocol was previously created on a private repository. Since the beginning, we have thought about open sourcing the protocol as the community has much to contribute to it as well as the protocol and the source code may be helpful to other projects too. As the protocol achieved a certain level of maturity we decided to move it to a public repository under Apache 2.0 License (without its history). We invite you all to join us in our dream of a world in which everyone has ACCESS TO CREDIT. The Swapy team is looking forward to your comments, issues, contributions, derivations, and so on.
Table of Contents
The diagram below describes the flow of fundraising provided by Swapy Exchange protocol.
Credit companies can order investment by using the SwapyExchange contract. It works as a factory of InvestmentAsset contract and organizes the protocol versioning.
InvestmentAsset defines a fundraising asset with its value, investor and agreement terms hash. The business rules is delegated to AssetLibrary.
AssetLibrary centralizes the logical rules of an investment asset, like invest, cancel, refuse and return. These methods are only accessible by the investor or the credit company, according to its functionalities.
Install Node v8.9.1
Truffle is used for deployment. We run the version installed from our dependencies using npm scripts, but if you prefer to install it globally you can do:
$ npm install -g truffle
Install project dependencies:
$ npm install
For setup your wallet configuration, addresses and blockchain node provider to deploy, an environment file is necessary. We provide a
sample.env file. We recommend that you set up your own variables and rename the file to
export NETWORK_ID=... export DEV_NETWORK_ID=... export TOKEN_ADDRESS=... export PROVIDER_URL="https://yourfavoriteprovider.../..." export WALLET_MNEMONIC="twelve words mnemonic ... potato bread coconut pencil"
Use your own provider. Some known networks below:
NOTE: the current protocol version is not intended to be used on mainnet.
Use a NETWORK_ID that matches with your network:
- 0: Olympic, Ethereum public pre-release testnet
- 1: Frontier, Homestead, Metropolis, the Ethereum public main network
- 1: Classic, the (un)forked public Ethereum Classic main network, chain ID 61
- 1: Expanse, an alternative Ethereum implementation, chain ID 2
- 2: Morden, the public Ethereum testnet, now Ethereum Classic testnet
- 3: Ropsten, the public cross-client Ethereum testnet
- 4: Rinkeby, the public Geth Ethereum testnet
- 42: Kovan, the public Parity Ethereum testnet
- 7762959: Musicoin, the music blockchain
The value of TOKEN_ADDRESS depends on the network. We created the Swapy Token Faucet to distribute an ERC20 Token and support our testnet releases. Follow the repos description to use a deployed Token, e.g., Ropsten and Infura, or make your own deploy to another network.
After that, make available your environment file inside the bash context:
$ source .env
By using a local network, this lecture may be useful: Connecting to the network
Compile the contracts with truffle:
$ npm run compile
Run our migrations:
$ npm run migrate
We're running the contracts in a custom network defined in truffle.js.
After the transaction mining, the protocol is disponible for usage.
We're using Truffle's test support. The script scripts/test.sh creates a local network and calls the unit tests.
$ npm test
and run our tests.
Truffle console can be used to interact with protocol. For example:
$ truffle console --network custom
truffle(custom)> SwapyExchange.deployed().VERSION.call(); // "1.0.0"