@deroll/cmio 0.1.0

package/AUTHORS

@@ -0,0 +1 @@
+Danilo Tuler

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,122 @@
+# @tuler/node-libcmt
+
+> Temporarily published as `@tuler/node-libcmt` while it is not an official Cartesi package.
+
+Node.js bindings for [libcmt](https://github.com/cartesi/machine-guest-tools/tree/main/sys-utils/libcmt), the Cartesi Machine guest rollup library. It lets Node.js applications running inside a Cartesi Machine process rollup inputs (advances and inspects) and emit vouchers, notices, reports and exceptions — without going through the rollup HTTP server.
+
+The package is a Node-API native addon:
+
+- On **riscv64** (inside the Cartesi Machine) it statically links the real libcmt, which talks to the machine emulator through the kernel driver.
+- On **other architectures** (your development host) it compiles libcmt's *mock* IO driver, which simulates inputs and outputs via files, driven by the `CMT_INPUTS` and `CMT_DEBUG` environment variables.
+
+The right flavor is selected automatically by target architecture, so the same dapp code runs unchanged on the host and in the machine.
+
+The API is **fully synchronous** on purpose: calls that wait on the emulator (`finish`, `gio`) yield the machine, which pauses the entire guest — including the Node.js event loop — so there is nothing to run concurrently while they wait. On the host mock they return immediately.
+
+## Usage
+
+```js
+import { Rollup } from '@tuler/node-libcmt';
+
+const rollup = new Rollup();
+await rollup.run({
+    advance(request, rollup) {
+        // request: { chainId, appContract, msgSender, blockNumber,
+        //            blockTimestamp, prevRandao, index, payload }
+        rollup.emitNotice(request.payload);
+        rollup.emitVoucher({
+            destination: request.msgSender,
+            value: 0n,
+            payload: '0xdeadbeef',
+        });
+        return true; // accept (default); return false to reject
+    },
+    inspect(request, rollup) {
+        rollup.emitReport(request.payload);
+    },
+});
+```
+
+Or drive the loop yourself:
+
+```js
+const rollup = new Rollup();
+let accept = true;
+for (;;) {
+    const request = rollup.finish({ accept });
+    accept = handle(request); // your logic
+}
+```
+
+Byte arguments accept `Buffer`, `Uint8Array` or 0x-prefixed hex strings. Addresses are returned as 0x-hex strings, payloads as `Buffer`, and numeric fields as `bigint`.
+
+The package is dual ESM + CommonJS — `const { Rollup } = require('@tuler/node-libcmt')` works too, and both entry points share the same native addon instance.
+
+### API
+
+| Method | Description |
+| --- | --- |
+| `new Rollup()` | Opens the rollup device. Only **one** instance may be open at a time (`-EBUSY` otherwise); `close()` the previous one first. |
+| `finish({ accept })` | Accepts/rejects the previous request, yields, and returns the next `{ type: 'advance' \| 'inspect', payload, ... }`. |
+| `emitVoucher({ destination, value, payload })` | Emits `Voucher(address,uint256,bytes)`. Returns the output index. |
+| `emitDelegateCallVoucher({ destination, payload })` | Emits `DelegateCallVoucher(address,bytes)`. Returns the output index. |
+| `emitNotice(payload)` | Emits `Notice(bytes)`. Returns the output index. |
+| `emitReport(payload)` | Emits a report (raw bytes, not in the outputs merkle tree). |
+| `emitException(payload)` | Signals that the request could not be processed. |
+| `progress(value)` | Reports progress (raw uint32). |
+| `gio({ domain, id })` | Generic IO request; returns `{ responseCode, responseData }`. |
+| `saveMerkle(file)` / `loadMerkle(file)` / `resetMerkle()` | Persist/restore/reset the outputs merkle tree. |
+| `close()` | Releases the device. |
+| `run({ advance, inspect })` | Convenience loop over `finish`; handlers may be async. Handler exceptions reject the input and are emitted as reports. |
+
+Failed libcmt calls throw a `RollupError` with the negative errno in `error.errno` and the failed call in `error.syscall`.
+
+## Documentation
+
+Published at **<https://tuler.github.io/libcmt-node/>** (deployed by the [Docs workflow](.github/workflows/docs.yml) on every push to `main`).
+
+The site ([Vocs](https://vocs.dev)) has its pages in [`docs/pages/`](docs/pages/) and is configured by [`vocs.config.ts`](vocs.config.ts): `npm run docs:dev` / `docs:build` / `docs:preview`.
+
+## Testing on the host (mock)
+
+The mock injects inputs from files listed in `CMT_INPUTS` and writes outputs to files named after the input:
+
+```sh
+CMT_INPUTS="0:advance.bin,1:inspect.bin" node my-dapp.js
+# -> advance.output-0.bin, advance.report-0.bin, ...
+```
+
+Reason `0` is advance (EVM-ABI encoded `EvmAdvance`), `1` is inspect (raw payload); any other reason is a gio reply with that response code. Set `CMT_DEBUG=yes` for verbose logging. See the [libcmt README](https://github.com/cartesi/machine-guest-tools/tree/main/sys-utils/libcmt#testing) for how to generate inputs with foundry's `cast`, or `test/rollup.test.mjs` here for a pure-JS encoder.
+
+## Testing inside a Cartesi Machine
+
+`test/machine/run.sh` tests the real riscv64 build end-to-end: it cross-builds the linux-riscv64 prebuild in Docker (mirroring CI), assembles a riscv64 Debian rootfs with Node.js and the packed package, boots it with [cartesi-machine](https://github.com/cartesi/machine-emulator), feeds ABI-encoded advance inputs and an inspect query via `--cmio-advance-state`/`--cmio-inspect-state`, and verifies the emitted outputs byte-for-byte. Requires Docker (with riscv64 emulation) and the `cartesi-machine` CLI (or set `CARTESI_MACHINE` to run it from the `cartesi/machine-emulator` docker image). Set `SKIP_PREBUILD=1`/`SKIP_ROOTFS=1` to reuse artifacts from a previous run. CI runs this in the `test-machine` job, reusing the prebuild built by `prebuild-riscv64`.
+
+## Building
+
+libcmt sources are expected at `deps/machine-guest-tools` (git submodule in this repository). Override the location with `LIBCMT_DIR=/path/to/sys-utils/libcmt` (must resolve inside the package directory tree for gyp).
+
+```sh
+git submodule update --init   # fetch libcmt sources
+npm install                   # uses a prebuild when available, otherwise compiles
+npm test                      # runs the suite against the mock
+```
+
+On riscv64 the addon does not compile libcmt; it links the static library installed by the machine-guest-tools `.deb` (`-l:libcmt.a`, headers from `/usr/include/libcmt`). Override with `LIBCMT_LIB=/path/to/libcmt.a`.
+
+### Prebuilds
+
+`npm run prebuild` produces `prebuilds/<platform>-<arch>/` via prebuildify; `node-gyp-build` picks them up at install time so consumers need no toolchain. Cross-building the riscv64 prebuild requires the riscv64 cross toolchain and a libcmt built with the Cartesi Linux headers — see `.github/workflows/build.yml`.
+
+## Releasing
+
+1. Bump `version` in `package.json`.
+2. Tag the commit `vX.Y.Z` (must match the version) and push the tag.
+
+CI then builds prebuilds for linux-x64, linux-arm64, linux-riscv64, darwin-x64 and darwin-arm64, packs them into the tarball together with the libcmt sources (from-source fallback for other platforms), smoke-tests an install of the packed tarball, publishes to npm, and attaches the tarball to a GitHub release.
+
+Publishing uses [npm trusted publishing](https://docs.npmjs.com/trusted-publishers) (OIDC): no npm token secret is required, and provenance attestations are generated automatically. The package on npmjs.com must have a Trusted Publisher configured pointing at this repository and the `build.yml` workflow. Note that npm only allows configuring a trusted publisher on an *existing* package, so the very first publish must be done manually (`npm publish` from a logged-in terminal).
+
+## License
+
+The libcmt-node repository and all contributions are licensed under [APACHE 2.0](https://www.apache.org/licenses/LICENSE-2.0). Please review our [LICENSE](LICENSE) file.

package/binding.gyp

@@ -0,0 +1,53 @@
+{
+    "variables": {
+        # Path to a libcmt source tree (machine-guest-tools/sys-utils/libcmt).
+        # Defaults to the vendored submodule; override for local development:
+        #   LIBCMT_DIR=/path/to/machine-guest-tools/sys-utils/libcmt npm install
+        "libcmt_dir%": "<!(node -p \"process.env.LIBCMT_DIR || 'deps/machine-guest-tools/sys-utils/libcmt'\")",
+        # riscv64 only: linker argument for a prebuilt libcmt static library.
+        # Defaults to the one installed by the machine-guest-tools .deb.
+        "libcmt_lib%": "<!(node -p \"process.env.LIBCMT_LIB || '-l:libcmt.a'\")"
+    },
+    "targets": [
+        {
+            "target_name": "libcmt",
+            "sources": [
+                "src/addon.cc"
+            ],
+            "include_dirs": [
+                "<!@(node -p \"require('node-addon-api').include_dir\")",
+                "<(libcmt_dir)/include"
+            ],
+            "defines": [
+                "NAPI_VERSION=8",
+                "NAPI_DISABLE_CPP_EXCEPTIONS",
+                "NODE_ADDON_API_DISABLE_DEPRECATED"
+            ],
+            "cflags": ["-O2", "-fno-strict-aliasing", "-fno-strict-overflow"],
+            "cflags_cc": ["-std=c++17"],
+            "xcode_settings": {
+                "CLANG_CXX_LANGUAGE_STANDARD": "c++17",
+                "MACOSX_DEPLOYMENT_TARGET": "11.0"
+            },
+            "conditions": [
+                ["target_arch=='riscv64'", {
+                    # Inside the Cartesi Machine: link the real driver build of
+                    # libcmt installed by the machine-guest-tools package.
+                    "libraries": ["<(libcmt_lib)"]
+                }, {
+                    # Host (development): compile libcmt sources with the mock
+                    # IO driver directly into the addon.
+                    "sources": [
+                        "<(libcmt_dir)/src/abi.c",
+                        "<(libcmt_dir)/src/buf.c",
+                        "<(libcmt_dir)/src/keccak.c",
+                        "<(libcmt_dir)/src/merkle.c",
+                        "<(libcmt_dir)/src/rollup.c",
+                        "<(libcmt_dir)/src/util.c",
+                        "<(libcmt_dir)/src/io-mock.c"
+                    ]
+                }]
+            ]
+        }
+    ]
+}

package/deps/machine-guest-tools/AUTHORS

@@ -0,0 +1,7 @@
+Diego Nehab
+Eduardo Barthel
+Gabriel de Quadros Ligneul
+Marcelo Politzer
+Marko Atanasievski
+Marcos Pernambuco Motta
+Victor Fusco