@blockchaincommons/gstp - v1.0.0-beta.2
    Preparing search index...

    Class SealedRequest

    A request with its sender, state and the peer's continuation.

    Implements

    • ToEnvelope
    Index
    • get expressionEnvelope(): Envelope

      The expression as an envelope.

      Returns Envelope

    • get date(): Date | undefined

      The 'date' as a JS Date (millisecond view); cborDate is the exact value.

      Returns Date | undefined

    • get cborDate(): CborDate | undefined

      The 'date' exactly, when any.

      Returns CborDate | undefined

    • get state(): Envelope | undefined

      The sender's state, when any.

      Returns Envelope | undefined

    • get peerContinuation(): Envelope | undefined

      The peer's continuation, when any.

      Returns Envelope | undefined

    • A request for func (a function, its id, or a whole expression) with id, from sender. An id that is not an ARID, a sender that is not an XIDDocument or a peer continuation that is not an Envelope is a TypeError.

      Parameters

      Returns SealedRequest

    • With a param argument; unchanged when value is undefined.

      Parameters

      • param: ParameterID | Parameter
      • value: EnvelopeInput | undefined

      Returns SealedRequest

    • The single param argument, or undefined; two of them are Envelope[AmbiguousPredicate].

      Parameters

      • param: ParameterID | Parameter

      Returns Envelope | undefined

    • The single param argument; Envelope[NonexistentPredicate] when absent, Envelope[AmbiguousPredicate] when repeated.

      Parameters

      • param: ParameterID | Parameter

      Returns Envelope

    • Every param argument.

      Parameters

      • param: ParameterID | Parameter

      Returns Envelope[]

    • The single param argument's leaf, decoded by decoder (dcbor's expectText, expectInteger, …, CborDate.fromTaggedCbor, ARID.fromCbor, or any (cbor) => T), as the reference's extract_object_for_parameter::<T>: Envelope[NonexistentPredicate] when absent, Envelope[AmbiguousPredicate] when repeated, Envelope[NotLeaf] when the argument is not a leaf, Envelope[Cbor] when the decoder rejects it.

      Type Parameters

      • T

      Parameters

      • param: ParameterID | Parameter
      • decoder: CborDecoder<T>

      Returns T

    • extractObjectForParameter, or undefined when the parameter is absent.

      Type Parameters

      • T

      Parameters

      • param: ParameterID | Parameter
      • decoder: CborDecoder<T>

      Returns T | undefined

    • Every param argument's leaf, decoded.

      Type Parameters

      • T

      Parameters

      • param: ParameterID | Parameter
      • decoder: CborDecoder<T>

      Returns T[]

    • With the peer's continuation (undefined clears it); not an Envelope is a TypeError.

      Parameters

      • peerContinuation: Envelope | undefined

      Returns SealedRequest

    • The request with 'sender', the sender's continuation (the state — null without one — bound to the request id and validUntil, encrypted to the sender) and the peer continuation; signed by signer and encrypted to recipients when given. With no options: unsigned, unsealed.

      Parameters

      Returns Envelope

    • SealedRequest(<summary>, state: <flat>, peer_continuation: None|Some), the reference's Display.

      Returns string

    • Same request and sender document, identical state and peer continuation (digest and structure), as the reference's PartialEq.

      Parameters

      Returns boolean