Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keisukeyamashita/go-btcrpc
A simple JSON-RPC package for Bitcoin.
https://github.com/keisukeyamashita/go-btcrpc
bitcoin bitcoin-node blockchain go goconvey golang json-rpc
Last synced: 23 days ago
JSON representation
A simple JSON-RPC package for Bitcoin.
- Host: GitHub
- URL: https://github.com/keisukeyamashita/go-btcrpc
- Owner: KeisukeYamashita
- License: apache-2.0
- Created: 2017-12-12T23:42:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-01T20:23:47.000Z (over 6 years ago)
- Last Synced: 2024-10-04T15:55:33.404Z (about 1 month ago)
- Topics: bitcoin, bitcoin-node, blockchain, go, goconvey, golang, json-rpc
- Language: Go
- Homepage: https://godoc.org/github.com/KeisukeYamashita/go-btcrpc
- Size: 40 KB
- Stars: 14
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-btcrpc
[](https://github.com/ellerbrock/open-source-badges/)
[](https://godoc.org/github.com/KeisukeYamashita/go-btcrpc)
[](https://opensource.org/licenses/Apache-2.0)
[](https://circleci.com/gh/KeisukeYamashita/go-btcrpc)
[](https://inspecode.rocro.com/jobs/github.com/KeisukeYamashita/go-btcrpc/latest?completed=true)
[](https://inspecode.rocro.com/reports/github.com/KeisukeYamashita/go-btcrpc/branch/master/summary)
go-btcrpc is a Go library use for interacting to the bitcoin node from your server with JSON-RPC which is a standard protocol for blockchain.
This library provides the easiest way to send JSON-RPC.
## Installation
Use go get to install and update.
```
go get github.com/KeisukeYamashita/go-btcrpc.git
```
## Setup
You need to setup environmental variables.
Firstly, copy the `.env.sample` as `.env`
```
cp .env.sample .env
```
Setup in your `.env`.
```
BTCD_ENDPOINT: NODE_ENDPOINT
USERNAME: USERNAME_FOR_BASICAUTH
PASSWORD: PASSWORD_FOR_BASICAUTH
```
## Usage and Example
This shows you that easiest request to the node which is getting the infos.
```go
package main
import (
"fmt"
btcrpc "github.com/KeisukeYamashita/go-btcrpc"
)
func main() {
basicAuth := &BasicAuth{
Username: os.Getenv("USERNAME"),
Password: os.Getenv("PASSWORD"),
}
c := NewRPCClient(os.Getenv("BTCD_ENDPOINT"), basicAuth)
address := "my88QLpf2RYYDdNMmDwYvfx6TFc6NXaELa"
balance := c.GetBalance(address)
fmt.Print(balance) // 0.13514 BTC
}
```
### Equal curl command
```
curl -X "POST" "" \
-H 'Content-Type: application/json; charset=utf-8' \
-u ':' \
-d $'{
"method": "getbalance",
"id": "1",
"params": [
"my88QLpf2RYYDdNMmDwYvfx6TFc6NXaELa"
]
}'
```
It'll return a JSON.
### Available Methods
| method| discription |
|:----:|:----:|
| getNewAddress | creates a new address to your account. |
| getBalance | get the balance of your address. |
| getBlockHash | get the hash of the block. |
| getBlock | get the block by hash of the block. |
| getBlockCount | get the newest block count by hash of the block. |
| decodeTransaction | decode the raw transaction to humanreadable transaction by hash of the block. |
| getrawTransaction | get the raw transaction hash block count by hash of the block. |
## Use tests
Set up your environmental valiables in `.env` to conduct this test.
```
cp .env.sample .env
```
Then write in your endpoint in this file.
Finally run your test. It will pass if your bitcoin node is setted up correctly.
```
GO_ENV = test go test btcrpc
```
## Contribution
To contribute, just send me a pull request!
If it is valid, you will be added on the contribution doc in `/doc/contributor.md` .
## License
Copyright 2017 Keisuke Yamashita.
Licensed under the Apache 2.0 license.