Categorygithub.com/kiteshi/go-bitcoin-core-rpc
modulepackage
0.0.0-20200415141154-3edb7a963844
Repository: https://github.com/kiteshi/go-bitcoin-core-rpc.git
Documentation: pkg.go.dev

# README

go-bitcoin-core-rpc

ISC License GoDoc

rpcclient implements a Bitcoin Core JSON-RPC client package written in Go. It provides a robust and easy to use client for interfacing with a Bitcoin RPC server.

Status

This package is currently under active development. It is already stable and the infrastructure is complete. However, there are still several RPCs left to implement and the API is not stable yet.

Documentation

  • API Reference
  • Example Connects to a bitcoin Core RPC server using HTTP POST mode with TLS disabled and gets the current block count.

Major Features

  • Translates to and from higher-level and easier to use Go types
  • Offers a synchronous (blocking) and asynchronous API

Installation

$ go get -u github.com/KiteShi/go-bitcoin-core-rpc

License

Package rpcclient is licensed under the copyfree ISC License.

# Packages

No description provided by the author

# Functions

DisableLog disables all library log output.
New creates a new RPC client based on the provided connection configuration details.
UseLogger uses a specified Logger to output package logging info.

# Constants

ANAdd indicates the specified host should be added as a persistent peer.
ANOneTry indicates the specified host should try to connect once, but it should not be made persistent.
ANRemove indicates the specified peer should be removed.
SigHashAll indicates ALL of the outputs should be signed.
SigHashAllAnyoneCanPay indicates that signer does not care where the other inputs to the transaction come from, so it allows other people to add inputs.
SigHashNone indicates NONE of the outputs should be signed.
SigHashNoneAnyoneCanPay indicates that signer does not care where the other inputs to the transaction come from, so it allows other people to add inputs.
SigHashSingle indicates that a SINGLE output should be signed.
SigHashSingleAnyoneCanPay indicates that signer does not care where the other inputs to the transaction come from, so it allows other people to add inputs.

# Variables

ErrClientShutdown is an error to describe the condition where the client is either already shutdown, or in the process of shutting down.

# Structs

Client represents a Bitcoin RPC client which allows easy access to the various RPC methods available on a Bitcoin RPC server.
ConnConfig describes the connection configuration parameters for the client.

# Type aliases

AddNodeCommand enumerates the available commands that the AddNode function accepts.
SigHashType enumerates the available signature hashing types that the SignRawTransaction function accepts.