Interface Server<T>

A definition for a Service, combined with an optional handler method for execution errors.

Used as input to @ucanto/server#create | Server.create when defining a service implementation.

Type Parameters

  • T

Hierarchy

Properties

canIssue? catch? codec id principal? resolve? service validateAuthorization

Properties

Optional Readonly canIssue

canIssue?: ((capability, issuer) => boolean)

Type declaration

    • (capability, issuer): boolean

    • Informs validator whether given capability can be issued by a given DID or whether it needs to be delegated to the issuer.

      Parameters

      Returns boolean

Optional Readonly catch

catch?: ((err) => void)

Type declaration

Readonly codec

codec: InboundCodec

Readonly id

id: Signer<`did:${string}:${string}`, SigAlg>

Service DID which will be used to verify that received invocation audience matches it.

Optional Readonly principal

principal?: PrincipalParser

Takes principal parser that can be used to turn a UCAN.Principal into Ucanto.Principal.

Optional Readonly resolve

resolve?: ((proof) => Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>)

Type declaration

Readonly service

service: T

Actual service providing capability handlers.

validateAuthorization

validateAuthorization: ((proofs) => Await<Schema.Result<Unit, Revoked>>)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc