Skip to content

xport

Behaviour

Section titled “Behaviour”
  • Wraps a serialized unsigned target transaction in an emitted Export transaction.
  • Writes the emitted wrapper transaction hash W to write_ptr. W is the lifecycle handle used by xport_cancel(), the ExportLatch, stream events, and the signature witness.
  • The wrapper creates an ExportLatch when it is admitted. Selected validators sign only after that ledger validates; witness materialization happens later.
  • xport_reserve() must be called before xport().
  • The target transaction must satisfy the same rules as a user-submitted Export: matching Account, Sequence: 0, a nonzero TicketSequence, an empty SigningPubKey, no signatures, valid cross-chain NetworkID handling, and no reserved xahau/export Memo.
  • committee_hash_ptr identifies an existing immutable ExportCommittee owned by the Hook account. xport() does not create a committee or select a default.
  • Target-chain fee, Ticket, and SignerList configuration remain the Hook author’s responsibility.

Definition

Section titled “Definition”
int64_t xport (
    uint32_t write_ptr,
    uint32_t write_len,
    uint32_t read_ptr,
    uint32_t read_len,
    uint32_t committee_hash_ptr,
    uint32_t committee_hash_len
);

Example

Section titled “Example”
if (xport_reserve(1) < 0)
    rollback(SBUF("Export reserve failed"), 1);


// ... build the unsigned target transaction blob ...


uint8_t origin[32];
uint8_t committee_hash[32] = { /* existing committee digest */ };
int64_t result = xport(SBUF(origin), SBUF(tx_blob), SBUF(committee_hash));
if (result != 32)
    rollback(SBUF("Export failed"), 1);

Parameters

Section titled “Parameters”
NameTypeDescription
write_ptruint32_tPointer to a buffer that receives W.
write_lenuint32_tWrite buffer length; must be at least 32.
read_ptruint32_tPointer to the serialized unsigned target transaction.
read_lenuint32_tSerialized transaction length.
committee_hash_ptruint32_tPointer to the 32-byte digest of an existing ExportCommittee owned by the Hook account.
committee_hash_lenuint32_tCommittee digest length; must be exactly 32.

Return Code

Section titled “Return Code”

Returns 32 on success. Negative results include:

ErrorDescription
PREREQUISITE_NOT_METxport_reserve() was not called.
TOO_MANY_EXPORTED_TXNThe Hook exceeded its reserved Export count.
TOO_MANY_EMITTED_TXNThe Hook exceeded its combined emitted-transaction reservation.
TOO_SMALLwrite_len is less than 32.
OUT_OF_BOUNDSA pointer or length is outside Hook memory.
INVALID_ARGUMENTcommittee_hash_len is not 32.
DOESNT_EXISTThe Hook account does not own the identified ExportCommittee.
EXPORT_FAILUREThe committee object is malformed, the target cannot be wrapped, the wrapper fails Export preflight, or the emission generation is too deep.
INTERNAL_ERRORA required export nonce cannot be allocated.
Section titled “Related”