Oyl Sdk

A comphrenesive sdk that features easy to use bitcoin functions to build and brodcast btc transactions.

Table of contents

• Oyl SDK
  • Table of contents
  • Installation
  • Usage
    • Running the tests
    • Using the cli
  • Contributing
  • Versioning
  • Authors
  • License

Installation

To install and set up the library, run:

$ git clone https://github.com/oyl-wallet/oyl-sdk.git
$ cd oyl-sdk
$ yarn install

Usage

Prerequisites

• Node.js >= 20
• yarn

Running the tests

$ yarn test

Using the CLI version

$ make reset

This does a fresh build of the lib directory which the cli uses after all the .ts files are compiled.

The name of the bin for the cli is called "oyl". If you want to invoke it without having the yarn prefix you need to add it globally. Run this command:

$ yarn global add oyl

You can also link the package so it updates as you make local changes:

$ yarn link

If you want the program to be isolated to only this enviornment use the local script provided to you like this:

$ yarn oyl --help

e.g. oyl utxos addressUtxos -a bcrt1qcr8te4kr609gcawutmrza0j4xv80jy8zeqchgx -p regtest. For more detailed instructions on how to use the cli, refer to the README.md found in the cli directory.

Documentation

Full documentation is available at https://alkanes.build/

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -m 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :sunglasses:

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Publishing to NPM

From root of oyl-sdk repo:

$ npm publish --access public

Authors

• Oyl Dynamics

See also the list of contributors who participated in this project.

License

MIT License