README
¶
bech32
Package bech32 provides a Go implementation of the bech32 format specified in BIP 173.
Test vectors from BIP 173 are added to ensure compatibility with the BIP.
Installation and Updating
$ go get -u github.com/btcsuite/btcutil/bech32
Examples
- Bech32 decode Example Demonstrates how to decode a bech32 encoded string.
- Bech32 encode Example Demonstrates how to encode data into a bech32 string.
License
Package bech32 is licensed under the copyfree ISC License.
Documentation
¶
Overview ¶
Package bech32 reference implementation for Bech32 and segwit addresses. Copyright (c) 2017 Takatoshi Nakagawa
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Index ¶
- Variables
- func Base58ToBech32Address(addr string) (string, error)
- func Bech32ToBase58Addr(hrp, addr string) (string, error)
- func ByteArrToInt(input []byte) []int
- func CheckCheckSum(wif string) error
- func Decode(bechString string) (string, []int, error)
- func Encode(hrp string, data []int) (string, error)
- func ExportToQrCode(secret string, path string) error
- func GetNewp2wpkh() (string, error)
- func PrivKeyToWIF(network string, compressed bool, privkey []byte) (string, error)
- func SegwitAddrDecode(hrp, addr string) (int, []int, error)
- func SegwitAddrEncode(hrp string, version int, program []int) (string, error)
- func WIFToPrivateKey(wif string, compressed bool) ([]byte, error)
Constants ¶
This section is empty.
Variables ¶
var Curve *btcec.KoblitzCurve = btcec.S256()
var SegwitVersion = 0
Functions ¶
func Base58ToBech32Address ¶
func Bech32ToBase58Addr ¶
func ByteArrToInt ¶
func CheckCheckSum ¶
func Decode ¶
Decode decodes bechString(Bech32) returns hrp(human-readable part) and data(32bit data array) / or error
func Encode ¶
Encode encodes hrp(human-readable part) and data(32bit data array), returns Bech32 / or error if hrp is uppercase, return uppercase Bech32
func ExportToQrCode ¶
func GetNewp2wpkh ¶
func PrivKeyToWIF ¶
func SegwitAddrDecode ¶
SegwitAddrDecode decodes hrp(human-readable part) Segwit Address(string), returns version(int) and data(bytes array) / or error
func SegwitAddrEncode ¶
SegwitAddrEncode encodes hrp(human-readable part) , version(int) and data(bytes array), returns Segwit Address / or error
Types ¶
This section is empty.
Source Files