Class Btc1Identifier

Index

Constructors

Methods

Constructors

constructor

new Btc1Identifier(): Btc1Identifier
Returns Btc1Identifier

Methods

`Static`decode

decode(identifier: string): DidComponents
Implements 3.3 did:btc1 Identifier Decoding.
Parameters
- identifier: string
  The BTC1 DID to be parsed
Returns DidComponents
The parsed identifier components. See DidComponents for details.

Throws
if an error occurs while parsing the identifier

Throws
if identifier is invalid

Throws
if the method is not supported
- Defined in packages/method/src/utils/identifier.ts:116

`Static`encode

encode(
    params: {
        genesisBytes: Uint8Array;
        idType: string;
        network: string | number;
        version: number;
    },
): string
Implements 3.2 did:btc1 Identifier Encoding.

A did:btc1 DID consists of a did:btc1 prefix, followed by an id-bech32 value, which is a Bech32m encoding of:
- the specification version;
- the Bitcoin network identifier; and
- either:
  - a key-value representing a secp256k1 public key; or
  - a hash-value representing the hash of an initiating external DID document.
Parameters
- params: {
      genesisBytes: Uint8Array;
      idType: string;
      network: string | number;
      version: number;
  }
  See CreateIdentifierParams for details.
  - genesisBytes: Uint8Array
    Public key or an intermediate document bytes.
  - idType: string
    Identifier type (key or external).
  - network: string | number
    Bitcoin network name.
  - version: number
    Identifier version.
Returns string
The new did:btc1 identifier.
- Defined in packages/method/src/utils/identifier.ts:24