CreateV1TxPlanArtifactOptions
HardKAS SDK / artifacts/src / CreateV1TxPlanArtifactOptions
Interface: CreateV1TxPlanArtifactOptions
Defined in: packages/artifacts/src/tx-plan-v1.ts:15
F1.1 · a v1 transaction plan artifact: the TxPlan schema (hardkas.txPlan) with txVersion: 1 and the v1 fields
(per-input kind, compute budget and contract reference; output bindings and genesis groups; payload; storage mass; the
mandatory fee limit; the covenant outpoints it spends; the declared next state). Its shape is checked
(assertV1PlanShape) before its identity is sealed, so an artifact that exists is at least well-formed; what the node
and the compiler say about it is checked at signing (F1.4).
Properties
amountSompi
readonlyamountSompi:bigint
Defined in: packages/artifacts/src/tx-plan-v1.ts:23
The value the plan moves to to (for a covenant: the value locked in it).
body
readonlybody:V1PlanBody
Defined in: packages/artifacts/src/tx-plan-v1.ts:24
ctx
readonlyctx:RuntimeContext
Defined in: packages/artifacts/src/tx-plan-v1.ts:26
from
readonlyfrom:object
Defined in: packages/artifacts/src/tx-plan-v1.ts:19
The funder (who pays the fee and receives the change).
accountName?
readonlyoptionalaccountName?:string
address
readonlyaddress:string
input
readonlyinput:string
mode
readonlymode:"rpc"|"simulator"|"localnet"
Defined in: packages/artifacts/src/tx-plan-v1.ts:17
networkId
readonlynetworkId:NetworkId
Defined in: packages/artifacts/src/tx-plan-v1.ts:16
purpose?
readonlyoptionalpurpose?:string
Defined in: packages/artifacts/src/tx-plan-v1.ts:28
What produced the plan, recorded as plannerAuthorityDetail (e.g. "covenant genesis", "covenant transition").
rpcUrl?
readonlyoptionalrpcUrl?:string
Defined in: packages/artifacts/src/tx-plan-v1.ts:25
to
readonlyto:object
Defined in: packages/artifacts/src/tx-plan-v1.ts:21
The primary destination (a covenant or contract address, or a payee).
address
readonlyaddress:string
input
readonlyinput:string