# Ciri::Utils

Toolkit module of [Ciri](https://github.com/ciri-ethereum/ciri)

Functions include: big endian encode/decode, hex/bytes convert, keccak256 ...

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'ciri-utils'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ciri-utils

## Usage

``` ruby
# keccak256
Ciri::Utils.sha3("...")

# secret_compare
Ciri::Utils.sha3(password, secret)

# convert between hex and bytes
Ciri::Utils.to_bytes("0x...")
Ciri::Utils.to_hex("\x00...")

# big endian encode and decode
Ciri::Utils.big_endian_encode(200)
Ciri::Utils.big_endian_decode("....")

# ....
```

See source code to find other methods.

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ciri-utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [Apache License Version 2.0](http://www.apache.org/licenses/).

## Code of Conduct

Everyone interacting in the Ciri::Utils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ciri-utils/blob/master/CODE_OF_CONDUCT.md).