prepare

Concepts

Transactions

Behaviour

JavaScript

• This function takes a transaction JSON object and prepares it for emission.
• The transaction must be complete except for the Account field, which should always be the Hook account.

Definition

JavaScript

function prepare(
    txJson: Record<string, any> | Transaction
  ): ErrorCode | Record<string, any> | Transaction

Example

JavaScript

const prepared_txn = prepare({
                TransactionType: "Payment",
                Destination: util_raddr(p1address_ns),
                Amount: parseFloat(drops_sent)*2
            })

Parameters

JavaScript

Name	Type	Description
txJson	Record<string, any> | Transaction	The transaction JSON, must be a complete transaction except for Account (always the Hook account).

Return Code

JavaScript

Type	Description
ErrorCode | Record<string, any> | Transaction	Returns an ErrorCode if there is an error, or the prepared transaction JSON or Transaction object.