feat: add sbtc contract and initialization

Author: obycode

Clarinet.toml

@@ -9,7 +9,10 @@ cache_dir = './.cache'
 contract_id = 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.sip-010-trait-ft-standard'
 
 [[project.requirements]]
-contract_id = "SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-token-0-6-0.stackflow-token"
+contract_id = "SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-token-0-6-0"
+
+[[project.requirements]]
+contract_id = "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-deposit"
 
 [contracts.reservoir]
 path = 'contracts/reservoir.clar'
@@ -21,6 +24,11 @@ path = 'contracts/stackflow.clar'
 clarity_version = 4
 epoch = "3.3"
 
+[contracts.stackflow-sbtc]
+path = 'contracts/stackflow.clar'
+clarity_version = 4
+epoch = "3.3"
+
 [contracts.stackflow-token]
 path = 'contracts/stackflow-token.clar'
 clarity_version = 4

README.md

@@ -519,6 +519,15 @@ For Clarinet devnet, set the observer in `settings/Devnet.toml`:
 stacks_node_events_observers = ["host.docker.internal:8787"]
 ```
 
+Devnet contracts and initialization plan:
+
+1. deployment plan: `deployments/default.devnet-plan.yaml` (publishes `stackflow` and `stackflow-sbtc`)
+2. the same devnet plan also runs post-deploy `init` contract calls:
+   - `stackflow` with `none` token (STX mode)
+   - `stackflow-sbtc` with `ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-token`
+3. optional/manual fallback: `./init-stackflow.sh`
+4. full plan details: `deployments/DEVNET_STACKFLOW_SBTC_PLAN.md`
+
 Open the built-in UI in your browser:
 
 ```text
@@ -601,7 +610,9 @@ It includes forms/buttons for:
 4. `force-cancel`
 5. structured transfer message signing + payload JSON builder
 6. principal resolution for `.btc` names (for example `brice.btc`) via BNSv2 API
-7. preset Stackflow contract selection with token auto-fill for official STX/sBTC mainnet contracts
+7. network-aware preset Stackflow contract selection with token auto-fill:
+   - devnet: `ST1...stackflow` and `ST1...stackflow-sbtc`
+   - mainnet: official `stackflow-0-6-0` and `stackflow-sbtc-0-6-0`
 
 To publish with GitHub Pages (no build step):
 

deployments/default.devnet-plan.yaml

@@ -18,6 +18,41 @@ plan:
     epoch: '2.0'
   - id: 1
     transactions:
+    - transaction-type: requirement-publish
+      contract-id: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-registry
+      remap-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      remap-principals:
+        SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      cost: 112090
+      path: .cache/requirements/SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-registry.clar
+      clarity-version: 3
+    - transaction-type: requirement-publish
+      contract-id: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token
+      remap-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      remap-principals:
+        SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      cost: 47590
+      path: .cache/requirements/SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token.clar
+      clarity-version: 3
+    - transaction-type: requirement-publish
+      contract-id: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-deposit
+      remap-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      remap-principals:
+        SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      cost: 41510
+      path: .cache/requirements/SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-deposit.clar
+      clarity-version: 3
+    epoch: '3.0'
+  - id: 2
+    transactions:
+    - transaction-type: requirement-publish
+      contract-id: SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-token-0-6-0
+      remap-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      remap-principals:
+        SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      cost: 43920
+      path: .cache/requirements/SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-token-0-6-0.clar
+      clarity-version: 4
     - transaction-type: contract-publish
       contract-name: stackflow-token
       expected-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
@@ -35,7 +70,14 @@ plan:
     - transaction-type: contract-publish
       contract-name: stackflow
       expected-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
-      cost: 520800
+      cost: 519850
+      path: contracts/stackflow.clar
+      anchor-block-only: true
+      clarity-version: 4
+    - transaction-type: contract-publish
+      contract-name: stackflow-sbtc
+      expected-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      cost: 519850
       path: contracts/stackflow.clar
       anchor-block-only: true
       clarity-version: 4
@@ -46,4 +88,20 @@ plan:
       path: contracts/test-token.clar
       anchor-block-only: true
       clarity-version: 4
+  - id: 3
+    transactions:
+    - transaction-type: contract-call
+      contract-id: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stackflow
+      expected-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      method: init
+      parameters:
+      - none
+      cost: 10000
+    - transaction-type: contract-call
+      contract-id: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stackflow-sbtc
+      expected-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      method: init
+      parameters:
+      - "(some 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.sbtc-token)"
+      cost: 10000
     epoch: '3.3'

deployments/default.simnet-plan.yaml

