Skip to content

Bitcoin SV library (basic tools, transaction signing, JSON-RPC client, MetaNet library, ...).

License

Notifications You must be signed in to change notification settings

slashrsm/bsv_rpc

Repository files navigation

Bitcoin SV JSON-RPC client

Build Status Coverage Status Inline docs Hex Version

A client library to talk to the JSON-RPC endpoint on a Bitcoin node (and much more! - check the ever expanding list of features below). The long term plan is to develop library into a fully-fledged Bitcoin library and split it into multiple libraries. It will stay in a single project for easier early stage development.

Warning: Library is under active development and will most likely keep changing in the foreseeable future.

Features

  • API to work with basic Bitcoin structures
    • Transactions
    • Transaction inputs
    • Transaction outputs
    • Addresses
    • Unspent transaction outputs (UTXOs)
    • Blocks
    • Scripts (TODO)
  • Base58Check API
  • Various helper functions
  • JSON-RPC client API (not complete, support for new methods added regularly)
  • MetaNet operations

Usage

In order to use the JSON-RPC client feature add :bsv_rpc to your applications:

def application do
  [applications: [:bsv_rpc]]
end

and add Bitcoin node connection configuration:

config :bsv_rpc, :node,
  hostname: "localhost",
  port: 8332,
  username: "someusername",
  password: "somepassword"

Alternatively you can run the client's GenServer process manually:

{:ok, pid} = BsvRpc.Client.start_link("someusername", "somepass", "localhost", 8332)

License

Copyright © 2019 Janez Urevc

This work is free. You can redistribute it and/or modify it under the terms of the MIT License. See the LICENSE file for more details.

About

Bitcoin SV library (basic tools, transaction signing, JSON-RPC client, MetaNet library, ...).

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages