nano

Documentation

Overview

Package nano provides a number of useful types for Nano like Address and Balance. The actual implementation of the Nano protocol an be found in sub-packages.

Index

• Constants
• Variables
• type Address
  • func ParseAddress(s string) (Address, error)
  • func (a Address) Checksum() []byte
  • func (a Address) MarshalText() ([]byte, error)
  • func (a Address) String() string
  • func (a *Address) UnmarshalText(text []byte) error
  • func (a Address) Verify(data []byte, signature []byte) bool
• type Balance
  • func ParseBalance(s string, unit string) (Balance, error)
  • func ParseBalanceInts(hi uint64, lo uint64) Balance
  • func (b Balance) Add(n Balance) Balance
  • func (b Balance) BigInt() *big.Int
  • func (b Balance) Bytes(order binary.ByteOrder) []byte
  • func (b Balance) Compare(n Balance) BalanceComp
  • func (b Balance) Equal(b2 Balance) bool
  • func (b Balance) MarshalBinary() ([]byte, error)
  • func (b Balance) MarshalText() ([]byte, error)
  • func (b Balance) String() string
  • func (b Balance) Sub(n Balance) Balance
  • func (b Balance) UnitString(unit string, precision int32) string
  • func (b *Balance) UnmarshalBinary(data []byte) error
  • func (b *Balance) UnmarshalText(text []byte) error
• type BalanceComp

Constants

const (
	// AddressLen represents the string length of a Nano address.
	AddressLen = 64
	// AddressSize represents the binary size of a Nano address (a public key).
	AddressSize = ed25519.PublicKeySize
	// AddressPrefix is the prefix of Nano addresses.
	AddressPrefix = "ban_"

	// AddressEncodingAlphabet is Nano's custom alphabet for base32 encoding
	AddressEncodingAlphabet = "13456789abcdefghijkmnopqrstuwxyz"
)

const (
	// BalanceSize represents the size of a balance in bytes.
	BalanceSize         = 16
	BalanceMaxPrecision = 33
)

Variables

var (
	// AddressEncoding is a base32 encoding using NanoEncodingAlphabet as its
	// alphabet.
	AddressEncoding = base32.NewEncoding(AddressEncodingAlphabet)

	ErrAddressLen      = errors.New("bad address length")
	ErrAddressPrefix   = errors.New("bad address prefix")
	ErrAddressEncoding = errors.New("bad address encoding")
	ErrAddressChecksum = errors.New("bad address checksum")
)

var (
	ZeroBalance = Balance(uint128.Uint128{})

	ErrBadBalanceSize = errors.New("balances should be 16 bytes in size")
)

Types

type Address

type Address [AddressSize]byte

Address represents a Nano address.

func ParseAddress

func ParseAddress(s string) (Address, error)

ParseAddress parses the given Nano address string to a public key.

func (Address) Checksum

func (a Address) Checksum() []byte

Checksum calculates the checksum for this address' public key.

func (Address) MarshalText

func (a Address) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (Address) String

func (a Address) String() string

String implements the fmt.Stringer interface.

func (*Address) UnmarshalText

func (a *Address) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

func (Address) Verify

func (a Address) Verify(data []byte, signature []byte) bool

Verify reports whether the given signature is valid for the given data.

type Balance

type Balance uint128.Uint128

func ParseBalance

func ParseBalance(s string, unit string) (Balance, error)

ParseBalance parses the given balance string.

func ParseBalanceInts

func ParseBalanceInts(hi uint64, lo uint64) Balance

func (Balance) Add

func (b Balance) Add(n Balance) Balance

func (Balance) BigInt

func (b Balance) BigInt() *big.Int

func (Balance) Bytes

func (b Balance) Bytes(order binary.ByteOrder) []byte

Bytes returns the binary representation of this Balance with the given endianness.

func (Balance) Compare

func (b Balance) Compare(n Balance) BalanceComp

func (Balance) Equal

func (b Balance) Equal(b2 Balance) bool

Equal reports whether this balance and the given balance are equal.

func (Balance) MarshalBinary

func (b Balance) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (Balance) MarshalText

func (b Balance) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface.

func (Balance) String

func (b Balance) String() string

String implements the fmt.Stringer interface. It returns the balance in Mxrb with maximum precision.

func (Balance) Sub

func (b Balance) Sub(n Balance) Balance

func (Balance) UnitString

func (b Balance) UnitString(unit string, precision int32) string

UnitString returns a decimal representation of this uint128 converted to the given unit.

func (*Balance) UnmarshalBinary

func (b *Balance) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

func (*Balance) UnmarshalText

func (b *Balance) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type BalanceComp

type BalanceComp byte

const (
	BalanceCompEqual BalanceComp = iota
	BalanceCompBigger
	BalanceCompSmaller
)