Class SealedRequest

A sealed request that combines a Request with sender information and state continuations for secure communication.

Example

import { SealedRequest, ARID } from '@bcts/gstp';
import { XIDDocument } from '@bcts/xid';

// Create sender XID document
const sender = XIDDocument.new();
const requestId = ARID.new();

// Create a sealed request
const request = SealedRequest.new("getBalance", requestId, sender)
  .withParameter("account", "alice")
  .withState("session-state-data")
  .withNote("Balance check");

// Convert to sealed envelope
const envelope = request.toEnvelope(
  new Date(Date.now() + 60000), // Valid for 60 seconds
  senderPrivateKey,
  recipientXIDDocument
);

Implements

SealedRequestBehavior

Methods

`Static`new

new(
    func: string | number | Function,
    id: ARID,
    sender: XIDDocument,
): SealedRequest
Creates a new sealed request with the given function, ID, and sender.
Parameters
- func: string | number | Function
  The function to call (string name or Function object)
- id: ARID
  The request ID
- sender: XIDDocument
  The sender's XID document
Returns SealedRequest
- Defined in sealed-request.ts:124

`Static`newWithBody

newWithBody(body: Expression, id: ARID, sender: XIDDocument): SealedRequest
Creates a new sealed request with an expression body.
Parameters
- body: Expression
  The expression body
- id: ARID
  The request ID
- sender: XIDDocument
  The sender's XID document
Returns SealedRequest
- Defined in sealed-request.ts:135

withParameter

withParameter(
parameter: ParameterID,
value: EnvelopeEncodableValue,
): SealedRequest
Adds a parameter to the request.
Parameters
- parameter: ParameterID
- value: EnvelopeEncodableValue
Returns SealedRequest
- Defined in sealed-request.ts:146

withOptionalParameter

withOptionalParameter(
parameter: ParameterID,
value: EnvelopeEncodableValue,
): SealedRequest
Adds an optional parameter to the request.
Parameters
- parameter: ParameterID
- value: EnvelopeEncodableValue
Returns SealedRequest
- Defined in sealed-request.ts:154

function

function(): Function
Returns the function of the request.

Returns Function
- Defined in sealed-request.ts:167

expressionEnvelope

expressionEnvelope(): Envelope$1
Returns the expression envelope of the request.

Returns Envelope$1
- Defined in sealed-request.ts:174

objectForParameter

objectForParameter(param: ParameterID): Envelope$1 | undefined
Returns the object for a parameter.
Parameters
- param: ParameterID
Returns Envelope$1 | undefined
- Defined in sealed-request.ts:181

objectsForParameter

objectsForParameter(param: ParameterID): Envelope$1[]
Returns all objects for a parameter.
Parameters
- param: ParameterID
Returns Envelope$1[]
- Defined in sealed-request.ts:188

extractObjectForParameter

extractObjectForParameter<T>(param: ParameterID): T
Extracts an object for a parameter as a specific type.
Type Parameters
- T
Parameters
- param: ParameterID
Returns T
- Defined in sealed-request.ts:196

extractOptionalObjectForParameter

extractOptionalObjectForParameter<T>(param: ParameterID): T | undefined
Extracts an optional object for a parameter.
Type Parameters
- T
Parameters
- param: ParameterID
Returns T | undefined
- Defined in sealed-request.ts:215

extractObjectsForParameter

extractObjectsForParameter<T>(param: ParameterID): T[]
Extracts all objects for a parameter as a specific type.
Type Parameters
- T
Parameters
- param: ParameterID
Returns T[]
- Defined in sealed-request.ts:234

withNote

withNote(note: string): SealedRequest
Adds a note to the request.
Parameters
- note: string
Returns SealedRequest
- Defined in sealed-request.ts:245

withDate

withDate(date: Date): SealedRequest
Adds a date to the request.
Parameters
- date: Date
Returns SealedRequest
- Defined in sealed-request.ts:253

body

body(): Expression
Returns the body of the request.

Returns Expression
- Defined in sealed-request.ts:261

id

id(): ARID
Returns the ID of the request.

Returns ARID
- Defined in sealed-request.ts:268

note

note(): string
Returns the note of the request.

Returns string
- Defined in sealed-request.ts:275

date

date(): Date | undefined
Returns the date of the request.

Returns Date | undefined
- Defined in sealed-request.ts:282

withState

withState(state: EnvelopeEncodableValue): SealedRequest
Adds state to the request that the receiver must return in the response.
Parameters
- state: EnvelopeEncodableValue
Returns SealedRequest
Implementation of SealedRequestBehavior.withState
- Defined in sealed-request.ts:293

withOptionalState

withOptionalState(state: EnvelopeEncodableValue): SealedRequest
Adds optional state to the request.
Parameters
- state: EnvelopeEncodableValue
Returns SealedRequest
Implementation of SealedRequestBehavior.withOptionalState
- Defined in sealed-request.ts:301

withPeerContinuation

