Classes
Interfaces
Type Aliases
RequestOperation
Ƭ RequestOperation<Args, Result>: OperationReference<"public", Args, Result> | { operationId: string ; contractDigest: string ; functions?: { invoke: string ; recover: string } ; _args?: Args ; _result?: Result }
Type parameters
RequestHandle
Ƭ RequestHandle<Result>: Object
Type parameters
Type declaration
DecisionCheckpoint
Ƭ DecisionCheckpoint:Readonly<{ key: string ; value: string }>
A host’s immutable decision, committed before any of its tools run.
The value is an opaque, bounded serialization owned by the host adapter.
It contains no credentials. Business intentions remain RequestEnvelopes.
RequestId
Ƭ RequestId:string & { __requestId: unique symbol }
EncodedInput
Ƭ EncodedInput:ReturnType<typeof bijectionToJson>
Not exported: an exported type refers to it.
RequestEnvelope
Ƭ RequestEnvelope:Readonly<{ version: typeof REQUEST_VERSION ; requestId: RequestId ; requestOwnerId: string ; operationId: string ; contractDigest: string ; functions: Readonly<{ invoke: string ; recover: string }> ; input: EncodedInput }>
Requirement
Ƭ Requirement: {kind: "verification" ; verificationId: string } | { kind: "confirmation" ; proposalId: string ; confirmationId: string } | { kind: "approval" ; proposalId: string ; approvalId: string }
Retained
Ƭ Retained<T>: { kind: "available" ; value: T } | { kind: "omitted" ; reason: string } | { kind: "expired" }
Type parameters
RequestView
Ƭ RequestView<T>: { kind: "pending" ; requestId: RequestId ; requirements: readonly Requirement[] ; proposal?: Retained<{ proposalId: string }> ; input?: { kind: "expired" } } | { kind: "accepted" ; requestId: RequestId ; receipt: { invocationId: string | null ; acceptedRevision: string | null ; result: Retained<T> } } | { kind: "refused" ; requestId: RequestId ; receipt: Retained<{ code: string ; message?: string }> }
Type parameters
RequestInspection
Ƭ RequestInspection<T>: { kind: "observed" ; request: RequestView<T> } | { kind: "notObserved" ; requestId: RequestId }
Absence is an observation at one read, never permission to mint another ID.
Type parameters
Variables
REQUEST_VERSION
•Const REQUEST_VERSION: 1
Functions
createRequestClient
▸ createRequestClient(options): Object
One controller for browser, CLI, jobs and framework integrations.
Parameters
Returns
Object
checkpointRequests
▸ checkpointRequests(checkpoints): RequestStore
Keep immutable request envelopes beside the host’s model decisions. The
shared controller still owns binding validation and request semantics.
Parameters
Returns
RequestStore
httpRequestTransport
▸ httpRequestTransport(options): RequestTransport
The native operation transport. Recovery uses the retained address and
contract; it never describes an operation or loads today’s tool catalog.
Parameters
Returns
RequestTransport
requestId
▸ requestId(value): RequestId
Parameters
Returns
RequestId
encodeInput
▸ encodeInput(input): EncodedInput
The native value codec preserves int64, bytes and floating-point identity.
Parameters
Returns
EncodedInput
readEnvelope
▸ readEnvelope(value): RequestEnvelope
Parameters
Returns
RequestEnvelope
readRequestView
▸ readRequestView<Result>(value, id): RequestView<Result>
Validate the decision independently of the current operation definition.
Type parameters
Parameters
Returns
RequestView<Result>
requireSameRequest
▸ requireSameRequest(expected, actual): void
Parameters
Returns
void
requestIdFor
▸ requestIdFor(call): Promise<RequestId>
A framework call is an integration identity, not part of business state.
Neither credentials, ownership nor catalog names participate.
Parameters
Returns
Promise<RequestId>
inspectRequest
▸ inspectRequest(requestId, expected?): Promise<any>
Inspect native custody by identity, independently of the current catalog.
Current read authority and original source obligations still apply.
Parameters
Returns
Promise<any>
continueRequest
▸ continueRequest(ctx, requestId, expected?): Promise<any>
Continue the original intention through the ordinary native operation owner.
Current authority and requirements are rechecked.
Parameters
Returns
Promise<any>
withdrawRequest
▸ withdrawRequest(ctx, requestId, expected?): Promise<any>
Withdraw the original request. A terminal decision wins the race.
Parameters
Returns
Promise<any>
statusRequest
▸ statusRequest(requestId): Promise<any>
Read current execution facts from the original native request, including
component operations, under current disclosure authority.
Parameters
Returns
Promise<any>