Skip to main content

hash

Overview​

The hash package contains functions for hashing XRPL transactions.

  • SignTxBlob: Hashes a signed transaction blob. It accepts a signed transaction blob as input and returns the transaction's hash. This is mainly used for verifying transaction integrity, including multisigned transactions.

  • SignTx: Hashes a signed transaction provided as a decoded map object. Primarily used internally for batch transactions within the wallet.

Usage​

To import the package, you can use the following code:

import "github.com/Peersyst/xrpl-go/xrpl/hash"

API​

SignTxBlob​

func SignTxBlob(txBlob string) (string, error)

Hashes a signed transaction blob and returns the transaction hash as an uppercase hexadecimal string, or an error if the blob is invalid.

The transaction must use one complete signing form. A single-signed transaction requires SigningPubKey and TxnSignature. A multisigned transaction requires Signers and an explicitly empty top-level SigningPubKey. Partial, empty, or mixed signing structures return an error.

Inner Batch transactions are hashable only in their canonical unsigned form with an explicitly empty SigningPubKey and no TxnSignature or Signers. Consensus-generated EnableAmendment, SetFee, and UNLModify pseudo-transactions can be hashed without account signatures.

SignTx​

func SignTx(tx map[string]any) (string, error)

Hashes a signed transaction provided as a decoded map and returns the transaction hash or an error if the transaction object is invalid. It applies the same canonical signing-form checks as SignTxBlob and does not modify the input map.