@secondlayer/cli 3.1.1 → 3.2.0-beta.1

package/README.md

@@ -26,7 +26,7 @@ sl subgraphs deploy ./x.ts       # deploy to your instance
 |---|---|
 | `sl login` | Magic-link email → 6-digit code → writes session to `~/.secondlayer/session.json` |
 | `sl logout` | Revokes the session and clears the local file |
-| `sl whoami` | Prints account, active project, instance URL, trial days left |
+| `sl whoami` | Prints account, active project, instance URL, plan, status |
 
 ### Project
 
@@ -50,7 +50,7 @@ One instance per project. The platform API spawns a dedicated `sl-pg-{slug}`,
 | Command | What it does |
 |---|---|
 | `sl instance create --plan <launch\|grow\|scale>` | Provision containers. Boxed reveal of `serviceKey` + `anonKey` (shown once). |
-| `sl instance info` | Plan, status, resource usage, trial days left |
+| `sl instance info` | Plan, status, resource usage |
 | `sl instance resize --plan <...>` | Recreate containers with new CPU/memory (~30s downtime) |
 | `sl instance suspend` / `resume` | Stop/start containers, volume preserved |
 | `sl instance keys rotate [--service\|--anon\|--both]` | Bump JWT gen, recreate API container, mint replacement key(s) |
@@ -95,7 +95,7 @@ invocation. No long-lived key on disk.
 |---|---|
 | `sl generate [files...]` (aliases: `gen`, `codegen`) | Generate TS interfaces from Clarity contracts |
 | `sl init` | Scaffold `secondlayer.config.ts` |
-| `sl doctor` | Session + project + instance reachability + trial status check |
+| `sl doctor` | Session + project + instance reachability check |
 | `sl status` | Platform/instance health |
 | `sl account profile` | Update display name / bio / slug |
 | `sl config show/set/reset/clear` | Inspect or reset local config |
@@ -117,12 +117,88 @@ Every tenant-scoped failure surfaces a typed code and an action hint:
 | Code | CLI hint |
 |---|---|
 | `SESSION_EXPIRED` | `Session expired. Run: sl login` |
-| `TRIAL_EXPIRED` | `Your trial expired. Run: sl instance resize --plan <...> and add payment` |
 | `TENANT_SUSPENDED` | `Instance is suspended. Run: sl instance resume` |
 | `NO_ACTIVE_PROJECT` | `No project selected. Run: sl project use <slug>` |
 | `NO_TENANT_FOR_PROJECT` | `Project has no instance. Run: sl instance create --plan launch` |
 | `KEY_ROTATED` | Handled transparently — `http.ts` re-mints and retries once |
 
+## Code generation (`sl generate`)
+
+Generate type-safe interfaces, functions, and optional React hooks from
+Clarity contracts — works against local `.clar` files, deployed contracts
+(network inferred from address prefix), or glob patterns.
+
+```bash
+# Local .clar files
+sl generate ./contracts/token.clar -o ./src/generated.ts
+
+# Deployed contracts (SP/SM → mainnet, ST/SN → testnet)
+sl generate SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.alex-vault -o ./src/generated.ts
+
+# Glob
+sl generate "./contracts/*.clar" -o ./src/generated.ts
+```
+
+Config-driven mode:
+
+```bash
+sl init          # creates secondlayer.config.ts
+sl generate      # regenerates from the config
+```
+
+```typescript
+// secondlayer.config.ts
+import { defineConfig } from "@secondlayer/cli"
+import { clarinet, actions, react } from "@secondlayer/cli/plugins"
+
+export default defineConfig({
+  out: "src/generated.ts",
+  plugins: [clarinet(), actions(), react()],
+})
+```
+
+### Plugins
+
+| Plugin | What it adds |
+|---|---|
+| `clarinet()` | Parse local Clarinet project |
+| `actions()` | `read.*` + `write.*` helpers on each contract |
+| `react()` | Typed React Query hooks (`useTokenTransfer`, `useTokenBalance`, etc.) |
+| `testing()` | Clarinet SDK test helpers |
+
+### Usage examples
+
+```typescript
+import { token } from "./generated/contracts"
+import { makeContractCall, fetchCallReadOnlyFunction } from "@stacks/transactions"
+
+// Works with @stacks/transactions directly:
+await makeContractCall({
+  ...token.transfer({ amount: 100n, recipient: "SP..." }),
+  network: "mainnet",
+})
+
+// With actions() plugin — read/write helpers:
+const balance = await token.read.getBalance({ account: "SP..." })
+await token.write.transfer({ amount: 100n, recipient: "SP..." })
+
+// Maps / vars / constants:
+const supply = await token.vars.totalSupply.get()
+const bal = await token.maps.balances.get("SP...")
+const max = await token.constants.maxSupply.get()
+```
+
+```typescript
+// With react() plugin:
+import { useTokenTransfer, useTokenBalance } from "./generated/hooks"
+
+function App() {
+  const { transfer, isRequestPending } = useTokenTransfer()
+  const { data: balance } = useTokenBalance("SP...")
+  // ...
+}
+```
+
 ## License
 
 MIT