Class Peer<T>

Type Parameters

T

Hierarchy

Peer

Index

Constructors

Properties

agent audience challenge channel did nextdid pin

Methods

ack awaitAck awaitBootstrap awaitLink bootstrap link sendPinSignature

Constructors

constructor

new Peer<T>(opts: {
agent: Agent<T>;
channel: Channel;
}): Peer<T>
Type Parameters
- T extends Signer<string, number, T>
Parameters
- opts: {
  agent: Agent<T>;
  channel: Channel;
  }
  - agent: Agent<T>
  - channel: Channel
Returns Peer<T>
- Defined in packages/access-client/src/awake/peer.js:20

Properties

agent

agent: Agent<T>

audience

audience: undefined | PrincipalView<string>

challenge

challenge: undefined | string

channel

channel: Channel

did

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

nextdid

nextdid: undefined | Principal<string> | PrincipalView<string>

pin

pin: number

Methods

ack

ack(pin: string): Promise<void>
Acknowledgment for the PIN challenge
Parameters
- pin: string
Returns Promise<void>
- Defined in packages/access-client/src/awake/peer.js:88

awaitAck

awaitAck(): Promise<void>
Returns Promise<void>
- Defined in packages/access-client/src/awake/peer.js:112

awaitBootstrap

awaitBootstrap(): Promise<void>
Returns Promise<void>
- Defined in packages/access-client/src/awake/peer.js:56

awaitLink

awaitLink(): Promise<void>
Returns Promise<void>
- Defined in packages/access-client/src/awake/peer.js:154

bootstrap

bootstrap(caps: Capabilities): Promise<undefined | string>
Bootstrap awake/init, receive awake/res and send challenge to Responder
Parameters
- caps: Capabilities
Returns Promise<undefined | string>
- Defined in packages/access-client/src/awake/peer.js:35

link

link(opts: {
    caps: {
        can: Ability;
        with?: `${string}:${string}`;
    }[];
    meta: PeerMeta;
}): Promise<{
    delegation: Delegation<Capabilities>;
    meta: PeerMeta;
}>
Parameters
- opts: {
      caps: {
          can: Ability;
          with?: `${string}:${string}`;
      }[];
      meta: PeerMeta;
  }
  - caps: {
    can: Ability;
    with?: `${string}:${string}`;
    }[]
  - meta: PeerMeta
Returns Promise<{
delegation: Delegation<Capabilities>;
meta: PeerMeta;
}>
- Defined in packages/access-client/src/awake/peer.js:131

`Private` sendPinSignature

sendPinSignature(): Promise<void>
Private
Build pin signature and send it

Returns Promise<void>
- Defined in packages/access-client/src/awake/peer.js:184

Generated using TypeDoc