Skip to content
This repository was archived by the owner on Jun 12, 2026. It is now read-only.

docs: clarify wallet implementations and fix typos #153

Merged
tonesnotes merged 1 commit into from
Apr 23, 2026
Merged

docs: clarify wallet implementations and fix typos #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ A [BRC-100](https://github.com/bitcoin-sv/BRCs/blob/master/wallet/0100.md) confo

The Wallet Toolbox is the reference implementation of the BRC-100 wallet interface. It connects the BSV SDK's cryptographic primitives to real storage backends, network services, and signing flows so that application developers don't have to wire these layers together themselves.

BSV Desktop and BSV Browser are the BSV Association reference wallet applications built around this interface. Vendor distributions, including Babbage's Metanet Desktop / Metanet Explorer and Hudos Browser, can implement the same BRC-100 interface against their own product packaging and service defaults.

### What's Inside

| Module | Description |
Expand Down
8 changes: 4 additions & 4 deletions docs/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15184,7 +15184,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
##### Class: WERR_REVIEW_ACTIONS

When a `createAction` or `signAction` is completed in undelayed mode (`acceptDelayedBroadcast`: false),
any unsucccessful result will return the results by way of this exception to ensure attention is
any unsuccessful result will return the results by way of this exception to ensure attention is
paid to processing errors.

```ts
Expand All @@ -15198,7 +15198,7 @@ See also: [ReviewActionResult](./client.md#interface-reviewactionresult), [Walle

###### Constructor

All parameters correspond to their comparable `createAction` or `signSction` results
All parameters correspond to their comparable `createAction` or `signAction` results
with the exception of `reviewActionResults`;
which contains more details, particularly for double spend results.

Expand Down Expand Up @@ -19607,7 +19607,7 @@ Indicates status of a new Action following a `createAction` or `signAction` in i
When `acceptDelayedBroadcast` is falses.

'success': The action has been broadcast and accepted by the bitcoin processing network.
'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.

Expand Down Expand Up @@ -19705,7 +19705,7 @@ Indicates status of a new Action following a `createAction` or `signAction` in i
When `acceptDelayedBroadcast` is falses.

'success': The action has been broadcast and accepted by the bitcoin processing network.
'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.

Expand Down
2 changes: 1 addition & 1 deletion docs/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5197,7 +5197,7 @@ Indicates status of a new Action following a `createAction` or `signAction` in i
When `acceptDelayedBroadcast` is falses.

'success': The action has been broadcast and accepted by the bitcoin processing network.
'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.

Expand Down
8 changes: 4 additions & 4 deletions docs/wallet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15184,7 +15184,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
##### Class: WERR_REVIEW_ACTIONS

When a `createAction` or `signAction` is completed in undelayed mode (`acceptDelayedBroadcast`: false),
any unsucccessful result will return the results by way of this exception to ensure attention is
any unsuccessful result will return the results by way of this exception to ensure attention is
paid to processing errors.

```ts
Expand All @@ -15198,7 +15198,7 @@ See also: [ReviewActionResult](./client.md#interface-reviewactionresult), [Walle

###### Constructor

All parameters correspond to their comparable `createAction` or `signSction` results
All parameters correspond to their comparable `createAction` or `signAction` results
with the exception of `reviewActionResults`;
which contains more details, particularly for double spend results.

Expand Down Expand Up @@ -19607,7 +19607,7 @@ Indicates status of a new Action following a `createAction` or `signAction` in i
When `acceptDelayedBroadcast` is falses.

'success': The action has been broadcast and accepted by the bitcoin processing network.
'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.

Expand Down Expand Up @@ -19705,7 +19705,7 @@ Indicates status of a new Action following a `createAction` or `signAction` in i
When `acceptDelayedBroadcast` is falses.

'success': The action has been broadcast and accepted by the bitcoin processing network.
'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.

Expand Down
4 changes: 2 additions & 2 deletions src/sdk/WERR_errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,12 @@ export class WERR_INVALID_PUBLIC_KEY extends WalletError {

/**
* When a `createAction` or `signAction` is completed in undelayed mode (`acceptDelayedBroadcast`: false),
* any unsucccessful result will return the results by way of this exception to ensure attention is
* any unsuccessful result will return the results by way of this exception to ensure attention is
* paid to processing errors.
*/
export class WERR_REVIEW_ACTIONS extends WalletError {
/**
* All parameters correspond to their comparable `createAction` or `signSction` results
* All parameters correspond to their comparable `createAction` or `signAction` results
* with the exception of `reviewActionResults`;
* which contains more details, particularly for double spend results.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/sdk/WalletStorage.interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ export interface StorageInternalizeActionResult extends InternalizeActionResult
* When `acceptDelayedBroadcast` is falses.
*
* 'success': The action has been broadcast and accepted by the bitcoin processing network.
* 'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
* 'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
* 'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
* 'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/storage/methods/attemptToPostReqsToNetwork.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ interface AggregatePostBeefTxResult {
* When `acceptDelayedBroadcast` is falses.
*
* 'success': The action has been broadcast and accepted by the bitcoin processing network.
* 'doulbeSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the loosing transaction.
* 'doubleSpend': The action has been confirmed to double spend one or more inputs, and by the "first-seen-rule" is the losing transaction.
* 'invalidTx': The action was rejected by the processing network as an invalid bitcoin transaction.
* 'serviceError': The broadcast services are currently unable to reach the bitcoin network. The action is now queued for delayed retries.
*
Expand Down
Loading