withPeerContinuation(peerContinuation: Envelope$1): SealedRequest
Adds a continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1
Returns SealedRequest
Implementation of SealedRequestBehavior.withPeerContinuation
- Defined in sealed-request.ts:309

withOptionalPeerContinuation

withOptionalPeerContinuation(
peerContinuation: Envelope$1 | undefined,
): SealedRequest
Adds an optional continuation previously received from the recipient.
Parameters
- peerContinuation: Envelope$1 | undefined
Returns SealedRequest
Implementation of SealedRequestBehavior.withOptionalPeerContinuation
- Defined in sealed-request.ts:317

request

request(): Request
Returns the underlying request.

Returns Request
Implementation of SealedRequestBehavior.request
- Defined in sealed-request.ts:325

sender

sender(): XIDDocument
Returns the sender of the request.

Returns XIDDocument
Implementation of SealedRequestBehavior.sender
- Defined in sealed-request.ts:332

state

state(): Envelope$1 | undefined
Returns the state to be sent to the recipient.

Returns Envelope$1 | undefined
Implementation of SealedRequestBehavior.state
- Defined in sealed-request.ts:339

peerContinuation

peerContinuation(): Envelope$1 | undefined
Returns the continuation received from the recipient.

Returns Envelope$1 | undefined
Implementation of SealedRequestBehavior.peerContinuation
- Defined in sealed-request.ts:346

toRequest

toRequest(): Request
Converts the sealed request to a Request.

Returns Request
- Defined in sealed-request.ts:357

toExpression

toExpression(): Expression
Converts the sealed request to an Expression.

Returns Expression
- Defined in sealed-request.ts:364

toEnvelope

toEnvelope(
    validUntil?: Date,
    signer?: Signer,
    recipient?: XIDDocument,
): Envelope$1
Creates an envelope that can be decrypted by zero or one recipient.
Parameters
- OptionalvalidUntil: Date
  Optional expiration date for the continuation
- Optionalsigner: Signer
  Optional signer for the envelope
- Optionalrecipient: XIDDocument
  Optional recipient XID document for encryption
Returns Envelope$1
The sealed request as an envelope
- Defined in sealed-request.ts:380

toEnvelopeForRecipients

toEnvelopeForRecipients(
    validUntil?: Date,
    signer?: Signer,
    recipients?: XIDDocument[],
): Envelope$1
Creates an envelope that can be decrypted by zero or more recipients.
Parameters
- OptionalvalidUntil: Date
  Optional expiration date for the continuation
- Optionalsigner: Signer
  Optional signer for the envelope
- Optionalrecipients: XIDDocument[]
  Array of recipient XID documents for encryption
Returns Envelope$1
The sealed request as an envelope
- Defined in sealed-request.ts:393

`Static`tryFromEnvelope

tryFromEnvelope(
    encryptedEnvelope: Envelope$1,
    expectedId: ARID | undefined,
    now: Date | undefined,
    recipient: PrivateKeys,
): SealedRequest
Parses a sealed request from an encrypted envelope.
Parameters
- encryptedEnvelope: Envelope$1
  The encrypted envelope to parse
- expectedId: ARID | undefined
  Optional expected request ID for validation
- now: Date | undefined
  Optional current time for continuation validation
- recipient: PrivateKeys
  The recipient's private keys for decryption
Returns SealedRequest
The parsed sealed request
- Defined in sealed-request.ts:457

toString

toString(): string
Returns a string representation of the sealed request.

Returns string
- Defined in sealed-request.ts:542

equals

equals(other: SealedRequest): boolean
Checks equality with another sealed request.
Parameters
- other: SealedRequest
Returns boolean
- Defined in sealed-request.ts:551

Class SealedRequest

Example

Implements

Index

Methods

Methods

Staticnew

Parameters

Returns SealedRequest

StaticnewWithBody

Parameters

Returns SealedRequest

withParameter

Parameters

Returns SealedRequest

withOptionalParameter

Parameters

Returns SealedRequest

function

Returns Function

expressionEnvelope

Returns Envelope$1

objectForParameter

Parameters

Returns Envelope$1 | undefined

objectsForParameter

Parameters

Returns Envelope$1[]

extractObjectForParameter

Type Parameters

Parameters

Returns T

extractOptionalObjectForParameter

Type Parameters

Parameters

Returns T | undefined

extractObjectsForParameter

Type Parameters

Parameters

Returns T[]

withNote

Parameters

Returns SealedRequest

withDate

Parameters

Returns SealedRequest

body

Returns Expression

id

Returns ARID

note

Returns string

date

Returns Date | undefined

withState

Parameters

Returns SealedRequest

withOptionalState

Parameters

Returns SealedRequest

withPeerContinuation

Parameters

Returns SealedRequest

withOptionalPeerContinuation

Parameters

Returns SealedRequest

request

Returns Request

sender

Returns XIDDocument

state

Returns Envelope$1 | undefined

peerContinuation

Returns Envelope$1 | undefined

toRequest

Returns Request

toExpression

Returns Expression

toEnvelope

Parameters

`Static`new

`Static`newWithBody

`Static`tryFromEnvelope