@ola-893/buidl 0.0.0-stage → 0.4.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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 buidl contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,96 @@
1
- # Temporary Holding Version
1
+ # buidl
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Does this deployed DeWEB app match the exact release approved by the team?
4
+
5
+ buidl verifies X Layer DeWEB bytes against TapeOut and compares complete deployments with independently approved manifests. The local demo uses Anvil. The X Layer pilot uses the native TapeOut contracts and a site-specific authority, with a full rehearsal on an Anvil fork. Approval establishes an artifact match. Security reviews and source-to-build reproducibility are separate claims.
6
+
7
+ ## Use buidl
8
+
9
+ The **CLI is the primary product distribution and demo surface**. Developers generate manifests, collect reviewer signatures, gate publishing and verify deployed files from the terminal. The [web dashboard](https://ola-893.github.io/buidl/) and [public verification links](https://ola-893.github.io/buidl/?verify=1.2.230.tape) provide inspection and shareable evidence.
10
+
11
+ ```sh
12
+ npm install -g @ola-893/buidl@0.4.0
13
+ buidl --version
14
+ buidl demo --out ./demo-evidence
15
+ ```
16
+
17
+ The one-command demo requires Foundry Anvil, runs the complete lifecycle on its own disposable local node and writes twelve checks with receipts. It sends no public network transactions. The [CLI guide](docs/cli-demo.md) covers actual testnet wallet signing, publishing, recovery and CI.
18
+
19
+ The npm package is [`@ola-893/buidl`](https://www.npmjs.com/package/@ola-893/buidl); its terminal command is `buidl`. To build the same package from source, run `npm ci` and `npm pack`. The [published v0.3.0](https://github.com/ola-893/buidl/releases/tag/v0.3.0) supports the earlier X Layer pilot commands and predates this testnet CLI. Node.js 22.13+ is required.
20
+
21
+ Public links perform fresh reads when opened, recheck while open, and display the checked block and UTC check time. A live X Layer link reports content integrity and checks current approval when the site is enrolled in a recognized authority. A loopback demo link checks the actual Anvil registry and shows its reviewer evidence and match status. It is scoped to that particular local registry instance and, when available, its current release digest.
22
+
23
+ ## Run locally
24
+
25
+ Use Node.js 22.13+ and npm. The controlled release workflow also requires [Foundry Anvil](https://getfoundry.sh/anvil/).
26
+
27
+ ```sh
28
+ npm ci
29
+ npm run dev
30
+ ```
31
+
32
+ Open [buidl](http://127.0.0.1:5173). The default site, `1.2.230.tape`, is read from X Layer mainnet. You can also enter names such as `#1@2.230` or an address scoped as `xlayer:0x…` or `xlayer:0x…#1`. The inspector renders metadata and hashes. It never opens the inspected page.
33
+
34
+ Run the mainnet inspection in a terminal with `npm run buidl -- inspect 1.2.230.tape`. A captured result is in [live inspection evidence](docs/live-inspection.json).
35
+
36
+ For the testnet-only pilot, run `buidl testnet --help` and follow [the CLI guide](docs/cli-demo.md). The [separate testnet dashboard](http://127.0.0.1:5173/?testnet=1) and [custody runbook](docs/testnet-pilot.md) remain available. It uses labeled buidl fixtures on chain 1952 because the reviewed TapeOut deployment addresses have no testnet code. Every transaction has a cost review before wallet signing, and the fixture constructors reject mainnet. The testnet commands are available from this checkout; CLI v0.3.0 predates them.
37
+
38
+ ## Run the controlled release workflow
39
+
40
+ Start a dedicated Anvil instance bound to loopback:
41
+
42
+ ```sh
43
+ anvil --host 127.0.0.1 --port 8545 --chain-id 31337
44
+ ```
45
+
46
+ In a second terminal:
47
+
48
+ ```sh
49
+ npm run demo -- init
50
+ npm run demo -- approve a
51
+ npm run buidl -- gate demo/release-a public/local-demo/manifest-a.json public/local-demo/config.json
52
+ npm run buidl -- publish-local demo/release-a public/local-demo/manifest-a.json public/local-demo/config.json
53
+ npm run buidl -- verify-local public/local-demo/manifest-a.json public/local-demo/config.json
54
+ ```
55
+
56
+ The first Anvil account publishes. Two of the next three accounts independently sign typed approval. For browser signing, open **Local demo** from the dev server and select **Releases**, then **Load demo A**. Use **Approvals** to create a request, connect the local reviewer accounts in turn, and sign. Export/import carries the request between reviewers. Once the threshold is met, any connected wallet on the local chain can record the approval. To start with an unregistered local site, use `npm run demo -- init --unregistered`, then connect the holder wallet and select **Approvals → Register app**. The scripted `approve a` command is an alternative to the browser signing steps once a policy exists. Use a disposable extension wallet profile and the test-only accounts printed by Anvil.
57
+
58
+ Run `npm run demo` for the entire scripted A → bypassed B → approved B demonstration. The [2:40 demo script](docs/demo.md) gives the browser and terminal sequence.
59
+
60
+ To generate a candidate from a directory, use **Releases → Select build folder**, or:
61
+
62
+ ```sh
63
+ npm run buidl -- manifest demo/release-a --site public/local-demo/site.json \
64
+ --release checkout-a --fallback index.html --out /tmp/buidl-manifest-a.json
65
+ ```
66
+
67
+ Write the manifest outside the build directory. CI should treat the CLI's nonzero exit as a failed check. `inspect` and `verify-local` exit 2 for completed checks without a complete verification or an approved match, respectively. Command, input, and gate failures exit 1.
68
+
69
+ ## Architecture
70
+
71
+ - `src/core/tapeout.ts` uses the pinned TapeKit kernel for identity, implementation checks, and multi-operator RPC. The inventory reader hashes raw bytes and uses the exact paths and routing metadata returned by SiteRegistry.
72
+ - `src/core/manifest.ts` and `src/core/build.ts` implement the canonical format, artifact staging, and comparison. See the [manifest and approval formats](docs/formats.md).
73
+ - `src/core/approval.ts` and `contracts/ReleaseRegistry.sol` verify EIP-712 signatures. The registry stores commitments and policy state onchain. Manifests and file contents stay outside the approval registry.
74
+ - `contracts/LocalDeweb.sol` is a controlled local fixture with a SiteRegistry-compatible surface and an ownership epoch. It provides explicit upload state, so a multi-transaction upload can stay visibly incomplete.
75
+ - `src/cli.ts`, `src/publish.ts`, and `src/web` expose the CLI gate, staged publisher, and React interface. Local JSON exports and registry logs provide portable evidence and chain history.
76
+
77
+ ## Verification and enforcement
78
+
79
+ ```sh
80
+ npm run build
81
+ npm test
82
+ npx playwright install chromium
83
+ npm run test:browser
84
+ ```
85
+
86
+ The browser suite expects the disposable Anvil service running. It deploys its own fixture per run. Use `BUIDL_BROWSER=chrome npm run test:browser` with installed Chrome. It reads a real mainnet deployment and signs and submits local transactions through a controlled EIP-1193 test provider. The OKX browser-extension path follows its documented EVM interface and still needs an interactive extension check.
87
+
88
+ The supported publisher gates staged bytes before upload and verifies the staged deployment before ending the upload. Direct holder writes can bypass the publisher. A fresh post-deployment read detects divergence. Viewer-side blocking requires a viewer that integrates and enforces the result. For loopback recovery, rerun the gated publisher after the interrupted process exits. After a hard kill, remove the matching empty `.demo/publish-<container>.lock` directory once the old publisher is gone.
89
+
90
+ The hosted frontend uses GitHub Pages as its independent HTTPS origin. The [X Layer release pilot](docs/xlayer-release.md) describes the fork rehearsal and team-signed mainnet steps. Existing public sites remain inspectable, and live approval evidence requires explicit site enrollment. The [integration map](docs/integrations.md) records the verified contracts, provider constraints, and hosting options.
91
+
92
+ ## Commercial use and roadmap
93
+
94
+ The initial users are payment and dapp teams with publishing wallets and separate reviewers. A proposed model is free inspection and portable public evidence, with paid CI integration, team policy administration, and release notifications. TapeOut developer channels and wallet or gateway integrations are candidate distribution channels. Teams would pay for a repeatable approval gate and incident evidence across releases. Commercial deployments should retain the vendored [TapeKit MIT notice](vendor/tapekit/LICENSE). TAP text is CC0, TapeKit code is MIT, and bundled fonts carry their SIL Open Font License notices.
95
+
96
+ Future work includes a curated DeWEB app store, independent reviewer attestations and revocation, contract evidence bound to chain/address/bytecode/proxy/configuration, authorized isolated AI exploit testing, private disclosures and reviewer-validated bounties, and enforcement integrations for directories, gateways, and wallets.
@@ -0,0 +1,191 @@
1
+ TapeKit kernel
2
+
3
+ MIT License
4
+
5
+ Copyright (c) 2026 TapeOutProtocol
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining a copy
8
+ of this software and associated documentation files (the "Software"), to deal
9
+ in the Software without restriction, including without limitation the rights
10
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
+ copies of the Software, and to permit persons to whom the Software is
12
+ furnished to do so, subject to the following conditions:
13
+
14
+ The above copyright notice and this permission notice shall be included in all
15
+ copies or substantial portions of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
+ SOFTWARE.
24
+
25
+ viem
26
+
27
+ MIT License
28
+
29
+ Copyright (c) 2023-present weth, LLC
30
+
31
+ Permission is hereby granted, free of charge, to any person obtaining a copy
32
+ of this software and associated documentation files (the "Software"), to deal
33
+ in the Software without restriction, including without limitation the rights
34
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
35
+ copies of the Software, and to permit persons to whom the Software is
36
+ furnished to do so, subject to the following conditions:
37
+
38
+ The above copyright notice and this permission notice shall be included in all
39
+ copies or substantial portions of the Software.
40
+
41
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
42
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
43
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
44
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
45
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
46
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
47
+ SOFTWARE.
48
+
49
+ ox
50
+
51
+ MIT License
52
+
53
+ Copyright (c) 2023-present wevm
54
+
55
+ Permission is hereby granted, free of charge, to any person obtaining a copy
56
+ of this software and associated documentation files (the "Software"), to deal
57
+ in the Software without restriction, including without limitation the rights
58
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
59
+ copies of the Software, and to permit persons to whom the Software is
60
+ furnished to do so, subject to the following conditions:
61
+
62
+ The above copyright notice and this permission notice shall be included in all
63
+ copies or substantial portions of the Software.
64
+
65
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
66
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
67
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
68
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
69
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
70
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
71
+ SOFTWARE.
72
+
73
+ abitype
74
+
75
+ MIT License
76
+
77
+ Copyright (c) 2022-present weth, LLC
78
+
79
+ Permission is hereby granted, free of charge, to any person obtaining a copy
80
+ of this software and associated documentation files (the "Software"), to deal
81
+ in the Software without restriction, including without limitation the rights
82
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
83
+ copies of the Software, and to permit persons to whom the Software is
84
+ furnished to do so, subject to the following conditions:
85
+
86
+ The above copyright notice and this permission notice shall be included in all
87
+ copies or substantial portions of the Software.
88
+
89
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
90
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
91
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
92
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
93
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
94
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
95
+ SOFTWARE.
96
+
97
+ mime
98
+
99
+ MIT License
100
+
101
+ Copyright (c) 2023 Robert Kieffer
102
+
103
+ Permission is hereby granted, free of charge, to any person obtaining a copy
104
+ of this software and associated documentation files (the "Software"), to deal
105
+ in the Software without restriction, including without limitation the rights
106
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
107
+ copies of the Software, and to permit persons to whom the Software is
108
+ furnished to do so, subject to the following conditions:
109
+
110
+ The above copyright notice and this permission notice shall be included in all
111
+ copies or substantial portions of the Software.
112
+
113
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
114
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
115
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
116
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
117
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
118
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
119
+ SOFTWARE.
120
+
121
+ @noble/curves
122
+
123
+ The MIT License (MIT)
124
+
125
+ Copyright (c) 2022 Paul Miller (https://paulmillr.com)
126
+
127
+ Permission is hereby granted, free of charge, to any person obtaining a copy
128
+ of this software and associated documentation files (the “Software”), to deal
129
+ in the Software without restriction, including without limitation the rights
130
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
131
+ copies of the Software, and to permit persons to whom the Software is
132
+ furnished to do so, subject to the following conditions:
133
+
134
+ The above copyright notice and this permission notice shall be included in
135
+ all copies or substantial portions of the Software.
136
+
137
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
138
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
139
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
140
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
141
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
142
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
143
+ THE SOFTWARE.
144
+
145
+ @noble/hashes
146
+
147
+ The MIT License (MIT)
148
+
149
+ Copyright (c) 2022 Paul Miller (https://paulmillr.com)
150
+
151
+ Permission is hereby granted, free of charge, to any person obtaining a copy
152
+ of this software and associated documentation files (the “Software”), to deal
153
+ in the Software without restriction, including without limitation the rights
154
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
155
+ copies of the Software, and to permit persons to whom the Software is
156
+ furnished to do so, subject to the following conditions:
157
+
158
+ The above copyright notice and this permission notice shall be included in
159
+ all copies or substantial portions of the Software.
160
+
161
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
162
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
163
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
164
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
165
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
166
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
167
+ THE SOFTWARE.
168
+
169
+ @scure/base
170
+
171
+ The MIT License (MIT)
172
+
173
+ Copyright (c) 2022 Paul Miller (https://paulmillr.com)
174
+
175
+ Permission is hereby granted, free of charge, to any person obtaining a copy
176
+ of this software and associated documentation files (the “Software”), to deal
177
+ in the Software without restriction, including without limitation the rights
178
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
179
+ copies of the Software, and to permit persons to whom the Software is
180
+ furnished to do so, subject to the following conditions:
181
+
182
+ The above copyright notice and this permission notice shall be included in
183
+ all copies or substantial portions of the Software.
184
+
185
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
186
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
187
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
188
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
189
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
190
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
191
+ THE SOFTWARE.