Set Up Your Project

You’re viewing an old version of the Arkade contracts documentation. Go to Your first contract for the current version.

Every page in this tab starts from the code below. It connects to the operator on Mutinynet, a Bitcoin test network, so you can fund contracts with test coins.

pnpm add @arkade-os/sdk @scure/base @scure/btc-signer

import {
  RestArkProvider,
  RestIndexerProvider,
  CSVMultisigTapscript,
  type RelativeTimelock,
} from '@arkade-os/sdk';
import { hex } from '@scure/base';

const arkProvider = new RestArkProvider('https://mutinynet.arkade.sh');
const indexerProvider = new RestIndexerProvider('https://mutinynet.arkade.sh');
const info = await arkProvider.getInfo();

// The operator's signer key, as a 32-byte x-only key
const serverPubkey = hex.decode(info.signerPubkey).slice(1);

// The shortest delay an exit path may use
const exitTimelock: RelativeTimelock = {
  type: info.unilateralExitDelay < 512n ? 'blocks' : 'seconds',
  value: info.unilateralExitDelay,
};

// The operator's checkpoint path, needed to build every spend
const serverUnrollScript = CSVMultisigTapscript.decode(hex.decode(info.checkpointTapscript));

The SDK is built on the @scure libraries. Use @scure/base for hex and base64, and @scure/btc-signer for raw scripts.

Path helpers

Build each path with one of these SDK helpers. Each one writes exactly the script shape the operator accepts (Spending path rules).

Helper	Path
`MultisigTapscript`	N-of-N signatures
`CLTVMultisigTapscript`	N-of-N signatures after an absolute time
`ConditionMultisigTapscript`	A condition, such as a hash preimage, then N-of-N signatures
`CSVMultisigTapscript`	N-of-N signatures after a relative delay
`ConditionCSVMultisigTapscript`	A condition, then N-of-N signatures after a relative delay
`VtxoScript`	Combines the paths into a Taproot tree and gives its address

Overview

Working with Tapscript

Experimental

Path helpers

​Path helpers

Path helpers