Class Agent<T>

Type Parameters

T

Agent

Hierarchy

Agent

Index

Constructors

constructor

new Agent<T>(opts: AgentOptions<T>): Agent<T>
Type Parameters
- T extends Signer<string, number, T>
Parameters
- opts: AgentOptions<T>
Returns Agent<T>
- Defined in packages/access-client/src/agent.js:68

Properties

`Private` #fetch

#fetch: ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Type declaration

- (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
- Parameters
  - input: URL | RequestInfo
  - Optional init: RequestInit
  Returns Promise<Response>

`Private` #service

#service: undefined | Principal<"key">

connection

connection: ConnectionView<Service>

data

data: AgentData<T>

issuer

issuer: T

store

store: IStore<T>

url

url: URL

Methods

`Private` #delegations

#delegations(caps?: Capability<Ability, `${string}:${string}`, any>[]): AsyncGenerator<{
delegation: Delegation<Capabilities>;
meta?: DelegationMeta;
}, void, unknown>
Query the delegations store for all the delegations matching the capabilities provided.
Parameters
- Optional caps: Capability<Ability, `${string}:${string}`, any>[]
Returns AsyncGenerator<{
delegation: Delegation<Capabilities>;
meta?: DelegationMeta;
}, void, unknown>
- Defined in packages/access-client/src/agent.js:151

`Private` #waitForVoucherRedeem

#waitForVoucherRedeem(opts?: {
signal: undefined | AbortSignal;
}): Promise<Delegation<[{}]>>
Parameters
- Optional opts: {
  signal: undefined | AbortSignal;
  }
  - signal: undefined | AbortSignal
Returns Promise<Delegation<[{}]>>
- Defined in packages/access-client/src/agent.js:371

addProof

addProof(delegation: Delegation<Capabilities>): Promise<void>
Add a proof to the agent store

A proof is a delegation with an audience matching agent DID
Parameters
- delegation: Delegation<Capabilities>
Returns Promise<void>
- Defined in packages/access-client/src/agent.js:133

createSpace

createSpace(name: string): Promise<{
did: `did:key:${string}`;
proof: Delegation<[ToDeriveClaim<{}>]>;
}>
Creates a space signer and a delegation to the agent
Parameters
- name: string
Returns Promise<{
did: `did:key:${string}`;
proof: Delegation<[ToDeriveClaim<{}>]>;
}>
- Defined in packages/access-client/src/agent.js:226

currentSpace

currentSpace(): undefined | `did:${string}:${string}`
Get current space DID

Returns undefined | `did:${string}:${string}`
- Defined in packages/access-client/src/agent.js:276

currentSpaceWithMeta

currentSpaceWithMeta(): Promise<undefined | {
    capabilities: any[];
    did: `did:${string}:${string}`;
    proofs: Delegation<Capabilities>[];
}>
Get current space DID, proofs and abilities

Returns Promise<undefined | {
    capabilities: any[];
    did: `did:${string}:${string}`;
    proofs: Delegation<Capabilities>[];
}>
- Defined in packages/access-client/src/agent.js:283

delegate

delegate(options: DelegationOptions): Promise<Delegation<Capabilities>>
Parameters
- options: DelegationOptions
Returns Promise<Delegation<Capabilities>>
- Defined in packages/access-client/src/agent.js:409

delegations

delegations(caps?: Capability<Ability, `${string}:${string}`, any>[]): AsyncGenerator<Delegation<Capabilities>, void, unknown>
Get delegations created by the agent for others.
Parameters
- Optional caps: Capability<Ability, `${string}:${string}`, any>[]
  
  Capabilities to filter by. Empty or undefined caps with return all the delegations.
Returns AsyncGenerator<Delegation<Capabilities>, void, unknown>
- Defined in packages/access-client/src/agent.js:202

delegationsWithMeta

delegationsWithMeta(caps?: Capability<Ability, `${string}:${string}`, any>[]): AsyncGenerator<{
delegation: Delegation<Capabilities>;
meta?: DelegationMeta;
}, void, unknown>
Get delegations created by the agent for others and their metadata.
Parameters
- Optional caps: Capability<Ability, `${string}:${string}`, any>[]
  
  Capabilities to filter by. Empty or undefined caps with return all the delegations.
Returns AsyncGenerator<{
delegation: Delegation<Capabilities>;
meta?: DelegationMeta;
}, void, unknown>
- Defined in packages/access-client/src/agent.js:213

did

did(): `did:${string}:${string}`
Returns `did:${string}:${string}`
- Defined in packages/access-client/src/agent.js:122

execute

execute<A, R, CAP, C>(cap: CAP, options: ExecuteOptions<A, R, CAP>): Promise<InferServiceInvocationReturn<InferInvokedCapability<CAP>, Service>>
Execute the given capability on the Access service connection
Type Parameters
- A extends Ability
- R extends `${string}:${string}` & Phantom<{}, R>
- CAP extends TheCapabilityParser<CapabilityMatch<A, R, C>, CAP>
- C extends Caveats = {}
Parameters
- cap: CAP
- options: ExecuteOptions<A, R, CAP>
Returns Promise<InferServiceInvocationReturn<InferInvokedCapability<CAP>, Service>>
- Defined in packages/access-client/src/agent.js:451

getSpaceInfo

getSpaceInfo(space?: URI<"did:">): Promise<SpaceD1 & {}>
Get Space information from Access service
Parameters
- Optional space: URI<"did:">
Returns Promise<SpaceD1 & {}>
- Defined in packages/access-client/src/agent.js:503