@@ -65,11 +65,34 @@ plan:
     - transaction-type: emulated-contract-publish
       contract-name: sip-010-trait-ft-standard
       emulated-sender: SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE
-      path: ./.cache/requirements/SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.sip-010-trait-ft-standard.clar
+      path: .cache/requirements/SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE.sip-010-trait-ft-standard.clar
       clarity-version: 1
     epoch: '2.0'
   - id: 1
     transactions:
+    - transaction-type: emulated-contract-publish
+      contract-name: sbtc-registry
+      emulated-sender: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4
+      path: .cache/requirements/SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-registry.clar
+      clarity-version: 3
+    - transaction-type: emulated-contract-publish
+      contract-name: sbtc-token
+      emulated-sender: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4
+      path: .cache/requirements/SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token.clar
+      clarity-version: 3
+    - transaction-type: emulated-contract-publish
+      contract-name: sbtc-deposit
+      emulated-sender: SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4
+      path: .cache/requirements/SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-deposit.clar
+      clarity-version: 3
+    epoch: '3.0'
+  - id: 2
+    transactions:
+    - transaction-type: emulated-contract-publish
+      contract-name: stackflow-token-0-6-0
+      emulated-sender: SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV
+      path: .cache/requirements/SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-token-0-6-0.clar
+      clarity-version: 4
     - transaction-type: emulated-contract-publish
       contract-name: stackflow-token
       emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
@@ -85,6 +108,11 @@ plan:
       emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
       path: contracts/stackflow.clar
       clarity-version: 4
+    - transaction-type: emulated-contract-publish
+      contract-name: stackflow-sbtc
+      emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+      path: contracts/stackflow.clar
+      clarity-version: 4
     - transaction-type: emulated-contract-publish
       contract-name: test-token
       emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM

docs/app.js

