Class BeaconUtils

Static class of utility functions for the Beacon Service BeaconUtils

Index

Constructors

Methods

generateBeacon generateBeaconAddresses generateBeaconService generateBeaconServiceCustom generateBeaconServices getBeaconServiceAddressMap getBeaconServiceIds getBeaconServices isBeaconService manufactureBeacon parseBitcoinAddress toBeaconServiceAddress

Constructors

constructor

new BeaconUtils(): BeaconUtils
Returns BeaconUtils

Methods

`Static`generateBeacon

generateBeacon(
    params: {
        identifier: string;
        network: Network;
        publicKey: Bytes;
        type: string;
    },
): BeaconService
Generate a single beacon service.
Parameters
- params: { identifier: string; network: Network; publicKey: Bytes; type: string }
  Required parameters for generating a single Beacon Service.
  - identifier: string
    The identifier for the beacon service.
  - network: Network
    The name of the Bitcoin network to use.
  - publicKey: Bytes
    Byte array representation of a public key used to generate a new btc1 key-id-type.
  - type: string
    The type of beacon service to create.
Returns BeaconService
A BeaconService object.

Throws
if the bitcoin address is invalid.
- Defined in packages/method/src/utils/beacons.ts:219

`Static`generateBeaconAddresses

generateBeaconAddresses(
params: { identifier: string; network: Network; publicKey: Bytes },
): string[][]
Generate all 3 Beacon Service Endpoints for a given public key.
Parameters
- params: { identifier: string; network: Network; publicKey: Bytes }
  Required parameters for generating Beacon Services.
  - identifier: string
  - network: Network
    Bitcoin network interface from bitcoinlib-js.
  - publicKey: Bytes
    Public key bytes used to generate the beacon object serviceEndpoint.
Returns string[][]
2D Array of bitcoin addresses (p2pkh, p2wpkh, p2tr).

Throws
if the bitcoin address is invalid.
- Defined in packages/method/src/utils/beacons.ts:97

`Static`generateBeaconService

generateBeaconService(
    params: {
        addressType: "p2pkh" | "p2wpkh" | "p2tr";
        id: string;
        network: Network;
        publicKey: Bytes;
        type: string;
    },
): BeaconService
Generate a set of Beacon Services for a given public key.
Parameters
- params: {
      addressType: "p2pkh" | "p2wpkh" | "p2tr";
      id: string;
      network: Network;
      publicKey: Bytes;
      type: string;
  }
  Required parameters for generating Beacon Services.
  - addressType: "p2pkh" | "p2wpkh" | "p2tr"
    The type of address to create (p2pkh, p2wpkh, p2tr).
  - id: string
  - network: Network
    Bitcoin network interface from bitcoinlib-js.
  - publicKey: Bytes
    Public key bytes used to generate the beacon object serviceEndpoint.
  - type: string
Returns BeaconService
A BeaconService object.

Throws
if the bitcoin address is invalid.
- Defined in packages/method/src/utils/beacons.ts:130

`Static`generateBeaconServiceCustom

generateBeaconServiceCustom(
    params: {
        addressType: "p2pkh" | "p2wpkh" | "p2tr";
        id: string;
        network: Network;
        publicKey: Bytes;
        type: string;
    },
): BeaconService
Generate a custom Beacon Service.
Parameters
- params: {
      addressType: "p2pkh" | "p2wpkh" | "p2tr";
      id: string;
      network: Network;
      publicKey: Bytes;
      type: string;
  }
  Required parameters for generating Beacon Services.
Returns BeaconService
- Defined in packages/method/src/utils/beacons.ts:158

`Static`generateBeaconServices

generateBeaconServices(
    params: {
        identifier: string;
        network: Network;
        publicKey: Bytes;
        type: string;
    },
): BeaconService[]
Generate beacon services.
Parameters
- params: { identifier: string; network: Network; publicKey: Bytes; type: string }
  Required parameters for generating Beacon Services.
  - identifier: string
  - network: Network
    The name of the Bitcoin network to use.
  - publicKey: Bytes
    Byte array representation of a public key used to generate a new btc1 key-id-type.
  - type: string
Returns BeaconService[]
Array of DidService objects.
- Defined in packages/method/src/utils/beacons.ts:189

`Static`getBeaconServiceAddressMap

