@synonymdev/pubky
    Preparing search index...

    Class SignupGrantDeepLink

    Parsed grant-based signup deeplink.

    This is useful for tools, tests, and signer UIs that need to inspect a pubky://signup-grant authorization URL before approving it.

    Index
    approvalFormat baseRelayUrl capabilities clientId clientPublicKey ephemeralPublicKey homeserver secret signupToken xCallback
    [dispose] free toString parse
    approvalFormat: string

    Negotiated approval format: bareGrant or signedApprovalV1.

    baseRelayUrl: string

    Base HTTP relay inbox URL used by this auth request.

    capabilities: string

    Capabilities requested by the application.

    clientId: string

    Application identifier shown in the user's grant/session list.

    clientPublicKey: PublicKey

    Public key for the Proof-of-Possession client created by the application.

    ephemeralPublicKey: Uint8Array<ArrayBufferLike> | undefined

    The 32-byte ephemeral HPKE public key from epk, or undefined for a shared-secret link. The relay channel ID is the unpadded base64url encoding of BLAKE3("pubky-grant-relay-channel-v1" || 0x00 || epk), where || concatenates bytes and epk is the raw 32-byte public key.

    homeserver: PublicKey

    Homeserver public key requested for account creation.

    secret: Uint8Array<ArrayBufferLike> | undefined

    Shared relay secret, or undefined for an HPKE link. Keep this secret confidential until the flow completes or is abandoned.

    signupToken: string | undefined

    Optional signup token included in the request.

    xCallback: XCallbackParams

    Optional x-callback-url metadata carried by this deep link.

    • Returns void

    • Returns void

    • Serialize this parsed deeplink back to its URL form.

      Returns string

    • Parse a grant signup deeplink URL.

      Parameters

      • url: string

      Returns SignupGrantDeepLink

      InvalidInput when the URL is malformed or not a grant signup link.

    Settings

    On This Page
    Properties
    Methods