@@ -22,15 +22,49 @@ const DEFAULT_API_BY_NETWORK = {
 
 const STACKFLOW_MESSAGE_VERSION = "0.6.0";
 const BNSV2_API_BASE = "https://api.bnsv2.com";
-const CONTRACT_PRESETS = {
-  "stx-mainnet": {
-    contractId: "SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-0-6-0",
-    tokenContract: "",
-  },
-  "sbtc-mainnet": {
-    contractId: "SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-sbtc-0-6-0",
-    tokenContract: "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token",
-  },
+const CONTRACT_PRESETS_BY_NETWORK = {
+  devnet: [
+    {
+      key: "stx-devnet",
+      label: "STX (devnet default)",
+      contractId: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stackflow",
+      tokenContract: "",
+    },
+    {
+      key: "sbtc-devnet",
+      label: "sBTC (devnet default)",
+      contractId: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stackflow-sbtc",
+      tokenContract: "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.test-token",
+    },
+  ],
+  testnet: [
+    {
+      key: "stx-testnet",
+      label: "STX (testnet default)",
+      contractId: "ST126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT59ZTE2J.stackflow-0-6-0",
+      tokenContract: "",
+    },
+    {
+      key: "sbtc-testnet",
+      label: "sBTC (testnet default)",
+      contractId: "ST126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT59ZTE2J.stackflow-sbtc-0-6-0",
+      tokenContract: "",
+    },
+  ],
+  mainnet: [
+    {
+      key: "stx-mainnet",
+      label: "STX (mainnet default)",
+      contractId: "SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-0-6-0",
+      tokenContract: "",
+    },
+    {
+      key: "sbtc-mainnet",
+      label: "sBTC (mainnet default)",
+      contractId: "SP126XFZQ3ZHYM6Q6KAQZMMJSDY91A8BTT6AD08RV.stackflow-sbtc-0-6-0",
+      tokenContract: "SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token",
+    },
+  ],
 };
 
 const elements = {
@@ -482,22 +516,46 @@ function updateNetworkDefaults() {
   }
 }
 
-function getPresetKeyByValues(contractId, tokenContract) {
+function getPresetsForNetwork(network = readNetwork()) {
+  return CONTRACT_PRESETS_BY_NETWORK[network] || [];
+}
+
+function findPresetByKey(presetKey, network = readNetwork()) {
+  return getPresetsForNetwork(network).find((preset) => preset.key === presetKey) || null;
+}
+
+function renderPresetOptions(network = readNetwork()) {
+  const presets = getPresetsForNetwork(network);
+  const selected = normalizedText(elements.contractPreset.value) || "custom";
+  const options = [
+    ...presets.map((preset) => `<option value="${preset.key}">${preset.label}</option>`),
+    '<option value="custom">Custom (manual)</option>',
+  ];
+  elements.contractPreset.innerHTML = options.join("");
+
+  if (presets.some((preset) => preset.key === selected) || selected === "custom") {
+    elements.contractPreset.value = selected;
+  } else {
+    elements.contractPreset.value = "custom";
+  }
+}
+
+function getPresetKeyByValues(contractId, tokenContract, network = readNetwork()) {
   const contractText = normalizedText(contractId);
   const tokenText = normalizedText(tokenContract);
-  for (const [presetKey, preset] of Object.entries(CONTRACT_PRESETS)) {
+  for (const preset of getPresetsForNetwork(network)) {
     if (
       normalizedText(preset.contractId) === contractText &&
       normalizedText(preset.tokenContract) === tokenText
     ) {
-      return presetKey;
+      return preset.key;
     }
   }
   return "custom";
 }
 
 function applyContractPreset(presetKey, { log = true } = {}) {
-  const preset = CONTRACT_PRESETS[presetKey];
+  const preset = findPresetByKey(presetKey);
   if (!preset) {
     return;
   }
@@ -821,10 +879,28 @@ function wireEvents() {
   elements.buildPayload.addEventListener("click", handleBuildPayload);
   elements.copyOutput.addEventListener("click", handleCopyOutput);
   elements.network.addEventListener("change", () => {
+    const previousPresetKey = elements.contractPreset.value;
     elements.stacksApiUrl.value = DEFAULT_API_BY_NETWORK[readNetwork()];
+    renderPresetOptions();
+    if (previousPresetKey !== "custom") {
+      const presets = getPresetsForNetwork();
+      if (presets.length > 0) {
+        elements.contractPreset.value = presets[0].key;
+        applyContractPreset(presets[0].key);
+      }
+      return;
+    }
+    elements.contractPreset.value = getPresetKeyByValues(
+      elements.contractId.value,
+      elements.tokenContract.value,
+    );
   });
   elements.contractPreset.addEventListener("change", () => {
-    applyContractPreset(elements.contractPreset.value);
+    const presetKey = elements.contractPreset.value;
+    if (presetKey === "custom") {
+      return;
+    }
+    applyContractPreset(presetKey);
   });
   elements.contractId.addEventListener("input", () => {
     elements.contractPreset.value = getPresetKeyByValues(
@@ -843,9 +919,15 @@ function wireEvents() {
 async function bootstrap() {
   wireEvents();
   updateNetworkDefaults();
+  renderPresetOptions();
   if (!normalizedText(elements.contractId.value) && !normalizedText(elements.tokenContract.value)) {
-    elements.contractPreset.value = "stx-mainnet";
-    applyContractPreset("stx-mainnet", { log: false });
+    const presets = getPresetsForNetwork();
+    if (presets.length > 0) {
+      elements.contractPreset.value = presets[0].key;
+      applyContractPreset(presets[0].key, { log: false });
+    } else {
+      elements.contractPreset.value = "custom";
+    }
   } else {
     elements.contractPreset.value = getPresetKeyByValues(
       elements.contractId.value,

docs/index.html

@@ -39,8 +39,6 @@ <h2>Config</h2>
           <label>
             Contract Preset
             <select id="contract-preset">
-              <option value="stx-mainnet">STX (mainnet default)</option>
-              <option value="sbtc-mainnet">sBTC (mainnet default)</option>
               <option value="custom">Custom (manual)</option>
             </select>
           </label>

init-stackflow.sh

@@ -8,5 +8,8 @@ set -euo pipefail
 
 STACKS_NETWORK="${STACKS_NETWORK:-devnet}" \
 STACKS_API_URL="${STACKS_API_URL:-http://localhost:3999}" \
+STACKFLOW_INIT_MODE="${STACKFLOW_INIT_MODE:-devnet-both}" \
 STACKFLOW_CONTRACT_ID="${STACKFLOW_CONTRACT_ID:-ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stackflow}" \
+STACKFLOW_SBTC_CONTRACT_ID="${STACKFLOW_SBTC_CONTRACT_ID:-ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.stackflow-sbtc}" \
+STACKFLOW_SBTC_TOKEN_CONTRACT_ID="${STACKFLOW_SBTC_TOKEN_CONTRACT_ID:-ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.test-token}" \
 npm run init:stackflow

scripts/deploy.js

@@ -47,6 +47,11 @@ const CONTRACTS = [
     kind: "stackflow",
     file: "../contracts/stackflow.clar",
   },
+  {
+    name: `stackflow-sbtc-${VERSION_TAG}`,
+    kind: "stackflow",
+    file: "../contracts/stackflow.clar",
+  },
   {
     name: `reservoir-${VERSION_TAG}`,
     kind: "reservoir",