@arkade-os/sdk Documentation - v0.4.36
    Preparing search index...

    Class ReadonlyDescriptorIdentity

    Watch-only HD identity from a descriptor template.

    Can derive public keys but cannot sign transactions. Use this for watch-only wallets — given just an xpub-based template, the readonly side still rotates through HD indices.

    Constructed from a wildcard template (e.g. tr([fp/86'/0'/0']xpub.../0/*)); the descriptor field holds it for HD providers to consume.

    const ro = ReadonlyDescriptorIdentity.fromDescriptor(
      "tr([fp/86'/0'/0']xpub.../0/*)"
    );
    ro.descriptor;
    // => "tr([fp/86'/0'/0']xpub.../0/*)" — the template

    Implements

    • ReadonlyHDCapableIdentity
    Index

    Properties

    descriptor

    Methods

    compressedPublicKey isOurs xOnlyPublicKey fromDescriptor

    Properties

    descriptor: string

    Wildcard account-descriptor template (e.g. tr([fp/86'/0'/0']xpub/0/*)). HD rotation consumers materialize a concrete descriptor at a specific index themselves.

    Methods

    • Returns the compressed public key for this identity.

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Returns true when descriptor derives from this identity's xpub. HD descriptors match by account xpub; bare tr(pubkey) descriptors fall back to comparing against the index-0 x-only pubkey. See descriptorIsOurs.

      Parameters

      • descriptor: string

      Returns boolean

      Prefer DescriptorProvider.isOurs() via HDDescriptorProvider for rotating HD wallets or StaticDescriptorProvider for legacy single-key wallets.

    • Returns the x-only public key used by Taproot scripts.

      Returns Promise<Uint8Array<ArrayBufferLike>>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods