binarycodec

Documentation

Index

• Variables
• func Decode(hexEncoded string) (map[string]any, error)
• func DecodeBinary(b []byte) (map[string]any, error)
• func Encode(tx transactions.Tx) (string, error)
• func EncodeForMultisigning(tx transactions.Tx, xrpAccountID string) ([]byte, error)
• func EncodeForSigning(tx transactions.Tx) ([]byte, error)
• func EncodeForSigningClaim(tx transactions.PaymentChannelClaim) ([]byte, error)

Variables

var ErrSigningClaimFieldNotFound = errors.New("'Channel' & 'Amount' fields are both required, but were not found")

Functions

func Decode

func Decode(hexEncoded string) (map[string]any, error)

Decode decodes a hex string in the canonical binary format into a JSON transaction object.

func DecodeBinary

func DecodeBinary(b []byte) (map[string]any, error)

DeocdeBinary decodes canonical binary format into JSON transition object

func Encode

func Encode(tx transactions.Tx) (string, error)

Encode converts a JSON transaction object to a hex string in the canonical binary format. The binary format is defined in XRPL's core codebase.

func EncodeForMultisigning

func EncodeForMultisigning(tx transactions.Tx, xrpAccountID string) ([]byte, error)

EncodeForMultiSign: encodes a transaction into binary format in preparation for providing one signature towards a multi-signed transaction. (Only encodes fields that are intended to be signed.)

func EncodeForSigning

func EncodeForSigning(tx transactions.Tx) ([]byte, error)

Encodes a transaction into binary format in preparation for signing.

func EncodeForSigningClaim

func EncodeForSigningClaim(tx transactions.PaymentChannelClaim) ([]byte, error)

EncodeForPaymentChannelClaim: encodes a payment channel claim into binary format in preparation for signing.