https://github.com/marselester/bitgo-v1
Go client for BitGo.com API v1
https://github.com/marselester/bitgo-v1
Last synced: about 1 month ago
JSON representation
Go client for BitGo.com API v1
- Host: GitHub
- URL: https://github.com/marselester/bitgo-v1
- Owner: marselester
- License: mit
- Created: 2017-11-05T04:48:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-18T11:06:36.000Z (over 6 years ago)
- Last Synced: 2024-06-20T11:59:26.072Z (11 months ago)
- Language: Go
- Size: 23.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go client for [BitGo.com API v1](https://bitgo.github.io/bitgo-docs/)
[](https://godoc.org/github.com/marselester/bitgo-v1)
[](https://goreportcard.com/report/github.com/marselester/bitgo-v1)
[](https://travis-ci.org/marselester/bitgo-v1)
This is unofficial API client. There are no plans to implement all resources.
## [List Wallet Unspents](https://bitgo.github.io/bitgo-docs/#list-wallet-unspents)
Gets a list of unspent input transactions for a wallet. For example, we want to request
`2N91XzUxLrSkfDMaRcwQhe9DauhZMhUoxGr` wallet's unspents `250` per API request and
print amounts in BTC. You can stop pagination by cancelling a `ctx` context.
```go
c := bitgo.NewClient(
bitgo.WithAccesToken("swordfish"),
)
params := url.Values{}
params.Set("limit", "250")
err := c.Wallet.Unspents(ctx, "2N91XzUxLrSkfDMaRcwQhe9DauhZMhUoxGr", params, func(list *bitgo.UnspentList) {
for _, utxo := range list.Unspents {
fmt.Printf("%0.8f\n", bitgo.ToBitcoins(utxo.Value))
}
})
```
There is a CLI program to list all unspensts of a wallet.
```sh
$ go build ./cmd/utxo/
$ ./utxo -token=swordfish -wallet=2N91XzUxLrSkfDMaRcwQhe9DauhZMhUoxGr -limit=250
0.00000117
0.00000001
0.00000001
0.00000562
0.00000001
0.00000562
```
You can use it to get a rough idea about unspents available in the wallet.
```sh
$ ./utxo -token=swordfish -wallet=2N91XzUxLrSkfDMaRcwQhe9DauhZMhUoxGr > unspents.txt
$ cat unspents.txt | sort | uniq -c | sort -n -r
3 0.00000001
2 0.00000562
1 0.00000117
```
## [Consolidate Wallet Unspents](https://bitgo.github.io/bitgo-docs/#consolidate-unspents)
This API call will consolidate bitcoins of `2NB5G2jmqSswk7C427ZiHuwuAt1GPs5WeGa` wallet using max `0.001` BTC unspents
with 1000 satoshis/kilobyte fee rate. You can stop consolidation by cancelling a `ctx` context.
```go
c := bitgo.NewClient(
bitgo.WithAccesToken("swordfish"),
)
tt, err := c.Wallet.Consolidate(ctx, "2NB5G2jmqSswk7C427ZiHuwuAt1GPs5WeGa", &bitgo.WalletConsolidateParams{
WalletPassphrase: "root",
MaxValue: 100000,
FeeRate: 1000,
})
if err != nil {
log.Fatalf("Failed to coalesce unspents: %v", err)
}
for _, tx := range tt {
fmt.Printf("Consolidated transaction ID: %s", tx.TxID)
}
```
There is a CLI program to consolidate unspensts of a wallet.
```sh
$ go build ./cmd/consolidate/
$ ./consolidate -token=swordfish -wallet=2NB5G2jmqSswk7C427ZiHuwuAt1GPs5WeGa -passphrase=root -max-value=0.001 -fee-rate=1000
50430eeffdd1272ff39d0d3667cbc8e60de0a8ea6bb118e6236e0964389e6d19
```
## Error Handling
Dave Cheney recommends
[asserting errors for behaviour](https://dave.cheney.net/2016/04/27/dont-just-check-errors-handle-them-gracefully), not type.
```go
package main
import (
"fmt"
"github.com/marselester/bitgo-v1"
"github.com/pkg/errors"
)
// IsUnauthorized returns true if err caused by authentication problem.
func IsUnauthorized(err error) bool {
e, ok := errors.Cause(err).(interface {
IsUnauthorized() bool
})
return ok && e.IsUnauthorized()
}
func main() {
err := bitgo.Error{Type: bitgo.ErrorTypeAuthentication}
fmt.Println(IsUnauthorized(err))
fmt.Println(IsUnauthorized(fmt.Errorf("")))
fmt.Println(IsUnauthorized(nil))
// Output: true
// false
// false
}
```
## Testing
Use [debug](https://dave.cheney.net/2014/09/28/using-build-to-switch-between-debug-and-release) tag
to enable API response logging.
```sh
$ go test -tags debug
```