stellar

Documentation

Index

• Constants
• Variables
• func Checksum(data []byte) []byte
• func Decode(expected VersionByte, src string) ([]byte, error)
• func Encode(version VersionByte, src []byte) (string, error)
• func GenerateAssetId(assetKey string) crypto.Hash
• func IsValidEd25519PublicKey(i any) bool
• func IsValidEd25519SecretSeed(i any) bool
• func MustDecode(expected VersionByte, src string) []byte
• func MustEncode(version VersionByte, src []byte) string
• func Validate(data []byte, expected []byte) error
• func VerifyAddress(address string) error
• func VerifyAssetKey(assetKey string) error
• func VerifyTransactionHash(hash string) error
• type VersionByte
  • func DecodeAny(src string) (VersionByte, []byte, error)
  • func Version(src string) (VersionByte, error)

Constants

const (
	//VersionByteAccountID is the version byte used for encoded stellar addresses
	VersionByteAccountID VersionByte = 6 << 3 // Base32-encodes to 'G...'

	//VersionByteSeed is the version byte used for encoded stellar seed
	VersionByteSeed = 18 << 3 // Base32-encodes to 'S...'

	//VersionByteMuxedAccounts is the version byte used for encoded stellar multiplexed addresses
	VersionByteMuxedAccount = 12 << 3 // Base32-encodes to 'M...'

	//VersionByteHashTx is the version byte used for encoded stellar hashTx
	//signer keys.
	VersionByteHashTx = 19 << 3 // Base32-encodes to 'T...'

	//VersionByteHashX is the version byte used for encoded stellar hashX
	//signer keys.
	VersionByteHashX = 23 << 3 // Base32-encodes to 'X...'
)

Variables

var (
	StellarChainBase string
	StellarChainId   crypto.Hash
)

var ErrInvalidChecksum = errors.New("invalid checksum")

ErrInvalidChecksum is returned when Validate determines either the checksum or the payload has been corrupted

var ErrInvalidVersionByte = errors.New("invalid version byte")

ErrInvalidVersionByte is returned when the version byte from a provided strkey-encoded string is not one of the valid values.

Functions

func Checksum

func Checksum(data []byte) []byte

Checksum returns the 2-byte checksum for the provided data

func Decode

func Decode(expected VersionByte, src string) ([]byte, error)

Decode decodes the provided StrKey into a raw value, checking the checksum and ensuring the expected VersionByte (the version parameter) is the value actually encoded into the provided src string.

func Encode

func Encode(version VersionByte, src []byte) (string, error)

Encode encodes the provided data to a StrKey, using the provided version byte.

func GenerateAssetId

func GenerateAssetId(assetKey string) crypto.Hash

func IsValidEd25519PublicKey

func IsValidEd25519PublicKey(i any) bool

IsValidEd25519PublicKey validates a stellar public key

func IsValidEd25519SecretSeed

func IsValidEd25519SecretSeed(i any) bool

IsValidEd25519SecretSeed validates a stellar secret key

func MustDecode

func MustDecode(expected VersionByte, src string) []byte

MustDecode is like Decode, but panics on error

func MustEncode

func MustEncode(version VersionByte, src []byte) string

MustEncode is like Encode, but panics on error

func Validate

func Validate(data []byte, expected []byte) error

Validate returns an error if the provided checksum does not match the calculated checksum of the provided data

func VerifyAddress

func VerifyAddress(address string) error

func VerifyAssetKey

func VerifyAssetKey(assetKey string) error

func VerifyTransactionHash

func VerifyTransactionHash(hash string) error

Types

type VersionByte

type VersionByte byte

VersionByte represents one of the possible prefix values for a StrKey base string--the string the when encoded using base32 yields a final StrKey.

func DecodeAny

func DecodeAny(src string) (VersionByte, []byte, error)

DecodeAny decodes the provided StrKey into a raw value, checking the checksum and if the version byte is one of allowed values.

func Version

func Version(src string) (VersionByte, error)

Version extracts and returns the version byte from the provided source string.