@armada/sdk / index / BuildWitnessParams

Interface: BuildWitnessParams

Defined in: src/tx/witness.ts:116

Properties

inputs

readonly inputs: readonly WitnessInput[]

Defined in: src/tx/witness.ts:117

---

outputs

readonly outputs: readonly WitnessOutputRequest[]

Defined in: src/tx/witness.ts:118

---

tokenAddress

readonly tokenAddress: `0x${string}`

Defined in: src/tx/witness.ts:119

---

sender

readonly sender: WitnessSenderContext

Defined in: src/tx/witness.ts:120

---

signer

readonly signer: SpendSigner

Defined in: src/tx/witness.ts:121

---

summary

readonly summary: PlanSummary

Defined in: src/tx/witness.ts:123

The plan summary — forwarded to the signer as the fully-bound intent context.

---

merkleRoot

readonly merkleRoot: bigint

Defined in: src/tx/witness.ts:124

---

treeNumber

readonly treeNumber: number

Defined in: src/tx/witness.ts:125

---

chainType

readonly chainType: number

Defined in: src/tx/witness.ts:126

---

chainId

readonly chainId: number

Defined in: src/tx/witness.ts:127

---

minGasPrice?

readonly optional minGasPrice?: bigint

Defined in: src/tx/witness.ts:128

---

unshield?

readonly optional unshield?: number

Defined in: src/tx/witness.ts:130

UnshieldFlag for boundParams (0 NONE / 1 UNSHIELD / 2 OVERRIDE).

---

unshieldOutput?

readonly optional unshieldOutput?: object

Defined in: src/tx/witness.ts:135

When unshielding: the public output. Built as UnshieldNoteERC20 (npk = recipient) and appended as the LAST commitment (no ciphertext — it's public). unshield (the flag) must be set alongside.

recipient

readonly recipient: `0x${string}`

value

readonly value: bigint

---

adaptContract?

readonly optional adaptContract?: `0x${string}`

Defined in: src/tx/witness.ts:136

---

adaptParams?

readonly optional adaptParams?: `0x${string}`

Defined in: src/tx/witness.ts:137

---

decodedAdaptParams?

readonly optional decodedAdaptParams?: CctpBinding

Defined in: src/tx/witness.ts:139

Decoded cross-chain binding (inspection-only) surfaced to the signer as boundParams.decodedAdaptParams.