Class Signer

Readonlypkdns

await signer.pkdns.publishHomeserverIfStale(homeserverPk);
Copy

ReadonlypublicKey

[dispose]

• "[dispose]"(): void

  Returns void

approveAuthRequest

• approveAuthRequest(pubkyauth_url: string): Promise<void>

  Approve all capabilities in a pubkyauth:// auth request URL.

  Parameters

  • pubkyauth_url: string

  Returns Promise<void>

approveAuthWithCapabilities

• approveAuthWithCapabilities(
      pubkyauth_url: string,
      approved_capabilities: string,
  ): Promise<void>

  Approve selected capabilities in a pubkyauth:// auth request URL.

  Scopes and actions must be covered by the request. An empty string approves no capabilities. V1 grants deliver keys only for approved e scopes. Supports grant and legacy signin/signup requests. Invalid capabilities or approvals exceeding the request fail before POST.

  Parameters

  • pubkyauth_url: string
  • approved_capabilities: string

  Returns Promise<void>

  Example

  await signer.approveAuthWithCapabilities(authUrl, "/pub/example.app/:r");
  Copy

free

• free(): void

  Returns void

handleDeepLink

• handleDeepLink(pubkyauth_url: string): Promise<void>

  Handle a pubkyauth:// deep link.

  Auth requests are approved through their relay. A direct_signup link creates an account on its target homeserver.

  Parameters

  • pubkyauth_url: string

  Returns Promise<void>

signin

• signin(client_id: string): Promise<Session>

  Fast sign-in for a returning user. Publishes PKDNS in the background.

  Creates a grant-backed homeserver session with root storage access (/:rw). Encryption keys require an explicit e request through a signed approval flow. clientId is shown in the user's grant/session list.

  Parameters

  • client_id: string

  Returns Promise<Session>

  Throws

signinBlocking

• signinBlocking(client_id: string): Promise<Session>

  Blocking sign-in. Waits for PKDNS publish to complete (slower; safer).

  Creates a grant-backed homeserver session with root storage access (/:rw). Encryption keys require an explicit e request through a signed approval flow. clientId is shown in the user's grant/session list.

  Parameters

  • client_id: string

  Returns Promise<Session>

signinCookie

• signinCookie(): Promise<Session>

  Legacy cookie signin. Prefer signin(clientId).

  Returns Promise<Session>

  Deprecated

  Prefer signin(clientId).

signinCookieBlocking

• signinCookieBlocking(): Promise<Session>

  Legacy cookie blocking signin. Prefer signinBlocking(clientId).

  Returns Promise<Session>

  Deprecated

  Prefer signinBlocking(clientId).

signup

• signup(homeserver: PublicKey, signup_token?: string | null): Promise<void>

  Sign up at a homeserver.

  Creates the account and publishes PKDNS. Call signin(clientId) to create a session.

  Parameters

  • homeserver: PublicKey

    The homeserver’s public key.

  • Optionalsignup_token: string | null

  Returns Promise<void>

  Throws

  • AuthenticationError (bad/expired token)
  • RequestError (network/server)

signupCookie

• signupCookie(
      homeserver: PublicKey,
      signup_token?: string | null,
  ): Promise<Session>

  Legacy cookie signup. Prefer signup() plus signin(clientId).

  Parameters

  • homeserver: PublicKey
  • Optionalsignup_token: string | null

  Returns Promise<Session>

  Deprecated

  Prefer signup() followed by signin(clientId).

StaticfromKeypair

• fromKeypair(keypair: Keypair): Signer

  Create a signer from a Keypair (prefer pubky.signer(kp)).

  Parameters

  • keypair: Keypair

  Returns Signer