Interface ServerView<T>

A materialized Server that is configured to use a specific transport channel. The ServerView has an InvocationContext which contains the DID of the service itself, among other things.

Returned by @ucanto/server#create | Server.create when instantiating a server.

Type Parameters

T extends Record<string, any>

Hierarchy

Server<T>
Transport.Channel<T>
- ServerView

Index

Properties

[Marker]? canIssue? catch codec context id principal? resolve? service validateAuthorization

Methods

request run

Properties

`Optional` [Marker]

[Marker]?: T

`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
  - capability: ParsedCapability<Ability, URI, {}>
  - issuer: `did:${string}:${string}`
  Returns boolean

catch

catch: ((err) => void)

Type declaration

- (err): void
- Parameters
  - err: HandlerExecutionError
  Returns void

`Readonly` codec

codec: InboundCodec

context

context: InvocationContext

`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

- (proof): Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>
- Parameters
  - proof: UCANLink<Capabilities, MulticodecCode<number, string>, SigAlg>
  Returns Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>

`Readonly` service

service: T

Actual service providing capability handlers.

validateAuthorization

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

Type declaration

- (proofs): Await<Schema.Result<Unit, Revoked>>
- Parameters
  - proofs: Authorization<ParsedCapability<Ability, URI, {}>>
  Returns Await<Schema.Result<Unit, Revoked>>

Methods

request

request<I>(request): Crypto.Await<Transport.HTTPResponse<AgentMessage<{
In: Transport.Tuple<Invocation<Capability<Ability, `${string}:${string}`, unknown>>>;
Out: InferReceipts<I, T>;
}>>>
Type Parameters
- I extends Transport.Tuple<ServiceInvocation<Capability<Ability, `${string}:${string}`, unknown>, T>>
Parameters
- request: Transport.HTTPRequest<AgentMessage<{
  In: InferInvocations<I>;
  Out: Transport.Tuple<Receipt<{}, {}, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>;
  }>>
Returns Crypto.Await<Transport.HTTPResponse<AgentMessage<{
In: Transport.Tuple<Invocation<Capability<Ability, `${string}:${string}`, unknown>>>;
Out: InferReceipts<I, T>;
}>>>
Inherited from Channel.request
- Defined in node_modules/.pnpm/@ucanto+interface@10.0.1/node_modules/@ucanto/interface/dist/src/transport.d.ts:21

run

run<C>(invocation): Await<InferReceipt<C, T>>
Type Parameters
- C extends Capability<Ability, `${string}:${string}`, unknown>
Parameters
- invocation: ServiceInvocation<C, T>
Returns Await<InferReceipt<C, T>>
- Defined in node_modules/.pnpm/@ucanto+interface@10.0.1/node_modules/@ucanto/interface/dist/src/lib.d.ts:650

Interface ServerView<T>

Type Parameters

T extends Record<string, any>

Hierarchy

Index

Properties

Methods

Properties

Optional [Marker]

Optional Readonly canIssue

Type declaration

Parameters

capability: ParsedCapability<Ability, URI, {}>

issuer: `did:${string}:${string}`

Returns boolean

catch

Type declaration

Parameters

err: HandlerExecutionError

Returns void

Readonly codec

context

Readonly id

Optional Readonly principal

Optional Readonly resolve

Type declaration

Parameters

proof: UCANLink<Capabilities, MulticodecCode<number, string>, SigAlg>

Returns Await<Schema.Result<Delegation<Capabilities>, UnavailableProof>>

Readonly service

validateAuthorization

Type declaration

Parameters

proofs: Authorization<ParsedCapability<Ability, URI, {}>>

Returns Await<Schema.Result<Unit, Revoked>>

Methods

request

Type Parameters

I extends Transport.Tuple<ServiceInvocation<Capability<Ability, `${string}:${string}`, unknown>, T>>

Parameters

request: Transport.HTTPRequest<AgentMessage<{ In: InferInvocations<I>; Out: Transport.Tuple<Receipt<{}, {}, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>; }>>

Returns Crypto.Await<Transport.HTTPResponse<AgentMessage<{ In: Transport.Tuple<Invocation<Capability<Ability, `${string}:${string}`, unknown>>>; Out: InferReceipts<I, T>; }>>>

run

Type Parameters

C extends Capability<Ability, `${string}:${string}`, unknown>

Parameters

invocation: ServiceInvocation<C, T>

Returns Await<InferReceipt<C, T>>

Settings

Member Visibility

Theme

On This Page

`Optional` [Marker]

`Optional` `Readonly` canIssue

`Readonly` codec

`Readonly` id

`Optional` `Readonly` principal

`Optional` `Readonly` resolve

`Readonly` service

request: Transport.HTTPRequest<AgentMessage<{
In: InferInvocations<I>;
Out: Transport.Tuple<Receipt<{}, {}, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>;
}>>

Returns Crypto.Await<Transport.HTTPResponse<AgentMessage<{
In: Transport.Tuple<Invocation<Capability<Ability, `${string}:${string}`, unknown>>>;
Out: InferReceipts<I, T>;
}>>>