From 4b139030b6df0f31e493163bebd1ed52256f5c77 Mon Sep 17 00:00:00 2001 From: Tone Engel Date: Wed, 12 Feb 2025 10:22:00 -0500 Subject: [PATCH 1/3] avoid collapsing doc details not supported by pages --- docs/auth.md | 54 ---------------- docs/compat.md | 24 ------- docs/overlay-tools.md | 48 -------------- docs/primitives.md | 144 ------------------------------------------ docs/script.md | 48 -------------- docs/totp.md | 6 -- docs/transaction.md | 78 ----------------------- docs/wallet.md | 24 ------- ts2md.json | 10 +++ 9 files changed, 10 insertions(+), 426 deletions(-) diff --git a/docs/auth.md b/docs/auth.md index 39ad583d..c1292c33 100644 --- a/docs/auth.md +++ b/docs/auth.md @@ -129,10 +129,6 @@ export class AuthFetch { See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface) -
- -Class AuthFetch Details - #### Constructor Constructs a new AuthFetch instance. @@ -194,8 +190,6 @@ async sendCertificateRequest(baseUrl: string, certificatesToRequest: RequestedCe ``` See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -228,10 +222,6 @@ export default class Certificate { See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletProtocol](./wallet.md#type-walletprotocol), [sign](./compat.md#variable-sign), [verify](./compat.md#variable-verify) -
- -Class Certificate Details - #### Constructor Constructs a new Certificate. @@ -407,8 +397,6 @@ Returns - A promise that resolves to true if the signature is valid. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -483,10 +471,6 @@ export class MasterCertificate extends Certificate { See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCounterparty](./wallet.md#type-walletcounterparty) -
- -Class MasterCertificate Details - #### Method createCertificateFields Encrypts certificate fields for a subject and generates a master keyring. @@ -624,8 +608,6 @@ Throws Throws an error if any operation (e.g., encryption, signing) fails during certificate issuance. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -656,10 +638,6 @@ export class Peer { See also: [AuthMessage](./auth.md#interface-authmessage), [PeerSession](./auth.md#interface-peersession), [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [Transport](./auth.md#interface-transport), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface) -
- -Class Peer Details - #### Constructor Creates a new Peer instance @@ -886,8 +864,6 @@ Throws Will throw an error if the message fails to send. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -909,10 +885,6 @@ export class SessionManager { See also: [PeerSession](./auth.md#interface-peersession) -
- -Class SessionManager Details - #### Method addSession Adds a session to the manager, associating it with relevant identifiers for retrieval. @@ -990,8 +962,6 @@ Argument Details + **session** + The peer session to update. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1019,10 +989,6 @@ export class SimplifiedFetchTransport implements Transport { See also: [AuthMessage](./auth.md#interface-authmessage), [Transport](./auth.md#interface-transport) -
- -Class SimplifiedFetchTransport Details - #### Constructor Constructs a new instance of SimplifiedFetchTransport. @@ -1106,8 +1072,6 @@ Throws Will throw an error if no listener has been registered via `onData`. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1134,10 +1098,6 @@ export class VerifiableCertificate extends Certificate { See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex) -
- -Class VerifiableCertificate Details - #### Method decryptFields Decrypts selectively revealed certificate fields using the provided keyring and verifier wallet @@ -1160,8 +1120,6 @@ Throws Throws an error if any of the decryption operations fail, with a message indicating the failure context. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1186,10 +1144,6 @@ export async function createNonce(wallet: WalletInterface, counterparty: WalletC See also: [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface) -
- -Function createNonce Details - Returns A random nonce derived with a wallet @@ -1199,8 +1153,6 @@ Argument Details + **counterparty** + The counterparty to the nonce creation. Defaults to 'self'. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1214,10 +1166,6 @@ export async function verifyNonce(nonce: string, wallet: WalletInterface, counte See also: [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface) -
- -Function verifyNonce Details - Returns The status of the validation @@ -1229,8 +1177,6 @@ Argument Details + **counterparty** + The counterparty to the nonce creation. Defaults to 'self'. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/docs/compat.md b/docs/compat.md index c5fc4d58..f45bd130 100644 --- a/docs/compat.md +++ b/docs/compat.md @@ -34,10 +34,6 @@ export default class ECIES { See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey) -
- -Class ECIES Details - #### Method bitcoreDecrypt Decrypts a message encrypted using the Bitcore variant of ECIES. @@ -153,8 +149,6 @@ Argument Details + **pubKey** + The receiver's public key. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -193,10 +187,6 @@ export default class HD { See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey) -
- -Class HD Details - #### Constructor Constructor for the BIP32 HD wallet. @@ -455,8 +445,6 @@ Returns A base58 encoded string of the HD wallet. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -491,10 +479,6 @@ export default class Mnemonic { See also: [wordList](./compat.md#variable-wordlist) -
- -Class Mnemonic Details - #### Constructor Constructs a Mnemonic object. @@ -794,8 +778,6 @@ Returns The mnemonic phrase as a string. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -825,10 +807,6 @@ export default function fromUtxo(utxo: jsonUtxo, unlockingScriptTemplate: { See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](./transaction.md#interface-transactioninput), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign) -
- -Function fromUtxo Details - Argument Details + **utxo** @@ -836,8 +814,6 @@ Argument Details + **unlockingScriptTemplate** + : { sign: (tx: Transaction, inputIndex: number) => Promise, estimateLength: (tx: Transaction, inputIndex: number) => Promise } -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/docs/overlay-tools.md b/docs/overlay-tools.md index 6b1394a2..faf6696c 100644 --- a/docs/overlay-tools.md +++ b/docs/overlay-tools.md @@ -30,10 +30,6 @@ export interface AdmittanceInstructions { } ``` -
- -Interface AdmittanceInstructions Details - #### Property coinsRemoved The indices of all inputs from the provided transaction which reference previously-admitted outputs, @@ -59,8 +55,6 @@ The indices of all admissible outputs into the managed topic from the provided t outputsToAdmit: number[] ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -75,10 +69,6 @@ export interface LookupQuestion { } ``` -
- -Interface LookupQuestion Details - #### Property query The query which will be forwarded to the Lookup Service. @@ -96,8 +86,6 @@ The identifier for a Lookup Service which the person asking the question wishes service: string ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -116,10 +104,6 @@ export interface LookupResolverConfig { See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator) -
- -Interface LookupResolverConfig Details - #### Property additionalHosts Map of lookup service names to arrays of hosts to use in addition to resolving via SLAP. @@ -153,8 +137,6 @@ The list of SLAP trackers queried to resolve Overlay Services hosts for a given slapTrackers?: string[] ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -185,10 +167,6 @@ export interface OverlayLookupFacilitator { See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion) -
- -Interface OverlayLookupFacilitator Details - #### Property lookup Returns a lookup answer for a lookup question @@ -198,8 +176,6 @@ lookup: (url: string, question: LookupQuestion, timeout?: number) => Promise - Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -219,10 +195,6 @@ export interface SHIPBroadcasterConfig { See also: [LookupResolver](./overlay-tools.md#class-lookupresolver), [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator) -
- -Interface SHIPBroadcasterConfig Details - #### Property facilitator The facilitator used to make requests to Overlay Services hosts. @@ -265,8 +237,6 @@ resolver: LookupResolver ``` See also: [LookupResolver](./overlay-tools.md#class-lookupresolver) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -341,10 +311,6 @@ export default class LookupResolver { See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [LookupResolverConfig](./overlay-tools.md#interface-lookupresolverconfig) -
- -Class LookupResolver Details - #### Method query Given a LookupQuestion, returns a LookupAnswer. Aggregates across multiple services and supports resiliency. @@ -354,8 +320,6 @@ async query(question: LookupQuestion, timeout?: number): Promise ``` See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -383,10 +347,6 @@ export default class OverlayAdminTokenTemplate implements ScriptTemplate { See also: [LockingScript](./script.md#class-lockingscript), [PushDrop](./script.md#class-pushdrop), [ScriptTemplate](./script.md#interface-scripttemplate), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [WalletInterface](./wallet.md#interface-walletinterface), [sign](./compat.md#variable-sign) -
- -Class OverlayAdminTokenTemplate Details - #### Constructor Constructs a new Overlay Admin template instance @@ -467,8 +427,6 @@ Argument Details + **protocol** + SHIP or SLAP, depending on the token to unlock -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -485,10 +443,6 @@ export default class SHIPCast implements Broadcaster { See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig), [Transaction](./transaction.md#class-transaction) -
- -Class SHIPCast Details - #### Constructor Constructs an instance of the SHIP broadcaster. @@ -523,8 +477,6 @@ Argument Details + **tx** + The transaction to be sent. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/docs/primitives.md b/docs/primitives.md index fd88c667..101091b2 100644 --- a/docs/primitives.md +++ b/docs/primitives.md @@ -205,10 +205,6 @@ export default class BigNumber { See also: [ReductionContext](./primitives.md#class-reductioncontext), [toArray](./primitives.md#variable-toarray), [toHex](./primitives.md#variable-tohex) -
- -Class BigNumber Details - #### Constructor ```ts @@ -3525,8 +3521,6 @@ const bn = new BigNumber('8'); // binary: 1000 const zeroBits = bn.zeroBits(); // 3 ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -3627,10 +3621,6 @@ export default class DRBG { See also: [SHA256HMAC](./primitives.md#class-sha256hmac) -
- -Class DRBG Details - #### Method generate Generates deterministic random hexadecimal string of given length. @@ -3698,8 +3688,6 @@ Example drbg.update('e13af...'); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -3738,10 +3726,6 @@ export default class JacobianPoint extends BasePoint { See also: [BasePoint](./primitives.md#class-basepoint), [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point) -
- -Class JacobianPoint Details - #### Constructor Constructs a new `JacobianPoint` instance. @@ -4039,8 +4023,6 @@ const pointJ = new JacobianPoint('3', '4', '1'); const pointP = pointJ.toP(); // The point in affine coordinates. ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -4066,10 +4048,6 @@ export default class K256 extends Mersenne { See also: [BigNumber](./primitives.md#class-bignumber), [Mersenne](./primitives.md#class-mersenne) -
- -Class K256 Details - #### Constructor Constructor for the K256 class. @@ -4136,8 +4114,6 @@ const output = new BigNumber(0); k256.split(input, output); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -4185,10 +4161,6 @@ export default class Mersenne { See also: [BigNumber](./primitives.md#class-bignumber) -
- -Class Mersenne Details - #### Constructor ```ts @@ -4314,8 +4286,6 @@ Example mersenne.split(new BigNumber('2345', 16), new BigNumber()); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -4348,10 +4318,6 @@ export default class MontgomoryMethod extends ReductionContext { See also: [BigNumber](./primitives.md#class-bignumber), [ReductionContext](./primitives.md#class-reductioncontext) -
- -Class MontgomoryMethod Details - #### Constructor ```ts @@ -4537,8 +4503,6 @@ const montMethod = new MontgomoryMethod(m); const product = montMethod.mul(a, b); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -4594,10 +4558,6 @@ export default class Point extends BasePoint { See also: [BasePoint](./primitives.md#class-basepoint), [BigNumber](./primitives.md#class-bignumber), [encode](./primitives.md#variable-encode) -
- -Class Point Details - #### Constructor ```ts @@ -5170,8 +5130,6 @@ const aPoint = new Point(x, y); const isValid = aPoint.validate(); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -5189,10 +5147,6 @@ export class PointInFiniteField { See also: [BigNumber](./primitives.md#class-bignumber) -
- -Class PointInFiniteField Details - #### Method toString function toString() { [native code] } @@ -5201,8 +5155,6 @@ function toString() { [native code] } toString(): string ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -5273,10 +5225,6 @@ export default class PrivateKey extends BigNumber { See also: [BigNumber](./primitives.md#class-bignumber), [KeyShares](./primitives.md#class-keyshares), [Point](./primitives.md#class-point), [PublicKey](./primitives.md#class-publickey), [Signature](./primitives.md#class-signature), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify) -
- -Class PrivateKey Details - #### Constructor ```ts @@ -5737,8 +5685,6 @@ const signature = privateKey.sign('Hello, World!'); const isSignatureValid = privateKey.verify('Hello, World!', signature); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -5765,10 +5711,6 @@ export default class PublicKey extends Point { See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey), [Signature](./primitives.md#class-signature), [verify](./compat.md#variable-verify) -
- -Class PublicKey Details - #### Constructor ```ts @@ -6047,8 +5989,6 @@ const mySignature = new Signature(...) const isVerified = myPubKey.verify(myMessage, mySignature) ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -6075,10 +6015,6 @@ export class RIPEMD160 extends BaseHash { } ``` -
- -Class RIPEMD160 Details - #### Property h Array that is updated iteratively as part of hashing computation. @@ -6087,8 +6023,6 @@ Array that is updated iteratively as part of hashing computation. h: number[] ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -6159,10 +6093,6 @@ export default class ReductionContext { See also: [BigNumber](./primitives.md#class-bignumber), [Mersenne](./primitives.md#class-mersenne) -
- -Class ReductionContext Details - #### Constructor Constructs a new ReductionContext. @@ -6676,8 +6606,6 @@ this.verify2(new BigNumber(-10).toRed(this), new BigNumber(20).toRed(this)); //t this.verify2(new BigNumber(10).toRed(this), new BigNumber(20)); //throws an Error ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -6706,10 +6634,6 @@ export class SHA1 extends BaseHash { } ``` -
- -Class SHA1 Details - #### Property W Provides a way to recycle usage of the array memory. @@ -6734,8 +6658,6 @@ The round constants used for each round of SHA-1. k: number[] ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -6783,10 +6705,6 @@ export class SHA256 extends BaseHash { } ``` -
- -Class SHA256 Details - #### Property W Provides a way to recycle usage of the array memory. @@ -6811,8 +6729,6 @@ The round constants used for each round of SHA-256 k: number[] ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -6839,10 +6755,6 @@ export class SHA256HMAC { See also: [SHA256](./primitives.md#class-sha256) -
- -Class SHA256HMAC Details - #### Constructor The constructor for the `SHA256HMAC` class. @@ -6962,8 +6874,6 @@ Example myHMAC.update('deadbeef', 'hex'); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -6993,10 +6903,6 @@ export class SHA512 extends BaseHash { } ``` -
- -Class SHA512 Details - #### Property W Provides a way to recycle usage of the array memory. @@ -7021,8 +6927,6 @@ The round constants used for each round of SHA-512. k: number[] ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7049,10 +6953,6 @@ export class SHA512HMAC { See also: [SHA512](./primitives.md#class-sha512) -
- -Class SHA512HMAC Details - #### Constructor The constructor for the `SHA512HMAC` class. @@ -7172,8 +7072,6 @@ Example myHMAC.update('deadbeef', 'hex'); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7226,10 +7124,6 @@ export default class Schnorr { See also: [BigNumber](./primitives.md#class-bignumber), [Point](./primitives.md#class-point), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey) -
- -Class Schnorr Details - #### Method generateProof Generates a proof that demonstrates the link between public key A and shared secret S @@ -7286,8 +7180,6 @@ Argument Details + **proof** + Proof (R, S', z) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7318,10 +7210,6 @@ export default class Signature { See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey), [verify](./compat.md#variable-verify) -
- -Class Signature Details - #### Constructor Creates an instance of the Signature class. @@ -7580,8 +7468,6 @@ const publicKey = PublicKey.fromString('04188ca1050...'); const isVerified = signature.verify(msg, publicKey); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7601,10 +7487,6 @@ export default class SymmetricKey extends BigNumber { See also: [BigNumber](./primitives.md#class-bignumber), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt) -
- -Class SymmetricKey Details - #### Method decrypt Decrypts a given AES-GCM encrypted message using the same key that was used for encryption. @@ -7684,8 +7566,6 @@ Example const symmetricKey = SymmetricKey.fromRandom(); ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7721,10 +7601,6 @@ export default class TransactionSignature extends Signature { See also: [BigNumber](./primitives.md#class-bignumber), [Script](./script.md#class-script), [Signature](./primitives.md#class-signature), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput) -
- -Class TransactionSignature Details - #### Method hasLowS Compares to bitcoind's IsLowDERSignature @@ -7735,8 +7611,6 @@ See also Bip 62, "low S values in signatures" public hasLowS(): boolean ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7838,10 +7712,6 @@ Limited SHA-512-only PBKDF2 function for use in deprecated BIP39 code. export function pbkdf2(password: number[], salt: number[], iterations: number, keylen: number, digest = "sha512"): number[] ``` -
- -Function pbkdf2 Details - Returns The computed key @@ -7859,8 +7729,6 @@ Argument Details + **digest** + The digest (must be sha512 for this implementation) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7870,10 +7738,6 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions]( export function toArray(msg: number[] | string, enc?: "hex" | "utf8"): number[] ``` -
- -Function toArray Details - Returns array of byte values from msg. If msg is an array, a copy is returned. @@ -7883,8 +7747,6 @@ Argument Details + **enc** + Optional. Encoding to use if msg is string. Default is 'utf8'. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -7903,10 +7765,6 @@ console.log(toBase64(bytes)); // Outputs: SGVsbG8= export function toBase64(byteArray: number[]): string ``` -
- -Function toBase64 Details - Returns The base64 encoded string. @@ -7916,8 +7774,6 @@ Argument Details + **byteArray** + An array of numbers where each number is a byte (0-255). -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/docs/script.md b/docs/script.md index 98fc503d..093c5ae2 100644 --- a/docs/script.md +++ b/docs/script.md @@ -39,10 +39,6 @@ export default interface ScriptTemplate { See also: [LockingScript](./script.md#class-lockingscript), [ScriptTemplateUnlock](./script.md#interface-scripttemplateunlock) -
- -Interface ScriptTemplate Details - #### Property lock Creates a locking script with the given parameters. @@ -65,8 +61,6 @@ unlock: (...params: any[]) => ScriptTemplateUnlock ``` See also: [ScriptTemplateUnlock](./script.md#interface-scripttemplateunlock) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -116,10 +110,6 @@ export default class LockingScript extends Script { See also: [Script](./script.md#class-script) -
- -Class LockingScript Details - #### Method isLockingScript ```ts @@ -140,8 +130,6 @@ Returns Always returns false for a LockingScript instance. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -163,10 +151,6 @@ export default class P2PKH implements ScriptTemplate { See also: [LockingScript](./script.md#class-lockingscript), [PrivateKey](./primitives.md#class-privatekey), [Script](./script.md#class-script), [ScriptTemplate](./script.md#interface-scripttemplate), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign) -
- -Class P2PKH Details - #### Method lock Creates a P2PKH locking script for a given public key hash or address string @@ -219,8 +203,6 @@ Argument Details + **lockingScript** + Optional. The lockinScript. Otherwise the input.sourceTransaction is required. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -250,10 +232,6 @@ export default class PushDrop implements ScriptTemplate { See also: [LockingScript](./script.md#class-lockingscript), [PublicKey](./primitives.md#class-publickey), [ScriptTemplate](./script.md#interface-scripttemplate), [SecurityLevel](./wallet.md#type-securitylevel), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [WalletInterface](./wallet.md#interface-walletinterface), [sign](./compat.md#variable-sign) -
- -Class PushDrop Details - #### Constructor Constructs a new instance of the PushDrop class. @@ -359,8 +337,6 @@ Argument Details + **anyoneCanPay** + Specifies if the anyone-can-pay flag is set. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -384,10 +360,6 @@ export default class RPuzzle implements ScriptTemplate { See also: [BigNumber](./primitives.md#class-bignumber), [LockingScript](./script.md#class-lockingscript), [PrivateKey](./primitives.md#class-privatekey), [ScriptTemplate](./script.md#interface-scripttemplate), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign) -
- -Class RPuzzle Details - #### Constructor ```ts @@ -449,8 +421,6 @@ Argument Details + **anyoneCanPay** + Flag indicating if the signature allows for other inputs to be added later. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -486,10 +456,6 @@ export default class Script { See also: [BigNumber](./primitives.md#class-bignumber), [ScriptChunk](./script.md#interface-scriptchunk), [toHex](./primitives.md#variable-tohex) -
- -Class Script Details - #### Constructor ```ts @@ -759,8 +725,6 @@ Argument Details + **script** + The script to append. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -810,10 +774,6 @@ export default class Spend { See also: [LockingScript](./script.md#class-lockingscript), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [UnlockingScript](./script.md#class-unlockingscript) -
- -Class Spend Details - #### Constructor ```ts @@ -897,8 +857,6 @@ if (spend.validate()) { } ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -918,10 +876,6 @@ export default class UnlockingScript extends Script { See also: [Script](./script.md#class-script) -
- -Class UnlockingScript Details - #### Method isLockingScript ```ts @@ -942,8 +896,6 @@ Returns Always returns true for an UnlockingScript instance. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/docs/totp.md b/docs/totp.md index 863ba5d4..3e38eed3 100644 --- a/docs/totp.md +++ b/docs/totp.md @@ -35,10 +35,6 @@ export class TOTP { See also: [TOTPOptions](./totp.md#interface-totpoptions), [TOTPValidateOptions](./totp.md#type-totpvalidateoptions) -
- -Class TOTP Details - #### Method generate Generates a Time-based One-Time Password (TOTP). @@ -81,8 +77,6 @@ Argument Details + **options** + Optional parameters for TOTP validation. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables) --- diff --git a/docs/transaction.md b/docs/transaction.md index c4cc3074..3025fb26 100644 --- a/docs/transaction.md +++ b/docs/transaction.md @@ -36,10 +36,6 @@ export interface ArcConfig { See also: [HttpClient](./transaction.md#interface-httpclient) -
- -Interface ArcConfig Details - #### Property apiKey Authentication token for the ARC API @@ -89,8 +85,6 @@ httpClient?: HttpClient ``` See also: [HttpClient](./transaction.md#interface-httpclient) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -205,10 +199,6 @@ export interface FetchOptions { } ``` -
- -Interface FetchOptions Details - #### Property body An object or null to set request's body. @@ -233,8 +223,6 @@ A string to set request's method. method?: string ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -250,10 +238,6 @@ export interface HttpClient { See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse) -
- -Interface HttpClient Details - #### Property request Makes a request to the server. @@ -263,8 +247,6 @@ request: (url: string, options: HttpClientRequestOptions) = ``` See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -280,10 +262,6 @@ export interface HttpClientRequestOptions { } ``` -
- -Interface HttpClientRequestOptions Details - #### Property data An object or null to set request's body. @@ -308,8 +286,6 @@ A string to set request's method. method?: string ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -442,10 +418,6 @@ export interface WhatsOnChainConfig { See also: [HttpClient](./transaction.md#interface-httpclient) -
- -Interface WhatsOnChainConfig Details - #### Property apiKey Authentication token for the WhatsOnChain API @@ -463,8 +435,6 @@ httpClient?: HttpClient ``` See also: [HttpClient](./transaction.md#interface-httpclient) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -509,10 +479,6 @@ export default class ARC implements Broadcaster { See also: [ArcConfig](./transaction.md#interface-arcconfig), [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [Transaction](./transaction.md#class-transaction) -
- -Class ARC Details - #### Constructor Constructs an instance of the ARC broadcaster. @@ -581,8 +547,6 @@ Argument Details + **txs** + Array of transactions to be broadcasted. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -633,10 +597,6 @@ export class Beef { See also: [BEEF_V2](./transaction.md#variable-beef_v2), [BeefTx](./transaction.md#class-beeftx), [ChainTracker](./transaction.md#interface-chaintracker), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify) -
- -Class Beef Details - #### Method addComputedLeaves In some circumstances it may be helpful for the BUMP MerklePaths to include @@ -990,8 +950,6 @@ Argument Details + **allowTxidOnly** + optional. If true, transaction txid is assumed valid -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1031,10 +989,6 @@ export class BeefParty extends Beef { See also: [Beef](./transaction.md#class-beef) -
- -Class BeefParty Details - #### Constructor ```ts @@ -1120,8 +1074,6 @@ mergeBeefFromParty(party: string, beef: number[] | Beef): void ``` See also: [Beef](./transaction.md#class-beef) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1161,10 +1113,6 @@ export default class BeefTx { See also: [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer) -
- -Class BeefTx Details - #### Constructor ```ts @@ -1189,8 +1137,6 @@ Typically set by sorting transactions by proven dependency chains. isValid?: boolean = undefined ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1255,10 +1201,6 @@ export default class MerklePath { See also: [ChainTracker](./transaction.md#interface-chaintracker), [MerklePathLeaf](./transaction.md#interface-merklepathleaf), [Reader](./primitives.md#class-reader), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify) -
- -Class MerklePath Details - #### Method combine Combines this MerklePath with another to create a compound proof. @@ -1417,8 +1359,6 @@ Argument Details + **chainTracker** + The ChainTracker instance used to verify the Merkle root. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1452,10 +1392,6 @@ export default class SatoshisPerKilobyte implements FeeModel { See also: [FeeModel](./transaction.md#interface-feemodel), [Transaction](./transaction.md#class-transaction) -
- -Class SatoshisPerKilobyte Details - #### Constructor Constructs an instance of the sat/kb fee model. @@ -1487,8 +1423,6 @@ Argument Details + **tx** + The transaction for which a fee is to be computed. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1565,10 +1499,6 @@ export default class Transaction { See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [ChainTracker](./transaction.md#interface-chaintracker), [FeeModel](./transaction.md#interface-feemodel), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [SatoshisPerKilobyte](./transaction.md#class-satoshisperkilobyte), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster), [defaultChainTracker](./transaction.md#function-defaultchaintracker), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify) -
- -Class Transaction Details - #### Method addInput Adds a new input to the transaction. @@ -2063,8 +1993,6 @@ Example tx.verify(new WhatsOnChain(), new SatoshisPerKilobyte(1)) ``` -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -2084,10 +2012,6 @@ export default class WhatsOnChain implements ChainTracker { See also: [ChainTracker](./transaction.md#interface-chaintracker), [WhatsOnChainConfig](./transaction.md#interface-whatsonchainconfig) -
- -Class WhatsOnChain Details - #### Constructor Constructs an instance of the WhatsOnChain ChainTracker. @@ -2104,8 +2028,6 @@ Argument Details + **config** + Configuration options for the WhatsOnChain ChainTracker. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/docs/wallet.md b/docs/wallet.md index a7edfe07..cf1b9d6f 100644 --- a/docs/wallet.md +++ b/docs/wallet.md @@ -502,10 +502,6 @@ export interface KeyDeriverApi { See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol) -
- -Interface KeyDeriverApi Details - #### Property derivePrivateKey Derives a private key based on protocol ID, key ID, and counterparty. @@ -570,8 +566,6 @@ rootKey: PrivateKey ``` See also: [PrivateKey](./primitives.md#class-privatekey) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1197,10 +1191,6 @@ export interface WalletInterface { See also: [AbortActionArgs](./wallet.md#interface-abortactionargs), [AbortActionResult](./wallet.md#interface-abortactionresult), [AcquireCertificateArgs](./wallet.md#interface-acquirecertificateargs), [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [CreateActionArgs](./wallet.md#interface-createactionargs), [CreateActionResult](./wallet.md#interface-createactionresult), [CreateHmacArgs](./wallet.md#interface-createhmacargs), [CreateHmacResult](./wallet.md#interface-createhmacresult), [CreateSignatureArgs](./wallet.md#interface-createsignatureargs), [CreateSignatureResult](./wallet.md#interface-createsignatureresult), [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DiscoverCertificatesResult](./wallet.md#interface-discovercertificatesresult), [GetHeaderArgs](./wallet.md#interface-getheaderargs), [GetHeaderResult](./wallet.md#interface-getheaderresult), [GetHeightResult](./wallet.md#interface-getheightresult), [GetNetworkResult](./wallet.md#interface-getnetworkresult), [GetPublicKeyArgs](./wallet.md#interface-getpublickeyargs), [GetPublicKeyResult](./wallet.md#interface-getpublickeyresult), [GetVersionResult](./wallet.md#interface-getversionresult), [InternalizeActionArgs](./wallet.md#interface-internalizeactionargs), [InternalizeActionResult](./wallet.md#interface-internalizeactionresult), [ListActionsArgs](./wallet.md#interface-listactionsargs), [ListActionsResult](./wallet.md#interface-listactionsresult), [ListCertificatesArgs](./wallet.md#interface-listcertificatesargs), [ListCertificatesResult](./wallet.md#interface-listcertificatesresult), [ListOutputsArgs](./wallet.md#interface-listoutputsargs), [ListOutputsResult](./wallet.md#interface-listoutputsresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [ProveCertificateArgs](./wallet.md#interface-provecertificateargs), [ProveCertificateResult](./wallet.md#interface-provecertificateresult), [RelinquishCertificateArgs](./wallet.md#interface-relinquishcertificateargs), [RelinquishCertificateResult](./wallet.md#interface-relinquishcertificateresult), [RelinquishOutputArgs](./wallet.md#interface-relinquishoutputargs), [RelinquishOutputResult](./wallet.md#interface-relinquishoutputresult), [RevealCounterpartyKeyLinkageArgs](./wallet.md#interface-revealcounterpartykeylinkageargs), [RevealCounterpartyKeyLinkageResult](./wallet.md#interface-revealcounterpartykeylinkageresult), [RevealSpecificKeyLinkageArgs](./wallet.md#interface-revealspecifickeylinkageargs), [RevealSpecificKeyLinkageResult](./wallet.md#interface-revealspecifickeylinkageresult), [SignActionArgs](./wallet.md#interface-signactionargs), [SignActionResult](./wallet.md#interface-signactionresult), [VerifyHmacArgs](./wallet.md#interface-verifyhmacargs), [VerifyHmacResult](./wallet.md#interface-verifyhmacresult), [VerifySignatureArgs](./wallet.md#interface-verifysignatureargs), [VerifySignatureResult](./wallet.md#interface-verifysignatureresult), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletDecryptArgs](./wallet.md#interface-walletdecryptargs), [WalletDecryptResult](./wallet.md#interface-walletdecryptresult), [WalletEncryptArgs](./wallet.md#interface-walletencryptargs), [WalletEncryptResult](./wallet.md#interface-walletencryptresult), [decrypt](./messages.md#variable-decrypt), [encrypt](./messages.md#variable-encrypt) -
- -Interface WalletInterface Details - #### Property abortAction Aborts a transaction that is in progress and has not yet been finalized or sent to the network. @@ -1453,8 +1443,6 @@ waitForAuthentication: (args: object, originator?: OriginatorDomainNameStringUnd ``` See also: [AuthenticatedResult](./wallet.md#interface-authenticatedresult), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes) -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1546,10 +1534,6 @@ export default class CachedKeyDeriver { See also: [Counterparty](./wallet.md#type-counterparty), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol) -
- -Class CachedKeyDeriver Details - #### Constructor Initializes the CachedKeyDeriver instance with a root private key and optional cache settings. @@ -1689,8 +1673,6 @@ Argument Details + **keyID** + The key identifier. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- @@ -1955,10 +1937,6 @@ export class KeyDeriver implements KeyDeriverApi { See also: [Counterparty](./wallet.md#type-counterparty), [KeyDeriverApi](./wallet.md#interface-keyderiverapi), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [WalletProtocol](./wallet.md#type-walletprotocol) -
- -Class KeyDeriver Details - #### Constructor Initializes the KeyDeriver instance with a root private key. @@ -2087,8 +2065,6 @@ Argument Details + **keyID** + The key identifier. -
- Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables) --- diff --git a/ts2md.json b/ts2md.json index 4bfa9761..84daed4b 100644 --- a/ts2md.json +++ b/ts2md.json @@ -4,60 +4,70 @@ "inputFilename": "src/auth/index.ts", "outputFilename": "docs/auth.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "auth" }, { "inputFilename": "src/compat/index.ts", "outputFilename": "docs/compat.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "compat" }, { "inputFilename": "src/messages/index.ts", "outputFilename": "docs/messages.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "messages" }, { "inputFilename": "src/overlay-tools/index.ts", "outputFilename": "docs/overlay-tools.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "overlay-tools" }, { "inputFilename": "src/primitives/index.ts", "outputFilename": "docs/primitives.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "primitives" }, { "inputFilename": "src/script/index.ts", "outputFilename": "docs/script.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "script" }, { "inputFilename": "src/totp/index.ts", "outputFilename": "docs/totp.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "totp" }, { "inputFilename": "src/transaction/index.ts", "outputFilename": "docs/transaction.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "transaction" }, { "inputFilename": "src/wallet/index.ts", "outputFilename": "docs/wallet.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "wallet" }, { "inputFilename": "src/wallet/substrates/index.ts", "outputFilename": "docs/wallet-substrates.md", "firstHeadingLevel": 1, + "noDetailsSummary": true, "filenameSubString": "wallet/substrates" } ] From b0488fdd8022f377f99cc684b8a8869da1260c65 Mon Sep 17 00:00:00 2001 From: Tone Engel Date: Wed, 12 Feb 2025 10:22:16 -0500 Subject: [PATCH 2/3] 1.3.18 --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5219d8aa..1686571a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@bsv/sdk", - "version": "1.3.17", + "version": "1.3.18", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@bsv/sdk", - "version": "1.3.17", + "version": "1.3.18", "license": "SEE LICENSE IN LICENSE.txt", "devDependencies": { "@eslint/js": "^9.19.0", diff --git a/package.json b/package.json index 45905f73..8ed79367 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@bsv/sdk", - "version": "1.3.17", + "version": "1.3.18", "type": "module", "description": "BSV Blockchain Software Development Kit", "main": "dist/cjs/mod.js", From 61f35b1785d065f27e9e07e0cfa412a38774990e Mon Sep 17 00:00:00 2001 From: Tone Engel Date: Wed, 12 Feb 2025 10:24:29 -0500 Subject: [PATCH 3/3] changelog --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e550af09..8dcc1805 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -83,6 +83,14 @@ All notable changes to this project will be documented in this file. The format --- +## [1.3.18] - 2025-02-12 + +### Fixed + +- Avoid collapsing doc details. Not supported by github pages. + +--- + ## [1.3.17] - 2025-02-11 ### Fixed