Main Navigation Home Installation Change Log

Appearance

Sidebar Navigation

Getting Started

Installation

Configuration

Usage

Diagrams

Packages

@did-btcr2/api

Enumerations

IdentifierTypes

Classes

BitcoinApi

CryptoApi

DidApi

DidBtcr2Api

DidDocument

DidDocumentBuilder

Identifier

KeyPairApi

MultikeyApi

Interfaces

BlockV3

DidVerificationMethod

PatchOperation

RawTransactionV2

RestClientConfigParams

RpcClientConfig

Type Aliases

ApiConfig

BitcoinApiConfig

Bytes

CryptosuiteName

DidResolutionResult

DidService

DocumentBytes

HashBytes

Hex

JSONObject

KeyBytes

MultikeyObject

NetworkName

ProofBytes

SchnorrKeyPairObject

SignatureBytes

Functions

createApi

@did-btcr2/bitcoin

Enumerations

VerbosityLevel

Classes

BitcoinAddress

BitcoinBlock

BitcoinCoreRpcClient

BitcoinNetworkConnection

BitcoinRestClient

BitcoinRestError

BitcoinRpcClientConfig

BitcoinRpcError

BitcoinTransaction

JsonRpcTransport

RestClientConfig

TapRootMultiSig

Interfaces

AddressInfo

AddressUtxo

BitcoinRpcClient

BlockHashOptions

BlockV1

BlockV2

BlockV3

ChainStats

ClientConstructorOption

FetchedRawTransaction

GetBlockParams

MempoolStats

RawTransactionRest

RawTransactionV1

RawTransactionV2

RestApiCallParams

RestClientConfigParams

RestResponse

ReturnFormatOptions

RpcClientConfig

TxInExt

Vin

Vout

Type Aliases

AddedNodeInfo

AddMultiSigAddressParams

AddressGrouping

AvailableNetworks

BatchOption

BitcoinClientConfig

BitcoinNetworkConfig

BitcoinNetworkConfigMap

BitcoinRecipient

BitcoinSignature

Block

BlockHeader

BlockHeight

BlockResponse

BlockV0

BumpFeeOption

BumpFeeOptions

BumpFeeResult

ChainInfo

ChainTip

CreateMultisigParams

CreateMultisigResult

CreateMultiSigResult

CreateRawTxInputs

CreateRawTxOutputs

CreateRawTxParams

CreateWalletDescriptorOptions

CreateWalletDescriptorsResult

CreateWalletParams

CreateWalletResult

DecodedRawTransaction

DecodedScript

DerivedAddresses

FeeEstimateMode

FundRawTxOptions

FundRawTxResult

GetUTXOsResult

ImportDescriptorRequest

ImportDescriptorResult

ImportMultiOptions

ImportMultiRequest

ImportMultiResult

Input

JsonRPCError

ListSinceBlockResult

ListTransactionsParams

ListTransactionsResult

ListUnspentOptions

ListUnspentParams

MemoryStats

MempoolContent

MempoolInfo

MethodNameInLowerCase

MiningInfo

NetTotals

NetworkInfo

Outpoint

PeerInfo

PrevOut

RawOutputAddr

RawOutputData

RawTransactionResponse

RawTransactionV0

Received

ReceivedByAccount

ReceivedByAddress

Recipients

RestExtension

ReturnType

ScanBlocksParams

ScriptDecoded

scriptPubkeyType

SendAllOptions

SendAllParams

SendAllResult

SendManyParams

SendToAddressResult

SigHashType

SignedRawTx

SignRawTxParams

SolvingData

Transaction

TransactionInListSinceBlock

TransactionStatus

TxId

TxIn

TxInPrevout

TxOut

TxOutForCreateRaw

TxOutInBlock

TxStats

UnspentTxInfo

UTXO

UTXOStats

ValidateAddressResult

WalletDescriptor

WalletInfo

WalletTransaction

WalletTxBase

Variables

bitcoin

COINBASE_MATURITY_DELAY

DEFAULT_BITCOIN_NETWORK_CONFIG

DEFAULT_BLOCK_CONFIRMATIONS

GENESIS_TX_ID

HALVING_INTERVAL

INITIAL_BLOCK_REWARD

TXIN_WITNESS_COINBASE

Functions

getNetwork

safeText

toBase64

@did-btcr2/cli

Classes

DidBtcr2Cli

Interfaces

ICommand

@did-btcr2/common

Enumerations

BitcoinNetworkNames

Env

IdentifierHrp

IdentifierTypes

MethodErrorCode

Classes

Canonicalization

CanonicalizationError

CIDAggregateBeaconError

CryptosuiteError

DidDocumentError

DidMethodError

KeyManagerError

KeyPairError

Logger

MethodError

MultikeyError

NotImplementedError

Patch

ProofError

PublicKeyError

ResolveError

SecretKeyError

