@caatinga/cli 0.2.3 → 2.0.0

package/templates/react-vite-counter/contracts/counter/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "counter"
+version = "0.1.0"
+rust-version = "1.84.0"
+edition = "2021"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+soroban-sdk = "22.0.1"
+
+[dev-dependencies]
+soroban-sdk = { version = "22.0.1", features = ["testutils"] }
+
+[profile.release]
+opt-level = "z"
+overflow-checks = true
+debug = 0
+strip = "symbols"
+debug-assertions = false
+panic = "abort"
+codegen-units = 1
+lto = true

package/templates/react-vite-counter/contracts/counter/src/lib.rs

@@ -0,0 +1,100 @@
+#![no_std]
+
+use soroban_sdk::{contract, contracterror, contractimpl, contracttype, Env};
+
+const INSTANCE_TTL_THRESHOLD: u32 = 100;
+const INSTANCE_TTL_EXTEND_TO: u32 = 518_400;
+
+#[contracttype]
+#[derive(Clone)]
+pub enum DataKey {
+    Count,
+}
+
+#[contracterror]
+#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
+#[repr(u32)]
+pub enum CounterError {
+    Overflow = 1,
+}
+
+#[contract]
+pub struct CounterContract;
+
+fn refresh_instance_ttl(env: &Env) {
+    env.storage()
+        .instance()
+        .extend_ttl(INSTANCE_TTL_THRESHOLD, INSTANCE_TTL_EXTEND_TO);
+}
+
+#[contractimpl]
+impl CounterContract {
+    pub fn get(env: Env) -> u32 {
+        let count = env.storage().instance().get(&DataKey::Count).unwrap_or(0);
+        refresh_instance_ttl(&env);
+        count
+    }
+
+    pub fn increment(env: Env) -> Result<u32, CounterError> {
+        let count = Self::get(env.clone())
+            .checked_add(1)
+            .ok_or(CounterError::Overflow)?;
+
+        env.storage().instance().set(&DataKey::Count, &count);
+        refresh_instance_ttl(&env);
+
+        Ok(count)
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+    use soroban_sdk::Env;
+
+    #[test]
+    fn increments_counter() {
+        let env = Env::default();
+        let contract_id = env.register(CounterContract, ());
+        let client = CounterContractClient::new(&env, &contract_id);
+
+        assert_eq!(client.get(), 0);
+        assert_eq!(client.increment(), 1);
+        assert_eq!(client.get(), 1);
+    }
+
+    #[test]
+    fn get_returns_zero_before_increment() {
+        let env = Env::default();
+        let contract_id = env.register(CounterContract, ());
+        let client = CounterContractClient::new(&env, &contract_id);
+
+        assert_eq!(client.get(), 0);
+    }
+
+    #[test]
+    fn repeated_increments_preserve_state() {
+        let env = Env::default();
+        let contract_id = env.register(CounterContract, ());
+        let client = CounterContractClient::new(&env, &contract_id);
+
+        assert_eq!(client.increment(), 1);
+        assert_eq!(client.increment(), 2);
+        assert_eq!(client.increment(), 3);
+        assert_eq!(client.get(), 3);
+    }
+
+    #[test]
+    fn increment_returns_overflow_error() {
+        let env = Env::default();
+        let contract_id = env.register(CounterContract, ());
+        let client = CounterContractClient::new(&env, &contract_id);
+
+        env.as_contract(&contract_id, || {
+            env.storage().instance().set(&DataKey::Count, &u32::MAX);
+        });
+
+        assert_eq!(client.try_increment(), Err(Ok(CounterError::Overflow)));
+        assert_eq!(client.get(), u32::MAX);
+    }
+}

package/templates/react-vite-counter/contracts/counter/test_snapshots/test/get_returns_zero_before_increment.1.json

@@ -0,0 +1,76 @@
+{
+  "generators": {
+    "address": 1,
+    "nonce": 0
+  },
+  "auth": [
+    [],
+    []
+  ],
+  "ledger": {
+    "protocol_version": 22,
+    "sequence_number": 0,
+    "timestamp": 0,
+    "network_id": "0000000000000000000000000000000000000000000000000000000000000000",
+    "base_reserve": 0,
+    "min_persistent_entry_ttl": 4096,
+    "min_temp_entry_ttl": 16,
+    "max_entry_ttl": 6312000,
+    "ledger_entries": [
+      [
+        {
+          "contract_data": {
+            "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+            "key": "ledger_key_contract_instance",
+            "durability": "persistent"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_data": {
+                "ext": "v0",
+                "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+                "key": "ledger_key_contract_instance",
+                "durability": "persistent",
+                "val": {
+                  "contract_instance": {
+                    "executable": {
+                      "wasm": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+                    },
+                    "storage": null
+                  }
+                }
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ],
+      [
+        {
+          "contract_code": {
+            "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_code": {
+                "ext": "v0",
+                "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+                "code": ""
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ]
+    ]
+  },
+  "events": []
+}

package/templates/react-vite-counter/contracts/counter/test_snapshots/test/increment_returns_overflow_error.1.json

@@ -0,0 +1,91 @@
+{
+  "generators": {
+    "address": 1,
+    "nonce": 0
+  },
+  "auth": [
+    [],
+    [],
+    [],
+    []
+  ],
+  "ledger": {
+    "protocol_version": 22,
+    "sequence_number": 0,
+    "timestamp": 0,
+    "network_id": "0000000000000000000000000000000000000000000000000000000000000000",
+    "base_reserve": 0,
+    "min_persistent_entry_ttl": 4096,
+    "min_temp_entry_ttl": 16,
+    "max_entry_ttl": 6312000,
+    "ledger_entries": [
+      [
+        {
+          "contract_data": {
+            "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+            "key": "ledger_key_contract_instance",
+            "durability": "persistent"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_data": {
+                "ext": "v0",
+                "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+                "key": "ledger_key_contract_instance",
+                "durability": "persistent",
+                "val": {
+                  "contract_instance": {
+                    "executable": {
+                      "wasm": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+                    },
+                    "storage": [
+                      {
+                        "key": {
+                          "vec": [
+                            {
+                              "symbol": "Count"
+                            }
+                          ]
+                        },
+                        "val": {
+                          "u32": 4294967295
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ],
+      [
+        {
+          "contract_code": {
+            "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_code": {
+                "ext": "v0",
+                "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+                "code": ""
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ]
+    ]
+  },
+  "events": []
+}

package/templates/react-vite-counter/contracts/counter/test_snapshots/test/increments_counter.1.json

@@ -0,0 +1,91 @@
+{
+  "generators": {
+    "address": 1,
+    "nonce": 0
+  },
+  "auth": [
+    [],
+    [],
+    [],
+    []
+  ],
+  "ledger": {
+    "protocol_version": 22,
+    "sequence_number": 0,
+    "timestamp": 0,
+    "network_id": "0000000000000000000000000000000000000000000000000000000000000000",
+    "base_reserve": 0,
+    "min_persistent_entry_ttl": 4096,
+    "min_temp_entry_ttl": 16,
+    "max_entry_ttl": 6312000,
+    "ledger_entries": [
+      [
+        {
+          "contract_data": {
+            "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+            "key": "ledger_key_contract_instance",
+            "durability": "persistent"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_data": {
+                "ext": "v0",
+                "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+                "key": "ledger_key_contract_instance",
+                "durability": "persistent",
+                "val": {
+                  "contract_instance": {
+                    "executable": {
+                      "wasm": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+                    },
+                    "storage": [
+                      {
+                        "key": {
+                          "vec": [
+                            {
+                              "symbol": "Count"
+                            }
+                          ]
+                        },
+                        "val": {
+                          "u32": 1
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ],
+      [
+        {
+          "contract_code": {
+            "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_code": {
+                "ext": "v0",
+                "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+                "code": ""
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ]
+    ]
+  },
+  "events": []
+}

package/templates/react-vite-counter/contracts/counter/test_snapshots/test/repeated_increments_preserve_state.1.json

@@ -0,0 +1,92 @@
+{
+  "generators": {
+    "address": 1,
+    "nonce": 0
+  },
+  "auth": [
+    [],
+    [],
+    [],
+    [],
+    []
+  ],
+  "ledger": {
+    "protocol_version": 22,
+    "sequence_number": 0,
+    "timestamp": 0,
+    "network_id": "0000000000000000000000000000000000000000000000000000000000000000",
+    "base_reserve": 0,
+    "min_persistent_entry_ttl": 4096,
+    "min_temp_entry_ttl": 16,
+    "max_entry_ttl": 6312000,
+    "ledger_entries": [
+      [
+        {
+          "contract_data": {
+            "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+            "key": "ledger_key_contract_instance",
+            "durability": "persistent"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_data": {
+                "ext": "v0",
+                "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM",
+                "key": "ledger_key_contract_instance",
+                "durability": "persistent",
+                "val": {
+                  "contract_instance": {
+                    "executable": {
+                      "wasm": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+                    },
+                    "storage": [
+                      {
+                        "key": {
+                          "vec": [
+                            {
+                              "symbol": "Count"
+                            }
+                          ]
+                        },
+                        "val": {
+                          "u32": 3
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ],
+      [
+        {
+          "contract_code": {
+            "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
+          }
+        },
+        [
+          {
+            "last_modified_ledger_seq": 0,
+            "data": {
+              "contract_code": {
+                "ext": "v0",
+                "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+                "code": ""
+              }
+            },
+            "ext": "v0"
+          },
+          4095
+        ]
+      ]
+    ]
+  },
+  "events": []
+}

package/templates/react-vite-counter/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>__PROJECT_NAME__</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/templates/react-vite-counter/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "__PROJECT_NAME__",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview",
+    "caatinga:build": "caatinga build counter",
+    "caatinga:deploy": "caatinga deploy counter",
+    "caatinga:generate": "caatinga generate counter"
+  },
+  "dependencies": {
+    "@caatinga/client": "^2.0.0",
+    "@caatinga/core": "^2.0.0",
+    "@creit.tech/xbull-wallet-connect": "^0.4.0",
+    "@vitejs/plugin-react": "^4.3.4",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "stellar-wallets-kit": "github:Creit-Tech/Stellar-Wallets-Kit#v0.0.7",
+    "vite": "^6.0.6"
+  },
+  "devDependencies": {
+    "@caatinga/cli": "^2.0.0",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
+    "typescript": "^5.7.2"
+  }
+}

package/templates/react-vite-counter/pnpm-workspace.yaml

@@ -0,0 +1,12 @@
+# pnpm 10.26+ / 11.x block lifecycle scripts by default; vite depends on esbuild.
+allowBuilds:
+  esbuild: true
+
+# stellar-wallets-kit@0.0.7 is unpublished from npm and is therefore pinned
+# to a github: URL in package.json. Its own dependencies also reference
+# @creit.tech/xbull-wallet-connect via a github: URL, and pnpm 10.26+ (and
+# 11.x) defaults blockExoticSubdeps to true, which would refuse to install
+# that exotic subdep. Allow it explicitly. This is a targeted opt-out for
+# this one transitive dep; direct dependencies in package.json still must
+# come from a trusted source.
+blockExoticSubdeps: false

package/templates/react-vite-counter/public/.gitkeep

@@ -0,0 +1 @@
+

package/templates/react-vite-counter/src/App.tsx

@@ -0,0 +1,18 @@
+import { CounterCard } from "./components/CounterCard";
+import { WalletButton } from "./components/WalletButton";
+
+export default function App() {
+  return (
+    <main className="app-shell">
+      <header className="topbar">
+        <div>
+          <p className="eyebrow">Caatinga</p>
+          <h1>__PROJECT_NAME__</h1>
+        </div>
+        <WalletButton />
+      </header>
+
+      <CounterCard />
+    </main>
+  );
+}

package/templates/react-vite-counter/src/caatinga.ts

@@ -0,0 +1,20 @@
+import { createCaatingaClient } from "@caatinga/client";
+import type { CaatingaArtifacts } from "@caatinga/core/browser";
+import artifactsJson from "../caatinga.artifacts.json";
+import * as Counter from "./contracts/generated/counter.js";
+import { stellarWalletAdapter } from "./wallet.js";
+
+const artifacts = artifactsJson as CaatingaArtifacts;
+
+export const caatingaClient = createCaatingaClient({
+  network: {
+    name: "testnet",
+    rpcUrl: "https://soroban-testnet.stellar.org",
+    networkPassphrase: "Test SDF Network ; September 2015"
+  },
+  artifacts,
+  wallet: stellarWalletAdapter,
+  contracts: {
+    counter: { binding: Counter }
+  }
+});

package/templates/react-vite-counter/src/components/CounterCard.tsx

@@ -0,0 +1,86 @@
+import { useCallback, useEffect, useMemo, useState } from "react";
+import { caatingaClient } from "../caatinga.js";
+import { CaatingaError } from "@caatinga/core/browser";
+
+function formatCaatingaError(error: unknown): string {
+  if (error instanceof CaatingaError) {
+    return `[${error.code}] ${error.message}\n\n${error.hint}`;
+  }
+
+  return error instanceof Error ? error.message : String(error);
+}
+
+export function CounterCard() {
+  const [count, setCount] = useState<number | null>(null);
+  const [loading, setLoading] = useState(false);
+  const [error, setError] = useState<string | null>(null);
+  const formattedCount = useMemo(
+    () => (count === null ? "Not loaded" : new Intl.NumberFormat().format(count)),
+    [count]
+  );
+
+  const refresh = useCallback(async () => {
+    setLoading(true);
+    setError(null);
+
+    try {
+      const nextCount = await caatingaClient.contract("counter").read<number>("get");
+      setCount(nextCount);
+    } catch (caught) {
+      setError(formatCaatingaError(caught));
+    } finally {
+      setLoading(false);
+    }
+  }, []);
+
+  useEffect(() => {
+    void refresh();
+  }, [refresh]);
+
+  async function increment() {
+    setLoading(true);
+    setError(null);
+
+    try {
+      const result = await caatingaClient.contract("counter").invoke<number>("increment");
+      if (typeof result.result === "number") {
+        setCount(result.result);
+      } else {
+        await refresh();
+      }
+    } catch (caught) {
+      setError(formatCaatingaError(caught));
+    } finally {
+      setLoading(false);
+    }
+  }
+
+  return (
+    <section className="counter-panel" aria-labelledby="counter-title">
+      <div className="counter-panel__header">
+        <div>
+          <p className="eyebrow">Counter Contract</p>
+          <h2 id="counter-title">Counter</h2>
+        </div>
+        <span className="network-pill">testnet</span>
+      </div>
+
+      <div className="counter-value">{formattedCount}</div>
+
+      <div className="counter-actions">
+        <button type="button" onClick={increment} disabled={loading}>
+          {loading ? "Incrementing…" : "Increment"}
+        </button>
+        <button className="secondary-button" type="button" onClick={refresh} disabled={loading}>
+          Refresh
+        </button>
+      </div>
+
+      {error ? (
+        <pre className="counter-error" role="alert">
+          {error}
+        </pre>
+      ) : null}
+    </section>
+  );
+}