bech32

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

• func Decode(bechString string) (string, []int, error)
• func Encode(hrp string, data []int) (string, error)
• func SegwitAddrDecode(hrp, addr string) (int, []int, error)
• func SegwitAddrEncode(hrp string, version int, program []int) (string, error)

Functions

func Decode

func Decode(bechString string) (string, []int, error)

Decode decodes bechString(Bech32) returns hrp(human-readable part) and data(32bit data array) / or error

func Encode

func Encode(hrp string, data []int) (string, error)

Encode encodes hrp(human-readable part) and data(32bit data array), returns Bech32 / or error if hrp is uppercase, return uppercase Bech32

func SegwitAddrDecode

func SegwitAddrDecode(hrp, addr string) (int, []int, error)

SegwitAddrDecode decodes hrp(human-readable part) Segwit Address(string), returns version(int) and data(bytes array) / or error

func SegwitAddrEncode

func SegwitAddrEncode(hrp string, version int, program []int) (string, error)

SegwitAddrEncode encodes hrp(human-readable part) , version(int) and data(bytes array), returns Segwit Address / or error