SingletonBeaconError

SMTAggregateBeaconError

Interfaces

BeaconSignal

DidBtcr2RootCapability

DidUpdateBundle

DidUpdateInvocation

DidUpdatePayload

PatchOperation

Proof

ProofOptions

SidecarData

SignalSidecarData

SmtProof

Type Aliases

Base58BtcPrefix

BeaconType

BeaconUri

Bip340Encoding

Bytes

CanonicalizableObject

CanonicalizationAlgorithm

CanonicalizedProofConfig

CompressedPublicKeyParityByte

Context

ContextObject

CryptosuiteName

DateTimestamp

Day

DecentralizedIdentifier

Did

DidPlaceholder

DocumentBytes

Entropy

ErrorOptions

HashBytes

HashHex

HdWallet

Hex

Hours

JSONObject

JsonPatch

KeyBytes

Level

Maybe

MessageBytes

Minutes

Month

MultibaseObject

PatchOpCode

Point

ProofBytes

Prototyped

PublicKeyObject

SchnorrKeyPair

SchnorrKeyPairObject

Seconds

SecretKeyObject

SignatureBytes

SignatureHex

ThreeDigits

TwoDigits

TzOffset

UnixTimestamp

Unprototyped

UtcTimestamp

Year

Variables

a

b

B256

BIP340_PUBLIC_KEY_MULTIBASE_PREFIX

BIP340_PUBLIC_KEY_MULTIBASE_PREFIX_HASH

BIP340_SECRET_KEY_MULTIBASE_PREFIX

BIP340_SECRET_KEY_MULTIBASE_PREFIX_HASH

BTCR2_DID_DOCUMENT_CONTEXT

BTCR2_DID_UPDATE_PAYLOAD_CONTEXT

BTCR2_METHOD_CONTEXT

BTCR2_MULTIKEY_CONTEXT

canonicalization

COINBASE_MATURITY_DELAY

CONTEXT_URL_MAP

CURVE

DEFAULT_BLOCK_CONFIRMATIONS

DEFAULT_REST_CONFIG

DEFAULT_RPC_CONFIG

Gx

Gy

HALVING_INTERVAL

ID_PLACEHOLDER_VALUE

INITIAL_BLOCK_REWARD

INTERNAL_ERROR

INVALID_CHALLENGE_ERROR

INVALID_DID

INVALID_DID_DOCUMENT

INVALID_DID_DOCUMENT_LENGTH

INVALID_DID_UPDATE

INVALID_DID_URL

INVALID_DOMAIN_ERROR

INVALID_PREVIOUS_DID_PROOF

INVALID_PUBLIC_KEY

INVALID_PUBLIC_KEY_LENGTH

INVALID_PUBLIC_KEY_MULTIBASE

INVALID_PUBLIC_KEY_TYPE

INVALID_SIDECAR_DATA

INVALID_SIGNATURE

LATE_PUBLISHING_ERROR

METHOD_NOT_SUPPORTED

MULTIBASE_URI_PREFIX

n

N

NODE_ENV

NOT_FOUND

OP_PUSH32

OP_RETURN

p

P

POLAR_ALICE_CLIENT_CONFIG

POLAR_BOB_CLIENT_CONFIG

PROOF_GENERATION_ERROR

PROOF_PARSING_ERROR

PROOF_SERIALIZATION_ERROR

PROOF_VERIFICATION_ERROR

REPRESENTATION_NOT_SUPPORTED

UNSUPPORTED_PUBLIC_KEY_TYPE

VALID_HRP

VERIFICATION_METHOD_ERROR

W3C_DATA_INTEGRITY_V1

W3C_DATA_INTEGRITY_V2

W3C_DID_RESOLUTION_V1

W3C_DID_V1

W3C_DID_V1_1

W3C_JSONLD_PATCH_V1

W3C_MULTIKEY_V1

W3C_SECURITY_V2

W3C_ZCAP_V1

@did-btcr2/cryptosuite

Classes

Cryptosuite

DataIntegrityProof

SchnorrMultikey

Interfaces

CreateProofParams

CryptosuiteParams

DidParams

FromPublicKey

FromPublicKeyMultibaseParams

FromSecretKey

GenerateHashParams

ICryptosuite

IDataIntegrityProof

Multikey

ProofSerializationParams

ProofVerificationParams

TransformDocumentParams

VerificationResult

VerifyProofParams

Type Aliases

AddProofParams

MultikeyObject

@did-btcr2/keypair

Classes

CompressedSecp256k1PublicKey

SchnorrKeyPair

Secp256k1SecretKey

Interfaces

KeyPair

MultibaseKeys

Point

PublicKey

SchnorrKeyPairParams

SecretKey

Type Aliases

CryptoOptions

HexSchnorrKeyPair

RawSchnorrKeyPair

@did-btcr2/kms

Classes

Kms

