Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-24 14:49:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-03-23 16:45:58 +01:00
parent c4c0004c4a
commit 0d2deb1b63
780 changed files with 23664 additions and 18747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
modules/brk-client/docs/interfaces/AddrValidation.md Normal file
View File

@@ -0,0 +1,79 @@
[**brk-client**](../README.md)
***
[brk-client](../globals.md) / AddrValidation
# Interface: AddrValidation
Defined in: [Developer/brk/modules/brk-client/index.js:55](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L55)
## Properties
### address?
> `optional` **address?**: `string` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:57](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L57)
The validated address
***
### isscript?
> `optional` **isscript?**: `boolean` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:59](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L59)
Whether this is a script address (P2SH)
***
### isvalid
> **isvalid**: `boolean`
Defined in: [Developer/brk/modules/brk-client/index.js:56](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L56)
Whether the address is valid
***
### iswitness?
> `optional` **iswitness?**: `boolean` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:60](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L60)
Whether this is a witness address
***
### scriptPubKey?
> `optional` **scriptPubKey?**: `string` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:58](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L58)
The scriptPubKey in hex
***
### witnessProgram?
> `optional` **witnessProgram?**: `string` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:62](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L62)
Witness program in hex
***
### witnessVersion?
> `optional` **witnessVersion?**: `number` \| `null`
Defined in: [Developer/brk/modules/brk-client/index.js:61](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L61)
Witness version (0 for P2WPKH/P2WSH, 1 for P2TR)