@ola-893/buidl 0.0.0-stage → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,77 @@
1
+ # Recording with the CLI
2
+
3
+ Use the actual operational commands below, one at a time. There is no bundled demo command. Prepare your funded testnet holder and two reviewer wallets, a small build directory and a clean recording terminal.
4
+
5
+ This sequence uses X Layer testnet (1952) and explicitly labeled buidl hosting fixtures. It does not deploy actual TapeOut testnet contracts. The software's adversarial integration tests run separately from the presentation.
6
+
7
+ ## Holder: connect and register
8
+
9
+ ```sh
10
+ npm install -g @ola-893/buidl@0.5.0
11
+ buidl --version
12
+ buidl wallet connect --network testnet
13
+ buidl wallet show
14
+ buidl app init checkout --network testnet --reviewers 0xREVIEWER1,0xREVIEWER2
15
+ buidl app deploy
16
+ buidl app deploy --execute
17
+ buidl app enroll --execute
18
+ buidl app register --execute
19
+ buidl policy show
20
+ ```
21
+
22
+ Replace the address placeholders. Wallet connection signs a message without a gas fee. Deploying, enrolling and registering open separate transaction confirmations with estimates. For an existing app, initialize with its `--fixtures` configuration and inspect `app status` instead of deploying again.
23
+
24
+ ## Developer: prepare the release
25
+
26
+ ```sh
27
+ buidl release create checkout-v1 --build ./dist --out ./manifest.json
28
+ buidl release inspect ./manifest.json
29
+ buidl release request ./manifest.json --out ./approval-request.json
30
+ ```
31
+
32
+ Explain that the manifest commits to exact files, lengths, content types and routing. The request also binds the reviewers' signatures to this registry, chain, policy, sequence and expiry.
33
+
34
+ ## Reviewer one
35
+
36
+ ```sh
37
+ buidl wallet connect --network testnet --account 0xREVIEWER1
38
+ buidl release sign ./approval-request.json --out ./reviewer1.json
39
+ ```
40
+
41
+ ## Reviewer two
42
+
43
+ ```sh
44
+ buidl wallet connect --network testnet --account 0xREVIEWER2
45
+ buidl release sign ./approval-request.json --out ./reviewer2.json
46
+ ```
47
+
48
+ Switch the account in your extension when asked. The CLI verifies each recovered reviewer independently. In a team, reviewers can perform these commands separately and return their signed request files.
49
+
50
+ ## Holder: approve, publish and verify
51
+
52
+ ```sh
53
+ buidl wallet connect --network testnet --account 0xHOLDER
54
+ buidl release approve ./reviewer1.json ./reviewer2.json
55
+ buidl release approve ./reviewer1.json ./reviewer2.json --execute
56
+ buidl release gate ./dist ./manifest.json
57
+ buidl release publish ./dist ./manifest.json --execute
58
+ buidl release verify --manifest ./manifest.json --out ./verification.json
59
+ buidl wallet history
60
+ ```
61
+
62
+ Show the preview, real wallet confirmations, public receipts and checked verification block. You decide when to run each command. Keep the manifest and request exports outside the build directory.
63
+
64
+ For a changed-build gate check, edit a file in a copy of the build and run `release gate` against the approved manifest. It must fail before requesting a transaction. Changing the deployed files is a separate controlled test; a failed local gate alone does not demonstrate detection of an onchain content change.
65
+
66
+ ## Optional lifecycle operations
67
+
68
+ ```sh
69
+ buidl release revoke --execute
70
+ buidl release verify --manifest ./manifest.json
71
+ buidl app recover --execute
72
+ buidl wallet disconnect
73
+ ```
74
+
75
+ Revocation changes the live verification result. Recovery returns custody to the depositor and invalidates the prior authority. Capture these after recording a successful approved match. Use `wallet reconcile --hash HASH` if a submitted transaction's browser response is interrupted.
76
+
77
+ The earlier [public fixture pilot](testnet/results/cli-approved-release.json) records holder/reviewer signing and a successful approved match. Its historical receipt evidence remains separate from a new run. For full operation and setup details, see [the CLI guide](cli.md).
package/docs/cli.md ADDED
@@ -0,0 +1,90 @@
1
+ # buidl CLI
2
+
3
+ Install `@ola-893/buidl@0.5.0` from npm and run `buidl --help`. The CLI is an operational tool: you connect the wallets, submit each command and confirm signatures yourself.
4
+
5
+ ## Wallets
6
+
7
+ ```sh
8
+ buidl wallet connect --network testnet
9
+ buidl wallet show
10
+ buidl wallet disconnect
11
+ ```
12
+
13
+ Connect opens `http://127.0.0.1:5362` with a temporary request token. Choose an installed EVM browser wallet and the intended account. The network button can switch or add X Layer testnet, chain 1952. Sign the displayed connection message; the CLI recovers the signer and verifies the RPC chain before saving the public profile.
14
+
15
+ Use `--account 0xADDRESS` to require a specific holder or reviewer. Every later approval signature and transaction verifies the selected account and network again. Connecting never gives the CLI a private key or permission to sign later transactions automatically.
16
+
17
+ The default profile is `~/.config/buidl/wallet.json`. Set `BUIDL_HOME` to a separate directory for a different operator profile or terminal. `wallet disconnect` removes that profile. It does not revoke extension site permissions or cancel an open extension prompt.
18
+
19
+ For an RPC connection problem, specify `--rpc https://YOUR_TESTNET_RPC`. On the pilot Mac, the guarded loopback relay can be used with `--rpc http://127.0.0.1:8552`; it forwards to the public X Layer testnet. The local signing page uses the extension's selected network RPC.
20
+
21
+ ## Apps and policies
22
+
23
+ ```sh
24
+ buidl app init NAME --network testnet --reviewers ADDRESS1,ADDRESS2 --threshold 2
25
+ buidl app show
26
+ buidl app deploy
27
+ buidl app deploy --execute
28
+ buidl app enroll --execute
29
+ buidl app register --execute
30
+ buidl policy show
31
+ buidl policy set --reviewers ADDRESS1,ADDRESS2 --threshold 2 --execute
32
+ ```
33
+
34
+ The project lives in `buidl.json`, or the file given with `--project PATH`. Initialization defaults its holder to the connected wallet. `--owner ADDRESS` permits preparing a project before connecting. Reviewers must be distinct and cannot include the holder.
35
+
36
+ Testnet deployments use buidl's simulated circuit, file store and custody authority. They are not actual TapeOut testnet deployments. [Discovery and custody details](testnet-pilot.md) document the boundary. Enrollment transfers the circuit fixture into the authority; only its depositor can recover it while enrolled.
37
+
38
+ `app init --fixtures FILE` adopts a known fixture configuration. The CLI checks deployed runtime fingerprints, the authority binding and registry provenance before operating on it. Partial deployment plans persist so repeating `app deploy --execute` can resume the missing contract after reconciliation.
39
+
40
+ ## Releases
41
+
42
+ ```sh
43
+ buidl release create NAME --build DIRECTORY --out MANIFEST --fallback index.html
44
+ buidl release inspect MANIFEST
45
+ buidl release request MANIFEST --out REQUEST
46
+ buidl release sign REQUEST --out SIGNED
47
+ buidl release approve SIGNED1 SIGNED2
48
+ buidl release approve SIGNED1 SIGNED2 --execute
49
+ buidl release gate BUILD MANIFEST
50
+ buidl release publish BUILD MANIFEST --execute
51
+ buidl release verify --manifest MANIFEST --out REPORT
52
+ ```
53
+
54
+ Manifest creation reads your files and works offline once the project's site identity is configured. The manifest must be outside the build directory. The fixture publisher accepts files up to 60 KB, uploaded in 12 KB chunks.
55
+
56
+ `release sign` uses the connected reviewer wallet. Its EIP-712 signature binds the chain, site, registry, policy version, sequence, expiry, manifest and artifact set. Unauthorized, duplicate or expired signatures fail validation. Signed request files merge only if they describe the same exact approval.
57
+
58
+ `release approve` previews recording after verifying the threshold. With `--execute`, the active wallet submits it to the registry. `release publish` requires the connected circuit governor, rechecks exact build bytes and approval, requests each transaction separately, verifies deployed files and routing, then closes the publication. The final verification includes the checked block and time.
59
+
60
+ Previously approved artifacts require `release request MANIFEST --out NEW_REQUEST --rollback` and fresh reviewer signatures. A request or signature from before an ownership exit, policy change or re-enrollment cannot be reused.
61
+
62
+ ## Recovery and history
63
+
64
+ ```sh
65
+ buidl wallet history
66
+ buidl wallet reconcile --hash HASH
67
+ buidl release status
68
+ buidl release revoke --execute
69
+ buidl app recover --execute
70
+ buidl app transfer --to NEW_OWNER --execute
71
+ ```
72
+
73
+ The publisher saves `.buidl/transactions.json` next to the project, including estimates, nonces, hashes, receipts and paid gas. A normal rejection in the wallet is recorded as cancelled. An interruption with an uncertain outcome stops later writes; `wallet reconcile` validates the exact returned transaction against the original plan and records its receipt. Never submit again solely because a browser callback failed.
74
+
75
+ After a hard process kill, check wallet activity and the journal before removing a stale `.buidl/transaction.lock`. A wallet confirmation can still broadcast after the CLI exits. If it did, reconcile that hash before continuing. After reconciliation, `release publish` resumes the existing attempt and avoids uploading already verified files again.
76
+
77
+ Ownership exit and re-enrollment invalidate approval authority. Connect the new owner before enrolling. Update the reviewer policy to exclude the new owner before collecting fresh signatures; a confirmed policy change updates the project's configured owner and policy.
78
+
79
+ ## Diagnostics and CI
80
+
81
+ ```sh
82
+ buidl diagnostics
83
+ buidl doctor
84
+ buidl release gate ./dist ./manifest.json --project ./buidl.json --json
85
+ buidl release verify --project ./buidl.json --json
86
+ ```
87
+
88
+ Interactive output is concise; `--json` and pipes retain structured values. The exit codes are 0 for success, 2 for completed verification without a match, and 1 for input, RPC or gate failures. Verification and build gates do not require wallet connection.
89
+
90
+ The operational write workflow accepts testnet 1952 only. `buidl inspect IDENTIFIER` remains a separate read-only TapeOut mainnet inspection command. Viewer or gateway integration is required to block access to unapproved apps.
package/package.json CHANGED
@@ -1,6 +1,69 @@
1
1
  {
2
2
  "name": "@ola-893/buidl",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.5.0",
4
+ "type": "module",
5
+ "engines": {
6
+ "node": ">=22.13"
7
+ },
8
+ "scripts": {
9
+ "dev": "vite --host 127.0.0.1",
10
+ "build": "tsc --noEmit && vite build",
11
+ "preview": "vite preview --host 127.0.0.1",
12
+ "buidl": "tsx src/cli.ts",
13
+ "test": "tsx --test tests/*.test.ts",
14
+ "test:browser": "playwright test",
15
+ "prepare": "npm run build:cli",
16
+ "build:cli": "node scripts/build-cli.mjs",
17
+ "build:contracts": "tsx scripts/contracts.ts --write",
18
+ "test:xlayer-fork": "tsx scripts/xlayer-fork.ts",
19
+ "build:testnet": "tsx scripts/build-testnet.ts",
20
+ "check:testnet": "tsx scripts/build-testnet.ts --check",
21
+ "testnet:relay": "tsx scripts/testnet-relay.ts",
22
+ "test:testnet": "tsx --test tests/testnet.integration.ts",
23
+ "test:cli": "npm run build:cli && tsx --test tests/terminal.integration.ts"
24
+ },
25
+ "devDependencies": {
26
+ "@fontsource-variable/dm-sans": "^5.3.0",
27
+ "@fontsource-variable/inter": "^5.3.0",
28
+ "@playwright/test": "1.65.1",
29
+ "@tapekit/kernel": "file:vendor/tapekit",
30
+ "@types/node": "^22.0.0",
31
+ "@types/react": "^19.2.0",
32
+ "@types/react-dom": "^19.2.0",
33
+ "esbuild": "0.28.2",
34
+ "lucide-react": "^0.577.0",
35
+ "mime": "4.1.0",
36
+ "react": "^19.2.0",
37
+ "react-dom": "^19.2.0",
38
+ "solc": "0.8.38",
39
+ "tsx": "^4.21.0",
40
+ "typescript": "^5.9.3",
41
+ "viem": "2.57.20",
42
+ "vite": "8.3.8"
43
+ },
44
+ "overrides": {
45
+ "tmp": "0.2.7"
46
+ },
47
+ "license": "MIT",
48
+ "repository": {
49
+ "type": "git",
50
+ "url": "git+https://github.com/ola-893/buidl.git"
51
+ },
52
+ "bin": {
53
+ "buidl": "build-cli/buidl.mjs"
54
+ },
55
+ "files": [
56
+ "build-cli/",
57
+ "docs/cli.md",
58
+ "docs/cli-demo.md"
59
+ ],
60
+ "description": "Release approval, gated publishing and fresh verification for DeWEB on X Layer",
61
+ "publishConfig": {
62
+ "access": "public",
63
+ "registry": "https://registry.npmjs.org/"
64
+ },
65
+ "homepage": "https://github.com/ola-893/buidl/tree/v0.5.0#readme",
66
+ "bugs": {
67
+ "url": "https://github.com/ola-893/buidl/issues"
68
+ }
69
+ }