# README
Binary Codec
This package contains functions to encode/decode to/from the ripple binary serialization format.
API
Encode
encoded, err := binarycodec.Encode(jsonObject)
Decode
json, err := binarycodec.Decode(hexEncodedString)
EncodeForMultisigning
encoded, err := binarycodec.EncodeForMultisigning(jsonObject, xrpAccountID)
EncodeForSigning
encoded, err := binarycodec.EncodeForSigning(jsonObject)
EncodeForSigningClaim
encoded, err := binarycodec.EncodeForSigningClaim(jsonObject)
EncodeQuality
encoded, err := binarycodec.EncodeQuality(amountString)
DecodeQuality
decoded, err := binarycodec.DecodeQuality(encoded)
DecodeLedgerData
ledgerData, err := binarycodec.DecodeLedgerData(hexEncodedString)
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
Decode decodes a hex string in the canonical binary format into a JSON transaction object.
DecodeLedgerData decodes a hex string in the canonical binary format into a LedgerData object.
Decode a quality amount from a hex string to a string.
Encode converts a JSON transaction object to a hex string in the canonical binary format.
EncodeForMultiSign: encodes a transaction into binary format in preparation for providing one signature towards a multi-signed transaction.
Encodes a transaction into binary format in preparation for signing.
EncodeForPaymentChannelClaim: encodes a payment channel claim into binary format in preparation for signing.
EncodeQuality encodes a quality amount to a hex string.
# Variables
ErrInvalidQuality is returned when the quality is invalid.
ErrSigningClaimFieldNotFound is returned when the 'Channel' & 'Amount' fields are both required, but were not found.
# Structs
LedgerData represents the data of a ledger.