Docs
synchronous
sign

Description

Send a request to sign a transaction.

💡

This method will only SIGN the proposed transaction. This method will not submit anything to the XRP Ledger, and should be considered incomplete. If you would like to complete the transaction, refer to sumbit with the signed tx blob.

Usage

  sdk.sign(tx: AllTransactionRequest, opts?: SignOpts)

Parameters

tx: AllTransactionRequest;

See here (opens in a new tab) for AllTransactionRequest typing.

opts?: { description?: string }

See here (opens in a new tab) for SignOpts typing.

Response

id: string;

Example

let id = sdk.sign({
  TransactionType: 'Payment',
  Account: 'rUmoi1vt8apeKsqFYKMRSiMvWixFDMC8Jz',
  Destination: 'rK8jihXBZCFWZqX95SET3CCi1WdRgZQwex',
  Amount: '1000000', // XRP in drops
});
 
console.log(id);
// eb29dcab-2bbd-4f4f-ad46-fc33359c6453
signInsubmit