getBeaconServiceAddressMap(
beacons: BeaconService[],
): Map<string, BeaconServiceAddress>
Create a map of address => beaconService with address field.
Parameters
- beacons: BeaconService[]
  The list of beacon services.
Returns Map<string, BeaconServiceAddress>
A map of address => beaconService.
- Defined in packages/method/src/utils/beacons.ts:267

`Static`getBeaconServiceIds

getBeaconServiceIds(didDocument: Btc1DidDocument): string[]
Get the beacon service ids from a list of beacon services.
Parameters
- didDocument: Btc1DidDocument
  The DID Document to extract the services from.
Returns string[]
An array of beacon service ids.
- Defined in packages/method/src/utils/beacons.ts:277

`Static`getBeaconServices

getBeaconServices(didDocument: DidDocument): BeaconService[]
Extracts the services from a given DID Document
Parameters
- didDocument: DidDocument
  The DID Document to extract the services from
Returns BeaconService[]
An array of DidService objects

Throws
if the didDocument is not provided
- Defined in packages/method/src/utils/beacons.ts:82

`Static`isBeaconService

isBeaconService(obj: any): boolean
Validates that the given object is a Beacon Service
Parameters
- obj: any
  The object to validate
Returns boolean
A boolean indicating whether the object is a Beacon Service
- Defined in packages/method/src/utils/beacons.ts:59

`Static`manufactureBeacon

manufactureBeacon(params: BeaconService): BeaconService
Manufacture a pre-filled Beacon using the BeaconFactory.
Parameters
- params: BeaconService
  Required parameters for generating a single Beacon Service.
Returns BeaconService
One BeaconService object.
- Defined in packages/method/src/utils/beacons.ts:249

`Static`parseBitcoinAddress

parseBitcoinAddress(uri: string): string
Converts a BIP21 Bitcoin URI to a Bitcoin address
Parameters
- uri: string
  The BIP21 Bitcoin URI to convert
Returns string
The Bitcoin address extracted from the URI

Throws
if the URI is not a valid Bitcoin URI
- Defined in packages/method/src/utils/beacons.ts:47

`Static`toBeaconServiceAddress

toBeaconServiceAddress(beacons: BeaconService[]): BeaconServiceAddress[]
Convert beacon service endpoints from BIP-21 URIs to addresses.
Parameters
- beacons: BeaconService[]
  The list of beacon services.
Returns BeaconServiceAddress[]
An array of beacon services with address: bitcoinAddress.
- Defined in packages/method/src/utils/beacons.ts:258

Class BeaconUtils

Index

Constructors

Methods

Constructors

constructor

Returns BeaconUtils

Methods

StaticgenerateBeacon

Parameters

identifier: string

network: Network

publicKey: Bytes

type: string

Returns BeaconService

Throws

StaticgenerateBeaconAddresses

Parameters

identifier: string

network: Network

publicKey: Bytes

Returns string[][]

Throws

StaticgenerateBeaconService

Parameters

addressType: "p2pkh" | "p2wpkh" | "p2tr"

id: string

network: Network

publicKey: Bytes

type: string

Returns BeaconService

Throws

StaticgenerateBeaconServiceCustom

Parameters

Returns BeaconService

StaticgenerateBeaconServices

Parameters

identifier: string

network: Network

publicKey: Bytes

type: string

Returns BeaconService[]

StaticgetBeaconServiceAddressMap

Parameters

Returns Map<string, BeaconServiceAddress>

StaticgetBeaconServiceIds

Parameters

Returns string[]

StaticgetBeaconServices

Parameters

Returns BeaconService[]

Throws

StaticisBeaconService

Parameters

Returns boolean

StaticmanufactureBeacon

Parameters

Returns BeaconService

StaticparseBitcoinAddress

Parameters

Returns string

Throws

StatictoBeaconServiceAddress

Parameters

Returns BeaconServiceAddress[]

Settings

On This Page

`Static`generateBeacon

`Static`generateBeaconAddresses

`Static`generateBeaconService

`Static`generateBeaconServiceCustom

`Static`generateBeaconServices

`Static`getBeaconServiceAddressMap

`Static`getBeaconServiceIds

`Static`getBeaconServices

`Static`isBeaconService

`Static`manufactureBeacon

`Static`parseBitcoinAddress

`Static`toBeaconServiceAddress