tapscripts - GitLite

KO | EN

gitlite — search

#javascript #react #ai #golang #machine-learning #deep-learning #docker #nodejs #macos #windows #awesome #cli #kubernetes #awesome-list

tapscripts

(★ 79)

No description available.

File Explorer

Download Latest Version (.zip)

- boarding.miniscript
- unroll.miniscript
- vtxo.miniscript
boarding.hack
forfeit.hack
LICENSE
Makefile
README.md
redeem.hack
sweep.hack
unroll.hack

# Installation Guide

1. Get the code

git clone https://github.com/arkade-os/tapscripts

Downloads the entire project code from GitHub to your computer.

cd tapscripts

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Rust (rustup) Rust is required to use cargo.

cargo install miniscript-compiler

Builds and installs the package published on crates.io — no need to clone the repo yourself.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make unroll

Compiles the code based on the generated build configuration to produce an executable.

make onboarding

Compiles the code based on the generated build configuration to produce an executable.

make vtxo

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Ark Taproot Scripts

## Script tree

Ark virtual transaction outputs (VTXO) are created by a shared output. This output is enforcing the value to be splitted into a binary tree of other taproot scripts.

```mermaid
graph TD
    A[Shared Out ROOT]
    A --> B[Shared out 1]
    A --> C[Shared out 2]
    B --> D[Shared out 3]
    B --> E[Shared out 4]
    C --> F[Shared out 5]
    C --> G[Shared out 6]
    D --> H((VTXO 1))
    E --> I((VTXO 2))
    F --> J((VTXO 3))
    G --> K((VTXO 4))
```

_Each node of the diagram is a taproot script._

### Shared output script

A shared output is a bitcoin transaction output locked by a taproot script with 2 tapscript closures:

* [Unroll](./unroll.hack) and [Boarding](./boarding.hack) scripts use [Elements introspections opcodes](https://github.com/ElementsProject/elements/blob/master/doc/tapscript_opcodes.md) to force the spending transaction format. The tx creates the next level of the script tree on-chain. Splitting the value into 2 outputs with the children taproot scripts.
* [Sweep](./sweep.hack) lets the Ark Service Provider to spend the whole shared output after a timeout (CSV).

### VTXO script

A VTXO taproot script is the last level of the script tree. It should appear on-chain only if the VTXO owner decided to unilaterally exit the Ark. It has 2 tapscript closures:

* [Redeem](./redeem.hack) lets to spend the VTXO onchain after a CSV delay. the delay prevents the ASP to lost a VTXO spent off-chain.
* [Forfeit](./forfeit.hack) expects both parties (owner and ASP) to sign the spending transaction. It is used to spend the VTXO **off-chain**.

### Miniscript

The scripts are written using miniscript syntax. You can analyse them using the [Elements Miniscript compiler](https://github.com/louisinger/miniscript-compiler).

install the miniscript-compiler:

```bash
cargo install miniscript-compiler
```

Compile miniscript examples:

```bash
make unroll 
make onboarding
make vtxo
```