Templates 000,001,002 Submission

.github/workflows/codespell.yml

@@ -0,0 +1,56 @@
+# This is a basic workflow to help you get started with Actions
+name: codespell
+
+# Controls when the action will run.
+on: [push, pull_request]
+
+jobs:
+
+  ubuntu-site-matrix:
+    name: github-workspace
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+    steps:
+      - uses: styfle/cancel-workflow-action@0.11.0
+        if: ${{ !env.ACT }}
+        with:
+          access_token: ${{ github.token }}
+      - uses: actions/checkout@v3
+        with:
+          depth: '2'
+          submodules: 'true'
+          set-safe-directory: 'true'
+      - name: printenv
+        run: |
+          printenv
+      - name: install-codespell-asciidoctor
+        run: |
+          export DEBIAN_FRONTEND=noninteractive
+          sudo apt list --upgradable
+          sudo apt upgrade -y
+          sudo apt update -y
+          sudo apt install apt-utils asciidoctor python3-pip golang-go sed  -y
+          pip3 install -U codespell
+      - name: markdown-syntax
+        if: ${{ !env.ACT }}
+        run: |
+          git init
+          git grep -n --color $'\r' -- "*.md" && \
+          echo "^ Possible Windows style line ending detected. Please use Unix style line endings (\n)." && exit 0 || true
+          git grep -n --color ' $' -- "*.md" && echo "^ Trailing space detected at end of line. Please remove." && exit 0 || true
+          git grep  -n --color  $'\t' -- "*.md" && echo "^ Use of tabs detected. Please use space for indentation." && exit 0 || true
+          git grep -iE  -n --color '(^| )(\w+) \2(\.|,|:|;| |$)' -- "*.md" && \
+          echo "^ Detected lexical illusion in the form of a duplicated word. Please correct." && exit 0 || true
+          for FILE in $(git ls-files -- "*.md"); do if [[ $(tail -c1 $FILE) != "" ]]; then echo "File ${FILE} does not end with a newline character (\n)."; exit 0; fi; done
+          git grep "" -- "*.md" | uniq -c | grep -1 "^      [2-9] " | cut -b9- | sed 's/:$/:[more-than-one-blank-line-here-please-remove]/' | \
+          grep ":" && echo "^ Multiple blank lines detected. Please use only one blank line between paragraphs." && exit 0 || true
+      - name: codespell-md
+        if: ${{ !env.ACT }}
+        run: |
+          codespell --config .codespellrc --ignore-words .codespell-ignore $(git ls-files -- "*.md")
+      - name: codespell-html
+        if: ${{ !env.ACT }}
+        run: |
+          codespell --config .codespellrc --ignore-words .codespell-ignore $(git ls-files -- "*.html")

README.md