MemoryStore

Signer

Interfaces

KeyManager

KeyValueStore

Type Aliases

KeyIdentifier

@did-btcr2/method

Enumerations

COHORT_STATUS

SIGNING_SESSION_STATUS

Classes

AggregateBeaconCohort

AggregateBeaconError

AggregateBeaconMessage

Appendix

BaseMessage

Beacon

BeaconCohortAdvertMessage

BeaconCohortAggregatedNonceMessage

BeaconCohortAuthorizationRequestMessage

BeaconCohortNonceContributionMessage

BeaconCohortOptInAcceptMessage

BeaconCohortOptInMessage

BeaconCohortReadyMessage

BeaconCohortRequestSignatureMessage

BeaconCohortSignatureAuthorizationMessage

BeaconCohortSigningSession

BeaconCohortSubscribeMessage

BeaconCoordinator

BeaconCoordinatorError

BeaconError

BeaconFactory

BeaconParticipant

BeaconParticipantError

BeaconUtils

CIDAggregateBeacon

CIDAggregateBeaconError

CommunicationAdapterError

CommunicationFactory

CommunicationServiceError

Deactivate

DidBtcr2

DidCommAdapter

DidCommAdapterConfig

DidDocument

DidDocumentBuilder

DidVerificationMethod

Document

GeneralUtils

Identifier

IntermediateDidDocument

NostrAdapter

Resolve

SingletonBeacon

SingletonBeaconError

SMTAggregateBeacon

SMTAggregateBeaconError

Update

Interfaces

ApplyDidUpdateParams

BeaconCohort

BeaconService

BeaconServiceAddress

BeaconSignal

CIDAggregateSidecar

CohortAdvertMessage

CohortAggregatedNonceMessage

CohortAuthorizationRequestMessage

CohortNonceContributionMessage

CohortOptInAcceptMessage

CohortOptInMessage

CohortReadyMessage

CohortSubscribeMessage

CommunicationService

ConstructUpdateParams

DidComponents

DidCreateOptions

DidResolutionOptions

GenerateBeaconParams

GenerateBeaconServicesParams

GenerateBitcoinAddrsParams

IBeacon

IDidDocument

IDidVerificationMethod

NostrAdapterConfig

ReadBlockchainParams

ResolveCas

ResolveDeterministic

ResolveExternal

ResolveSidecar

RootCapability

Service

ServiceAdapterConfig

Sidecar

SigningSession

SingletonSidecar

SMTAggregateSidecar

TargetBlockheightParams

TargetDocumentParams

UpdateParams

Type Aliases

AggregateBeaconMessageType

AsyncMessageHandler

Base

BaseBody

BeaconSidecarData

BeaconSignals

BitcoinClient

Btcr2Identifier

COHORT_STATUS_TYPE

CohortRequestSignatureMessage

CohortSignatureAuthorizationMessage

CommunicationServiceType

ExternalData

FindNextSignals

FindNextSignalsRestParams

GetSigningMethodParams

InvokePayloadParams

KeyGenMessageType

MessageHandler

Metadata

Musig2CohortObject

NetworkVersion

ResolveInitialDocument

ServiceAdapter

ServiceAdapterConfigType

ServiceAdapterIdentity

SidecarData

SignalSidecarData

SignalsMetadata

SIGNING_SESSION_STATUS_TYPE

SignMessageType

SyncMessageHandler

VerificationRelationships

Variables

BEACON_COHORT_ADVERT

BEACON_COHORT_AGGREGATED_NONCE

BEACON_COHORT_AUTHORIZATION_REQUEST

BEACON_COHORT_MESSAGE_PREFIX

BEACON_COHORT_NONCE_CONTRIBUTION

BEACON_COHORT_OPT_IN

BEACON_COHORT_OPT_IN_ACCEPT

BEACON_COHORT_READY

BEACON_COHORT_REQUEST_SIGNATURE

BEACON_COHORT_SIGNATURE_AUTHORIZATION

BECH32M_CHARS

DEFAULT_NOSTR_RELAYS

DID_REGEX

MESSAGE_PREFIX

Functions

bigEndianToInt

intToBigEndian

@did-btcr2/smt

Classes

Branch

Leaf

NodeFactory

Sha256Strategy

SparseMerkleTree

Interfaces

HashStrategy

Node

Variables

EMPTY_LEAF

HASH_SIZE

MAX_TREE_LEVELS

ZERO_NODE_HASH

Functions

bitIndex

bufferEq

encodeBigUint64BE

initEmptyLeaf

makeKey

sha256

On this page

Variable: INVALID_DID

INVALID_DID: INVALID_DID

Defined in: packages/common/src/errors.ts:86

Pager

Previous pageINVALID_CHALLENGE_ERROR

Next pageINVALID_DID_DOCUMENT

Variable: INVALID_DID ​

Variable: INVALID_DID