peer

peer(channel: Channel): Peer<T>
Parameters
- channel: Channel
Returns Peer<T>
- Defined in packages/access-client/src/agent.js:494

proofs

proofs(caps?: Capability<Ability, `${string}:${string}`, any>[]): Promise<Delegation<Capabilities>[]>
Get all the proofs matching the capabilities

Proofs are delegations with an audience matching agent DID.
Parameters
- Optional caps: Capability<Ability, `${string}:${string}`, any>[]
  
  Capabilities to filter by. Empty or undefined caps with return all the proofs.
Returns Promise<Delegation<Capabilities>[]>
- Defined in packages/access-client/src/agent.js:186

registerSpace

registerSpace(email: string, opts?: {
signal: undefined | AbortSignal;
}): Promise<void>
Invokes voucher/redeem for the free tier, wait on the websocket for the voucher/claim and invokes it

It also adds a full space delegation to the service in the voucher/claim invocation to allow for recovery
Parameters
- email: string
- Optional opts: {
  signal: undefined | AbortSignal;
  }
  - signal: undefined | AbortSignal
Returns Promise<void>
- Defined in packages/access-client/src/agent.js:319

service

service(): Promise<Principal<"key">>
Returns Promise<Principal<"key">>
- Defined in packages/access-client/src/agent.js:112

setCurrentSpace

setCurrentSpace(space: `did:${string}:${string}`): Promise<`did:${string}:${string}`>
Sets the current selected space

Other methods will default to use the current space if no resource is defined
Parameters
- space: `did:${string}:${string}`
Returns Promise<`did:${string}:${string}`>
- Defined in packages/access-client/src/agent.js:255

`Static` create

create<T>(opts: AgentCreateOptions<T>): Promise<Agent<T>>
Type Parameters
- T extends Signer<string, number, T>
Parameters
- opts: AgentCreateOptions<T>
Returns Promise<Agent<T>>
- Defined in packages/access-client/src/agent.js:84

Class Agent<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends Signer<string, number, T>

Parameters

opts: AgentOptions<T>

Returns Agent<T>

Properties

Private #fetch

Type declaration

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

Private #service

connection

data

issuer

store

url

Methods

Private #delegations

Parameters

Optional caps: Capability<Ability, `${string}:${string}`, any>[]

Returns AsyncGenerator<{ delegation: Delegation<Capabilities>; meta?: DelegationMeta; }, void, unknown>

Private #waitForVoucherRedeem

Parameters

Optional opts: { signal: undefined | AbortSignal; }

signal: undefined | AbortSignal

Returns Promise<Delegation<[{}]>>

addProof

Parameters

delegation: Delegation<Capabilities>

Returns Promise<void>

createSpace

Parameters

name: string

Returns Promise<{ did: `did:key:${string}`; proof: Delegation<[ToDeriveClaim<{}>]>; }>

currentSpace

Returns undefined | `did:${string}:${string}`

currentSpaceWithMeta

Returns Promise<undefined | { capabilities: any[]; did: `did:${string}:${string}`; proofs: Delegation<Capabilities>[]; }>

delegate

Parameters

options: DelegationOptions

Returns Promise<Delegation<Capabilities>>

delegations

Parameters

Optional caps: Capability<Ability, `${string}:${string}`, any>[]

Returns AsyncGenerator<Delegation<Capabilities>, void, unknown>

delegationsWithMeta

Parameters

Optional caps: Capability<Ability, `${string}:${string}`, any>[]

Returns AsyncGenerator<{ delegation: Delegation<Capabilities>; meta?: DelegationMeta; }, void, unknown>

did

Returns `did:${string}:${string}`

execute

Type Parameters

A extends Ability

R extends `${string}:${string}` & Phantom<{}, R>

CAP extends TheCapabilityParser<CapabilityMatch<A, R, C>, CAP>

C extends Caveats = {}

Parameters

cap: CAP

options: ExecuteOptions<A, R, CAP>

Returns Promise<InferServiceInvocationReturn<InferInvokedCapability<CAP>, Service>>

getSpaceInfo

Parameters

Optional space: URI<"did:">

Returns Promise<SpaceD1 & {}>

peer

Parameters

`Private` #fetch

`Optional` init: RequestInit

`Private` #service

`Private` #delegations

`Optional` caps: Capability<Ability, `${string}:${string}`, any>[]

Returns AsyncGenerator<{
delegation: Delegation<Capabilities>;
meta?: DelegationMeta;
}, void, unknown>

`Private` #waitForVoucherRedeem

`Optional` opts: {
signal: undefined | AbortSignal;
}

Returns Promise<{
did: `did:key:${string}`;
proof: Delegation<[ToDeriveClaim<{}>]>;
}>

Returns Promise<undefined | {
capabilities: any[];
did: `did:${string}:${string}`;
proofs: Delegation<Capabilities>[];
}>

`Optional` caps: Capability<Ability, `${string}:${string}`, any>[]

`Optional` caps: Capability<Ability, `${string}:${string}`, any>[]

Returns AsyncGenerator<{
delegation: Delegation<Capabilities>;
meta?: DelegationMeta;
}, void, unknown>

`Optional` space: URI<"did:">

`Optional` caps: Capability<Ability, `${string}:${string}`, any>[]

`Optional` opts: {
signal: undefined | AbortSignal;
}

`Static` create