Skip to content
This repository has been archived by the owner on Oct 28, 2023. It is now read-only.

Latest commit

 

History

History
54 lines (33 loc) · 1.61 KB

README.md

File metadata and controls

54 lines (33 loc) · 1.61 KB
Raw

secp256k1

Crystal bindings for the Bitcoin Core implementation of secp256k1 library.

Prerequisites

Applications that using these bindings must have access to the installed libsecp256k1 library.

Since these bindings are designed for the Bitcoin Core implementation, there is no guarantee of working with others.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  secp256k1:
    github: qualterz/secp256k1.cr

  2. Run shards install

Usage

require "secp256k1"

Documentation

In case of using native bindings, original examples and documentation can be used for reference.

Deprecated library functions will not be wrapped, so if there is need to use them, they can be used natively.

Development

The bindings are generated automatically by executing make generate_lib shell command.

The libgen is used as a bindings generator.

Contributing

  1. Fork it (https://github.com/qualterz/secp256k1.cr/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors