XO Stack

Appearance

Documentation / @xo-cash/templates

@xo-cash/templates ​

XO templates

⚠️ This project is in early development phase. Use it only if you understand what you are doing and accept the risks. Do not use funds you are not willing to lose. Minor version bumps may introduce breaking changes

Installation ​

bash
npm install @xo-cash/templates

Usage ​

typescript
import { p2pkhTemplate } from '@xo-cash/templates';

License ​

MIT - See LICENSE for details.

faucetCashTemplate ​

ts
const faucetCashTemplate: XOTemplate;

Defined in: source/faucet_cash.ts:3

multisigTemplate ​

ts
const multisigTemplate: XOTemplate;

Defined in: source/experimental/multisig.ts:10

A 2 of 3 vault. Each signer generates its own key and provides its public key as a variable, and the vault locking script is built from the three public keys. Receive pays that script. Any two signers can spend it.

The redeem script is wrapped as pay to script hash 32 by the locking type. Each spend path pushes a Schnorr bit field and a Schnorr signature from each of the two signer keys, in key order.

p2pkhTemplate ​

ts
const p2pkhTemplate: XOTemplate;

Defined in: source/p2pkh.ts:3

wrapBCHChipnetTemplate ​

ts
const wrapBCHChipnetTemplate: XOTemplate;

Defined in: source/wrapped_cash_chipnet.ts:9

Encodes the user parts of the https://wrapped.cash/ use case as an XO template.

The bootstrap ceremony is not encoded in this template, but the final categoryId is properly encoded here and ensure we are operating with the correct token.

wrapBCHTemplate ​

ts
const wrapBCHTemplate: XOTemplate;

Defined in: source/wrapped_cash.ts:9

Encodes the user parts of the https://wrapped.cash/ use case as an XO template.

The bootstrap ceremony is not encoded in this template, but the final categoryId is properly encoded here and ensure we are operating with the correct token.