On this page

Transactions

Call enable() before using the dApp API. Addresses returned by the CIP-30 API are hex-encoded bytes; transaction and value parameters are hex-encoded CBOR. Browser examples using Buffer require an explicit buffer import or a byte conversion helper.

Learn how to sign and submit transactions on Cardano.

Sign Transaction


// transaction should be CBOR-encoded hex string
const witnessSetCbor = await api.signTx(transactionCbor, partialSign)
 
// partialSign: boolean
// - false: reject if the wallet cannot provide every required signature
// - true: return the signatures the wallet can provide
 
console.log('Witness set:', witnessSetCbor)

Submit Transaction


// Submit signed transaction
const txHash = await api.submitTx(signedTransactionCbor)
console.log('Transaction hash:', txHash)

Build, sign, and submit

signTx returns a witness set, not a complete signed transaction. Build the unsigned transaction with a Cardano transaction library, merge the returned witnesses with its existing witness set, and submit the resulting complete transaction.


// `unsignedTransactionCbor` is a complete transaction built with current
// protocol parameters, selected inputs, outputs, fees, and change.
const witnessSetCbor = await api.signTx(unsignedTransactionCbor, false)
// Merge witnessSetCbor into the original transaction using your Cardano SDK.
// Preserve existing witnesses, scripts, datums, redeemers, and auxiliary data.
// Submit the serialized complete transaction, never witnessSetCbor alone.
const txHash = await api.submitTx(completeSignedTransactionCbor)

Use the Lucid or Mesh flow below if your application does not already implement transaction construction and witness merging. These SDK examples are version-specific; follow their documentation for the version you install.

Using with Lucid

Lucid provides a simpler API:


npm install lucid-cardano


import { Lucid, Blockfrost } from 'lucid-cardano'
 
// Initialize Lucid with OneKey
const lucid = await Lucid.new(
  new Blockfrost('https://cardano-mainnet.blockfrost.io/api', 'your-api-key'),
  'Mainnet'
)
 
// Connect OneKey
const api = await window.cardano.onekey.enable()
lucid.selectWallet(api)
 
// Send ADA
const tx = await lucid
  .newTx()
  .payToAddress('addr1...', { lovelace: 5000000n })
  .complete()
 
const signedTx = await tx.sign().complete()
const txHash = await signedTx.submit()
 
console.log('TX Hash:', txHash)

Using with Mesh

Mesh is another popular Cardano SDK:


npm install @meshsdk/core


import { BrowserWallet, Transaction } from '@meshsdk/core'
 
// Connect to OneKey
const wallet = await BrowserWallet.enable('onekey')
 
// Get wallet info
const balance = await wallet.getBalance()
const addresses = await wallet.getUsedAddresses()
 
// Build and send transaction
const tx = new Transaction({ initiator: wallet })
  .sendLovelace('addr1...', '5000000')
 
const unsignedTx = await tx.build()
const signedTx = await wallet.signTx(unsignedTx)
const txHash = await wallet.submitTx(signedTx)