@@ -1,18 +1,46 @@
-# Miniscript Templates
-
+|[![](https://avatars.githubusercontent.com/u/7424983?s=30)](https://github.com/Blockstream/miniscript-templates)|[000](mint-000.md)|[001](mint-001.md)|[002](mint-002.md)|
+|----------|----------|----------|----------|
 
 ## About
 
-[Miniscript](https://bitcoin.sipa.be/miniscript/) is a language for composing Bitcoin Scripts in a structured way, facilitating analysis, composition, and generic signing. It's a simplified, composable subset of Bitcoin's Script language. Developed to overcome limitations in writing complex spending conditions directly in Bitcoin Script, it enables formal verification and offers a more human-friendly interface.
+[MiniScript](https://bitcoin.sipa.be/miniscript/) is a language for
+composing Bitcoin [Script](https://en.bitcoin.it/wiki/Script) in a
+structured way, facilitating analysis, composition, and generic signing.
+It\'s a simplified, composable subset of the Bitcoin
+[Script](https://en.bitcoin.it/wiki/Script) language. Developed to
+overcome limitations in writing complex spending conditions directly in
+Bitcoin [Script](https://en.bitcoin.it/wiki/Script), it enables formal
+verification and offers a more human-friendly interface.
+
+## Objectives
+
+1.  Each `MinT` (MiniScript Template) [^mint] [^mintt] will provide a common MiniScript policy.
+
+2.  Curate high quality example templates that demonstrate common use cases of
+    [MiniScript](https://raw.githubusercontent.com/bitcoin/bitcoin/master/src/script/miniscript.h)
+    policies.
+
+3.  Standardized implementations will establish best practices as well as promote uniform on-chain usage for better privacy.
+
+4.  Each `MinT` will be provided as is. While care is taken to ensure a high degree of quality. Developers and enthusiasts assume full responsibility for their usage [^use-at-your-own-risk].
+
+<!--
+
+Submission policy question:
+
+Can a developer submit a template
+under a different license?
+
+-->
+
+### Additional Resources
 
-## Goals
+[github.com/sipa/miniscript/tree/master](https://github.com/sipa/miniscript/tree/master )
 
-- Have reviewed templates that leverage miniscript to assure there are not unintended ways of executing a valid spend beyond the intended miniscript policy.
-- Have standardized usages of miniscript to streamline software and hardware wallet integrations.
-- Have uniform on-chain usage of miniscript templates for better privacy.
+[bitcoin.sipa.be/miniscript](https://bitcoin.sipa.be/miniscript )
 
-## Submission Format
+<!-- footnotes -->
 
-1. Name of Template
-2. Goal to be achieved by template
-3. Example Miniscript Output Descriptor
+[^mint]: MiniScript Template
+[^mintt]: MiniTapScript Template
+[^use-at-your-own-risk]: Use at your own risk.

mint-000.md

@@ -0,0 +1,119 @@
+# mint-000
+
+## Proposed Timelock Usage
+
+## Motivation
+
+[Miniscript](https://bitcoin.sipa.be/miniscript/) facilitates easier
+access to utilizing timelocks in Bitcoin, it opens a new frontier in
+Bitcoin security concerning the construction of more advanced Scripts.
+This document aims to standardize timelock application across different
+wallet solutions, focusing on wallet recovery and standardizing expected
+timelock usage for streamlined hardware and software wallet interfaces.
+
+In the event an output descriptor has been partially or fully lost,
+minimizing the overall search space for expected timestamp values can
+expedite recovery. General Miniscript usage supports any valid timelock
+value, this proposal seeks to guide implementation to more user-friendly
+practices.
+
+# Block height based Timelocks:
+
+## Absolute block height based Timelocks
+
+**Guideline**: Set absolute block height-based timelocks as multiples of
+100, always ending in 00.
+
+##### Examples of valid Block Height Absolute Timelocks
+
+**<code>after(1000)</code>**
+
+**<code>after(50700)</code>**
+
+**<code>after(82800)</code>**
+
+**<code>after(615000)</code>**
+
+## Relative block height based Timelocks
+
+**Guideline**: Make relative block height-based timelocks multiples of
+100, except for the maximum value, 65,536 (2\^16).
+
+**<code>older(100)</code>**
+
+**<code>older(1500)</code>**
+
+**<code>older(65535)</code>**
+
+# Epoch timestamp based Timelocks:
+
+## Absolute Epochtime based Timelocks
+
+**Guideline**: To synchronize with real-world time rather than block
+time, employ epoch timestamps that are divisible by 43200 (Noon GMT) or
+86400 (Midnight GMT). Optimally, use multiples of 604800 for Thursday at
+Midnight GMT.
+
+**Limitation**: Avoid setting epoch timestamps beyond 2105 (4291704000)
+to prevent any possible issue with related to its 32 bit unsigned
+integer used for timestamps to happen in February of 2106.
+
+##### Examples of valid Epoch Timestamp Absolute Timelocks
+
+**<code>after(1694476800)</code>** ***September 12th, 2023 Midnight GMT***
+
+**<code>after(1694520000)</code>** ***September 12th, 2023 Moon GMT***
+
+**<code>after(2160172800)</code>** ***June 15th, 2038 Midnight GMT***
+
+**<code>after(2234779200)</code>** ***October 25th, 2040 Noon GMT***
+
+## Relative Epochtime based Timelocks
+
+##### Examples of valid Block Height Relative Timelocks:
+
+Background:
+
+-   Following
+    [BIP68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki),
+    relative epoch timestamp timelocks can only go as far out as
+    33,554,431 seconds (1.06 years), as it is constrained by the same
+    units as relative block height timelocks, 65,536 (2\^16), where each
+    unit represents 512 seconds (8 minutes and 32 seconds) of time
+    (65,356 units \* 512 seconds = 33,554,432 seconds).
+
+-   An Epoch Timestamp is not valid until the network\'s MTP (Median
+    Time Past) of the past 11 blocks is greater than the epoch
+    timestamp, MTP is defined in:
+    [BIP113](https://github.com/bitcoin/bips/blob/master/bip-0113.mediawiki).
+
+-   The smallest value that can be used to have the miniscript compiler
+    interpret a relative timelock is older(4194305) (calculated by
+    following the BIP68 spec of: 1 \|= (1 \<\< 22)). This is a 1 unit
+    timelock of duration 512 seconds.
+
+-   The maximum value for a relative epoch timelock is older(4259839)
+    which is 65,535 unit timelock, resulting in 33,554,431 seconds, or
+    388 days.
+
+-   The 512 second incrementor is a common multiple for the amount of
+    seconds in 4 days, which is 675 units. To encourage intuitive usage
+    of relative timelocks, they should be multiples of 675.
+
+An exception should be made<br>
+- for the largest possible epoch timestamp relative timelock.
+
+**Proposal**: Starting at 4194304, increment by 675 (4 days), for
+relative epochtime timelocks, the maximum value being 4259839.
+
+##### Examples of valid Epoch Timestamp Absolute Timelocks
+
+**<code>older(4194979)</code>** ***4 days, minimum value***
+
+**<code>older(4214554)</code>** ***120 days***
+
+**<code>older(4224679)</code>** ***180 days***
+
+**<code>older(4255729)</code>** ***364 days***
+
+**<code>older(4259839)</code>** ***388 days, maximum value***