Skip to content

Commit

Permalink
updated descriptions for miniscript templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Max Gravitt committed Oct 5, 2023
1 parent 7f20c30 commit b0513b0
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 11 deletions.
2 changes: 1 addition & 1 deletion src/miniscript-templates/decaying-multisig.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Description
Decaying multisig is a custody technique where the number of keys required to move the funds decreases over time. For example, a 3 of 3 multisig may decay to only need 2 of the 3 keys after 1 year, and then to 1 of the 3 keys after 5 years.

One use case for this is mitigating against loss of funds due to key loss. If a key is lost, the owner only needs to wait until the next decay step to recover the funds. Another use case is for losening consensus for co-managed assets. For example, a board of directors may generally require a higher threshold (67%) to spend funds, but decrease that over time (to 51%) to avoid allowing a subset of signers to deadlock the funds.
One use case for this is mitigating against loss of funds due to key loss. If a key is lost, the owner only needs to wait until the next decay step to recover the funds. Another use case is for loosening consensus for co-managed assets. For example, a board of directors may generally require a higher threshold (67%) to spend funds, but decrease that over time (to 51%) to avoid allowing a subset of signers to deadlock the funds.

## Vault Configuration Example
All 3 signers are needed to spend. After 10,000 blocks, the `after` block meets one of the threshold's conditions, so only 2 signatures are needed to unlock the funds. Finally, after 20,000 blocks, 2 conditions are met by the `after` statements and only 1 additional signature is needed.
Expand Down
30 changes: 27 additions & 3 deletions src/miniscript-templates/hold.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# Hold Template
- use case description
- screenshot of vault editor
- miniscript template code
## Description
Hodl time locks let’s user set specific time intervals, with a maximum of 24 months, during which their bitcoin remains locked.

The hodl time lock feature prevents impulsive selling during market fluctuations and allows users to stick to their investment strategy.


## Vault Configuration Example


## Inputs

## Miniscript

```
```

## Output Descriptor
```
```

### Example
Example Output Descriptor
```
```
31 changes: 27 additions & 4 deletions src/miniscript-templates/m-of-n.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,27 @@
# M-of-N Template
- use case description
- screenshot of vault editor
- miniscript template code
# Collaborative Custody Template
## Description
Collaborative custody allows users to configure the number of co-signers and the threshold required to access the vault’s bitcoin.

Users can choose a 2 of 3, 3 of 5, or a custom configuration, this feature ensures that multiple trusted parties agree before a transaction takes place. It's an ideal solution for shared ownership and collaborative arrangements.

## Vault Configuration Example


## Inputs

## Miniscript

```
```

## Output Descriptor
```
```

### Example
Example Output Descriptor
```
```
29 changes: 26 additions & 3 deletions src/miniscript-templates/social-recovery.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,27 @@
# Social Recovery Template
- use case description
- screenshot of vault editor
- miniscript template code
## Description
Social recovery keeps you in full and exclusive control of your bitcoin while enabling a recovery path in case you lose your keys. After a predefined number of months set by the user, an m of n multisig of trusted co-signers is able to move the user funds

Between 20%-25% of all bitcoin has been lost forever by owners who lost their keys. This security feature helps you have a plan B, leveraging trusted connections like friends, family, or colleagues to regain access to your Bitcoin

## Vault Configuration Example


## Inputs

## Miniscript

```
```

## Output Descriptor
```
```

### Example
Example Output Descriptor
```
```

0 comments on commit b0513b0

Please sign in to comment.