Implement the logic of Bancor protocol.
Switch branches/tags
Clone or download
Latest commit 5f247bc May 30, 2018
Permalink
Failed to load latest commit information.
bin hello! Dec 12, 2017
lib Bump up version Dec 19, 2017
spec test Feb 15, 2018
.gitignore hello! Dec 12, 2017
.rspec hello! Dec 12, 2017
.travis.yml travis Feb 15, 2018
CODE_OF_CONDUCT.md hello! Dec 12, 2017
Gemfile hello! Dec 12, 2017
Gemfile.lock Bump up version Dec 19, 2017
LICENSE.txt hello! Dec 12, 2017
README.md fixed resources May 30, 2018
Rakefile hello! Dec 12, 2017
bancor.gemspec hello! Dec 12, 2017

README.md

Bancor

Gem Build Status

Implement the logic of Bancor protocol.

Installation

Add this line to your application's Gemfile:

gem 'bancor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bancor

Usage

issue/destroy by reserve token

irb(main):008:0> bp = Bancor::Protocol.new(eth: 300000, rate: 1, crr: 0.2)
=> #<Bancor::Protocol:0x00007f93039bd410 @total_supply=300000, @reserved_token=60000.0, @price=1.0, @crr=0.2>

irb(main):009:0> bp.issue_by_reserve_token 300
=> 299.40179372385245

irb(main):010:0> bp
=> #<Bancor::Protocol:0x00007f93039bd410 @total_supply=300299.40179372387, @reserved_token=60300.0, @price=1.003998003989035, @crr=0.2>

irb(main):011:0> bp.issue_by_reserve_token 700
=> 693.9974382206417

irb(main):012:0> bp
=> #<Bancor::Protocol:0x00007f93039bd410 @total_supply=300993.3992319445, @reserved_token=61000.0, @price=1.0133112579155532, @crr=0.2>

irb(main):013:0> bp.destroy_by_reserve_token 1302
=> 1307.966524590907

irb(main):014:0> bp
=> #<Bancor::Protocol:0x00007f93039bd410 @total_supply=299691.3992319445, @reserved_token=59692.033475409095, @price=0.9958916677019946, @crr=0.2>

irb(main):015:0> bp.issue_by_reserve_token 100
=> 100.34530853232869

irb(main):016:0> bp
=> #<Bancor::Protocol:0x00007f93039bd410 @total_supply=299791.7445404769, @reserved_token=59792.033475409095, @price=0.9972261505575943, @crr=0.2>

issue/destroy by smart token

irb(main):015:0> bp = Bancor::Protocol.new(eth: 300000, rate: 1, crr: 0.2)
=> #<Bancor::Protocol:0x00007fb14b0169f0 @total_supply=300000, @reserved_token=60000.0, @price=1.0, @crr=0.2>

irb(main):016:0> bp.issue_by_smart_token 50
=> 0.0

irb(main):017:0> bp
=> #<Bancor::Protocol:0x00007fb14b0169f0 @total_supply=300050, @reserved_token=60000.0, @price=0.9998333611064822, @crr=0.2>

irb(main):018:0> bp.issue_by_smart_token 100
=> 0.0

irb(main):019:0> bp
=> #<Bancor::Protocol:0x00007fb14b0169f0 @total_supply=300150, @reserved_token=60000.0, @price=0.9995002498750625, @crr=0.2>

irb(main):020:0> bp.destroy_by_smart_token 100
=> 0.0

irb(main):021:0> bp
=> #<Bancor::Protocol:0x00007fb14b0169f0 @total_supply=300050, @reserved_token=60000.0, @price=0.9998333611064822, @crr=0.2>

irb(main):022:0> bp.destroy_by_smart_token 50
=> 0.0

irb(main):023:0> bp
=> #<Bancor::Protocol:0x00007fb14b0169f0 @total_supply=300000, @reserved_token=60000.0, @price=1.0, @crr=0.2>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kurotaky/bancor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Bancor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.