Skip to content

Commit

Permalink
docs: update btc README for pubkeyMap
Browse files Browse the repository at this point in the history
  • Loading branch information
ShookLyngs committed Jun 18, 2024
1 parent af42947 commit 2e61e73
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions packages/btc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,7 @@ interface SendUtxosProps {

// EXPERIMENTAL: the below props are unstable and can be altered at any time
skipInputsValidation?: boolean;
pubkeyMap?: AddressToPubkeyMap;
}
```

Expand Down Expand Up @@ -352,7 +353,7 @@ interface SendRgbppUtxosProps {
excludeUtxos?: BaseOutput[];

// EXPERIMENTAL: the below props are experimental and can be altered at any time
onlyProvableUtxos?: boolean;
pubkeyMap?: AddressToPubkeyMap;
}
```

Expand Down Expand Up @@ -386,7 +387,7 @@ interface SendRbfProps {
requireGreaterFeeAndRate?: boolean;

// EXPERIMENTAL: the below props are experimental and can be altered at any time
inputsPubkey?: Record<string, string>; // Record<address, pubkey>
pubkeyMap?: AddressToPubkeyMap;
}
```

Expand Down Expand Up @@ -513,3 +514,9 @@ enum NetworkType {
REGTEST,
}
```

#### AddressToPubkeyMap

```typescript
type AddressToPubkeyMap = Record<string, string>;
```

0 comments on commit 2e61e73

Please sign in to comment.