@eosrio/node-abieos 4.1.0-f7d5b45 → 4.2.0-f7d5b45

package/CHANGELOG.md

@@ -1,43 +1,82 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) where possible.
-
-## [4.1.0-f7d5b45] - 2026-02-21
-
-> The `-f7d5b45` suffix denotes the upstream `AntelopeIO/abieos` commit hash bundled with this release.
-
-### Changed
-- Switched abieos submodule origin from `igorls/abieos` fork to official [`AntelopeIO/abieos`](https://github.com/AntelopeIO/abieos). The fork's `abieos_delete_contract` was merged upstream in [PR #27](https://github.com/AntelopeIO/abieos/pull/27), so the fork is no longer needed.
-- **`cmake-js`** 7.3.1 → 8.0.0 (major — build validated, no CMake changes required).
-- **`c8`** 9.1.0 → 10.1.3 (major — coverage tool upgrade).
-- **`@microsoft/api-extractor`** 7.52.13 → 7.57.2.
-- **`@types/node`** 24.6.0 → 25.3.0.
-- **`tsup`** 8.5.0 → 8.5.1.
-- **`typescript`** 5.9.2 → 5.9.3.
-
----
-
-## [4.0.3-f7d5b45] - 2025-09-29
-
-> The `-f7d5b45` suffix denotes the upstream `AntelopeIO/abieos` commit hash bundled with this release.
-
-### Upstream Highlights (`2039717` → `f7d5b45`)
-- Added full support for the new `bitset` ABI type, including serialization/deserialization, key conversions, and regression tests.
-- Introduced `fixed_array` handling in the ABI serializer, so fixed-length array definitions now round-trip correctly.
-- Switched floating-point JSON conversion to `std::to_chars`, improving numeric fidelity and removing legacy `fpconv` sources.
-- Tightened validation around ABI parsing (better sanity checks, error messages, and compatibility guards) while keeping compatibility with `eosio::abi/1.x` definitions.
-- Streamlined upstream CI and build configurations (consistent CMake/toolchain defaults, GCC 14 coverage) matching the latest Antelope “Spring” tooling.
-
-### Added
-- `c8` coverage tooling to produce lcov reports consumed by Coveralls.
-- Comprehensive unit tests covering parse error branches to reach 100% coverage.
-- Repository `LICENSE` now includes upstream `AntelopeIO/abieos` MIT license details.
-- Formal `CHANGELOG.md` to track release history.
-
-### Changed
-- Workflow now runs coverage on Node 22.x only while keeping multi-version tests.
-
-### Fixed
-- Ensured `loadAbiHex` debug branch is executed within tests, eliminating remaining coverage gaps.
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) where possible.
+
+## [4.2.0-f7d5b45] - 2026-05-17
+
+> The `-f7d5b45` suffix denotes the upstream `AntelopeIO/abieos` commit hash bundled with this release. The abieos submodule is unchanged from `4.1.x`; this release adds Windows and macOS support and multi-platform prebuilt distribution.
+
+### Added
+- **Windows support** via MinGW-w64 (GCC). `abieos` cannot be built with MSVC (its C++ depends on libstdc++/libc++ standard-library semantics and GCC/Clang extensions MSVC's STL/compiler does not provide); `CMakeLists.txt` now fails fast with an actionable message if MSVC is detected. cmake-js only emits the MSVC-format `node.lib` and an `#ifdef _MSC_VER`-gated delay-load hook, so the MinGW build instead generates a *delay-import* library with `dlltool` and compiles its own delay-load hook (`src/win_delay_load_hook.cc`) that binds the Node-API symbols to the **host process image**. The single Windows binary therefore works under `node.exe`, `bun.exe`, `electron.exe`, etc. — not just a file literally named `node.exe`. Verified locally on Windows: full test suite **55/55 passing** under Node 24, and end-to-end JSON⇄hex round-trip under Bun (which previously crashed before the delay-load hook).
+- **macOS support** as a **universal2** (`arm64` + `x86_64`) binary via Clang/libc++ (Xcode). `CMakeLists.txt` forces `CMAKE_OSX_ARCHITECTURES=arm64;x86_64` (option `ABIEOS_MAC_UNIVERSAL`, default `ON`); the one binary is published under both `darwin-arm64` and `darwin-x64`. Built and arm64-tested in CI; not validated locally (no macOS dev environment).
+- **Multi-platform prebuilt distribution.** The package bundles a prebuilt binary per platform — `abieos-<platform>-<arch>.node` (`linux-x64`, `win32-x64`, `darwin-arm64`, `darwin-x64`) — and a platform-aware loader (`lib/abieos.ts`, exported `resolveNative`) selects the correct binary at runtime, searching the `dist/` (published) and `lib/` (source) layouts and falling back to the generic `abieos.node`. `npm i` is zero-build on supported platforms.
+- Added CI jobs `build-windows` (`windows-latest`, MinGW-w64 via `msys2/setup-msys2`) and `build-macos` (`macos-14`/Apple-Silicon, universal2). The Linux job also uploads `abieos-linux-x64.node`. Each job builds, tests, and uploads its `.node` artifact.
+
+### Changed
+- `package.json`: `build:win` → `cmake-js compile -G Ninja && node scripts/copy-module.mjs`; `build:mac` wired to compile + copy (previously bare `cmake-js` stubs).
+- `scripts/copy-module.mjs`: deterministically locates the addon across single-config (`build/`) and multi-config (`build/{Release,Debug}/`) generator layouts (no recursive scan — avoids stale binaries), exits non-zero if none is found, and on macOS writes both `abieos-darwin-arm64.node` and `abieos-darwin-x64.node` from the universal2 build.
+- `CMakeLists.txt`: portable `EXISTS` submodule check (replaces Unix-only `git submodule status | grep`); CRLF-robust `node-addon-api` include resolution; strips only the MSVC `/DELAYLOAD:*` token from `CMAKE_SHARED_LINKER_FLAGS` rather than clearing the whole variable.
+
+### Fixed
+- **`stringToName` return type** was `BigInt` (the wrapper object type) instead of `bigint` (the primitive it actually returns) — every TypeScript consumer hit `Type 'BigInt' is not assignable to type 'bigint'`. Now `bigint`.
+- **Self-contained typings:** `binToJson`'s parameter is now `Uint8Array` instead of the ambient Node `Buffer` global (a `Buffer` is a `Uint8Array`, so existing callers are unaffected). The published `.d.ts` no longer depends on `@types/node` and type-checks cleanly under TypeScript's default `skipLibCheck: false` without extra consumer setup. Verified from a clean `npm install` of the packed tarball across Node + Bun (ESM & CJS) and TypeScript (`nodenext`).
+
+### Notes
+- The `darwin-arm64` / `darwin-x64` prebuilts are the same universal2 binary, committed from the `build-macos` CI artifacts (Mach-O cannot be cross-built from the Linux/Windows dev environments). Their CI provenance is the source of truth.
+- GCC 13 emits one benign `-Wstringop-overflow` warning in the vendored `abieos/include/eosio/bitset.hpp`; it is not an error and does not affect correctness (Linux CI builds with Clang and does not emit it).
+
+## [4.1.1-f7d5b45] - 2026-05-17
+
+> The `-f7d5b45` suffix denotes the upstream `AntelopeIO/abieos` commit hash bundled with this release. The submodule is unchanged from `4.1.0`, so the published native binary (`dist/abieos.node`) and JavaScript/typings bundle are byte-identical to `4.1.0`. This is a dependency-maintenance release only.
+
+### Changed
+- **`typescript`** 5.9.3 → 6.0.3 (major). TypeScript 6.0 changed the default `types` value from "auto-include all `@types`" to `[]`; `tsconfig.json` now sets `"types": ["node"]` (the documented migration) so the `@types/node` globals resolve. Build output validated byte-identical to the previous TypeScript 5.9 build.
+- **`@microsoft/api-extractor`** 7.57.2 → 7.58.7 (bundled TypeScript compiler 5.8.2 → 5.9.3, narrowing the parse skew against TypeScript 6.0; `tsup` typings rollup validated identical).
+- **`c8`** 10.1.3 → 11.0.0 (major — coverage tool upgrade; exercised by CI's Node 22.x coverage job).
+- **`@types/node`** 25.3.0 → 25.8.0.
+- **`@wharfkit/antelope`** 1.1.1 → 1.2.0 (test-only dependency).
+- **`node-addon-api`** 8.5.0 → 8.7.0 (native build-time headers; the prebuilt binary is unchanged).
+
+### Notes
+- `@microsoft/api-extractor` bundles TypeScript 5.9.3 and emits an informational `*** The target project appears to use TypeScript 6.0.3 which is newer than the bundled compiler engine` notice during the typings rollup. This is non-fatal; the generated `dist/_tsup-dts-rollup.d.ts` rollup is byte-identical to the TypeScript 5.9 baseline.
+- All updated packages are `devDependencies`; the package ships no runtime dependencies, so consumers are unaffected. Outstanding `npm audit` advisories are confined to dev/build transitive tooling and do not reach the published artifact.
+
+## [4.1.0-f7d5b45] - 2026-02-21
+
+> The `-f7d5b45` suffix denotes the upstream `AntelopeIO/abieos` commit hash bundled with this release.
+
+### Changed
+- Switched abieos submodule origin from `igorls/abieos` fork to official [`AntelopeIO/abieos`](https://github.com/AntelopeIO/abieos). The fork's `abieos_delete_contract` was merged upstream in [PR #27](https://github.com/AntelopeIO/abieos/pull/27), so the fork is no longer needed.
+- **`cmake-js`** 7.3.1 → 8.0.0 (major — build validated, no CMake changes required).
+- **`c8`** 9.1.0 → 10.1.3 (major — coverage tool upgrade).
+- **`@microsoft/api-extractor`** 7.52.13 → 7.57.2.
+- **`@types/node`** 24.6.0 → 25.3.0.
+- **`tsup`** 8.5.0 → 8.5.1.
+- **`typescript`** 5.9.2 → 5.9.3.
+
+---
+
+## [4.0.3-f7d5b45] - 2025-09-29
+
+> The `-f7d5b45` suffix denotes the upstream `AntelopeIO/abieos` commit hash bundled with this release.
+
+### Upstream Highlights (`2039717` → `f7d5b45`)
+- Added full support for the new `bitset` ABI type, including serialization/deserialization, key conversions, and regression tests.
+- Introduced `fixed_array` handling in the ABI serializer, so fixed-length array definitions now round-trip correctly.
+- Switched floating-point JSON conversion to `std::to_chars`, improving numeric fidelity and removing legacy `fpconv` sources.
+- Tightened validation around ABI parsing (better sanity checks, error messages, and compatibility guards) while keeping compatibility with `eosio::abi/1.x` definitions.
+- Streamlined upstream CI and build configurations (consistent CMake/toolchain defaults, GCC 14 coverage) matching the latest Antelope “Spring” tooling.
+
+### Added
+- `c8` coverage tooling to produce lcov reports consumed by Coveralls.
+- Comprehensive unit tests covering parse error branches to reach 100% coverage.
+- Repository `LICENSE` now includes upstream `AntelopeIO/abieos` MIT license details.
+- Formal `CHANGELOG.md` to track release history.
+
+### Changed
+- Workflow now runs coverage on Node 22.x only while keeping multi-version tests.
+
+### Fixed
+- Ensured `loadAbiHex` debug branch is executed within tests, eliminating remaining coverage gaps.

package/LICENSE

@@ -1,37 +1,37 @@
-MIT License
-
-Copyright (c) 2025 EOS Rio
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-----
-
-Portions of this project are derived from or bundle the `AntelopeIO/abieos`
-library, which is licensed under the MIT License:
-
-AntelopeIO/abieos
-
-Copyright (c) 2021-2022 EOS Network Foundation (ENF) and its
-contributors. All rights reserved.
-This ENF software is based upon:
-
-EOSIO/abieos
-
-Copyright (c) 2017-2019 block.one and its contributors. All rights
-reserved.
+MIT License
+
+Copyright (c) 2025 EOS Rio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+----
+
+Portions of this project are derived from or bundle the `AntelopeIO/abieos`
+library, which is licensed under the MIT License:
+
+AntelopeIO/abieos
+
+Copyright (c) 2021-2022 EOS Network Foundation (ENF) and its
+contributors. All rights reserved.
+This ENF software is based upon:
+
+EOSIO/abieos
+
+Copyright (c) 2017-2019 block.one and its contributors. All rights
+reserved.

package/README.md

@@ -1,89 +1,147 @@
-# node-abieos
-
-![CI](https://github.com/eosrio/node-abieos/actions/workflows/build.yml/badge.svg)
-![Node-API v9 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v9%20Badge.svg)
-[![NPM version](https://img.shields.io/npm/v/@eosrio/node-abieos.svg?style=flat)](https://www.npmjs.com/package/@eosrio/node-abieos)
-[![Coverage Status](https://coveralls.io/repos/github/eosrio/node-abieos/badge.svg?branch=master)](https://coveralls.io/github/eosrio/node-abieos?branch=master)
-
-Node.js native binding for [abieos](https://github.com/AntelopeIO/abieos), with some improvements:
-
-- Internal loaded contract map
-- deleteContract: to remove the loaded contract from memory (now in vanilla abieos too)
-
-Made with ♥ by [EOS Rio](https://eosrio.io/)
-
-----
-**Only Linux is supported for now**
-
-- Typescript typings included
-- Prebuilt binary included (Clang 18 required to build)
-- Now supports NodeJS, Deno, and Bun runtimes.
-
-## Install
-
-```shell script
-npm i @eosrio/node-abieos --save
-```
-
-## Usage
-
-CommonJS
-
-```js
-const nodeAbieos = require('@eosrio/node-abieos');
-```
-
-ES Modules (NodeJS, Bun)
-
-```typescript
-import {Abieos} from "@eosrio/node-abieos";
-const abieos = Abieos.getInstance();
-```
-
-Deno
-
-```bash
-# examples/basic.cjs can be run with:
-deno run --allow-ffi --allow-read examples/basic.cjs
-
-# For an example using the published npm package with Deno:
-# Check the examples/deno-abieos-test folder
-cd examples/deno-abieos-test
-deno run --allow-ffi --allow-read main.ts
-```
-
-Bun
-
-```shell script
-# examples/basic.mjs can be run with:
-bun run examples/basic.mjs
-```
-
-Check the [/examples](https://github.com/eosrio/node-abieos/tree/master/examples) folder for implementation examples
-
-## Building
-
-Make sure you have Clang installed on your system:
-We recommend using Clang 18 to build the `abieos` C++ library.
-
-```bash
-wget https://apt.llvm.org/llvm.sh
-chmod +x llvm.sh
-sudo ./llvm.sh 18
-```
-
-Clone and Build
-
-```shell script
-git clone https://github.com/eosrio/node-abieos.git --recursive
-cd node-abieos
-npm install
-npm run build:linux
-npm run build
-```
-
-### Documentation
-
-For detailed and user-friendly documentation, including installation, usage, API reference, error handling, debugging, and examples, please refer to the [documentation](docs/README.md).
-
-For contribution guidelines and developer documentation, refer to the [contribution guidelines](docs/CONTRIBUTING.md).
+# node-abieos
+
+![CI](https://github.com/eosrio/node-abieos/actions/workflows/build.yml/badge.svg)
+![Node-API v9 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v9%20Badge.svg)
+[![NPM version](https://img.shields.io/npm/v/@eosrio/node-abieos.svg?style=flat)](https://www.npmjs.com/package/@eosrio/node-abieos)
+[![Coverage Status](https://coveralls.io/repos/github/eosrio/node-abieos/badge.svg?branch=master)](https://coveralls.io/github/eosrio/node-abieos?branch=master)
+
+Node.js native binding for [abieos](https://github.com/AntelopeIO/abieos), with some improvements:
+
+- Internal loaded contract map
+- deleteContract: to remove the loaded contract from memory (now in vanilla abieos too)
+
+Made with ♥ by [EOS Rio](https://eosrio.io/)
+
+----
+**Linux, Windows and macOS are supported.** The npm package bundles a prebuilt
+binary per platform (`abieos-<platform>-<arch>.node`) and the loader picks the
+right one at runtime — `npm i` is zero-build on supported platforms. Building
+from source is only needed for unsupported platform/arch combinations or local
+development (see [Building](#building)).
+
+- Typescript typings included
+- Prebuilt binaries bundled: `linux-x64`, `win32-x64`, `darwin-x64`,
+  `darwin-arm64` (loaded automatically by platform/arch)
+- Windows builds with MinGW-w64 (GCC) — **MSVC is not supported**: the bundled
+  abieos C++ requires libstdc++/libc++ semantics MSVC's STL lacks
+- macOS builds with the Xcode Command Line Tools (Clang/libc++)
+- Now supports NodeJS, Deno, and Bun runtimes.
+
+## Install
+
+```shell script
+npm i @eosrio/node-abieos --save
+```
+
+## Usage
+
+CommonJS
+
+```js
+const nodeAbieos = require('@eosrio/node-abieos');
+```
+
+ES Modules (NodeJS, Bun)
+
+```typescript
+import {Abieos} from "@eosrio/node-abieos";
+const abieos = Abieos.getInstance();
+```
+
+Deno
+
+```bash
+# examples/basic.cjs can be run with:
+deno run --allow-ffi --allow-read examples/basic.cjs
+
+# For an example using the published npm package with Deno:
+# Check the examples/deno-abieos-test folder
+cd examples/deno-abieos-test
+deno run --allow-ffi --allow-read main.ts
+```
+
+Bun
+
+```shell script
+# examples/basic.mjs can be run with:
+bun run examples/basic.mjs
+```
+
+Check the [/examples](https://github.com/eosrio/node-abieos/tree/master/examples) folder for implementation examples
+
+## Building
+
+> Most users do **not** need this — the npm package ships prebuilt binaries for
+> `linux-x64`, `win32-x64`, `darwin-x64` and `darwin-arm64`. Build from source
+> only for an unsupported platform/arch or for local development.
+
+Clone with submodules first (required on every platform):
+
+```shell script
+git clone https://github.com/eosrio/node-abieos.git --recursive
+cd node-abieos
+npm install
+```
+
+### Linux
+
+We recommend Clang 18 to build the `abieos` C++ library:
+
+```bash
+wget https://apt.llvm.org/llvm.sh
+chmod +x llvm.sh
+sudo ./llvm.sh 18
+```
+
+```shell script
+npm run build:linux
+npm run build
+```
+
+### Windows (MinGW-w64)
+
+`abieos` does **not** build with MSVC — its C++ depends on libstdc++/libc++
+standard-library semantics and GCC/Clang extensions that MSVC's STL/compiler do
+not provide, and this is not patchable in the vendored submodule. Build with
+MinGW-w64 (GCC) instead.
+
+1. Install [MSYS2](https://www.msys2.org/), then from an MSYS2 shell install the
+   toolchain (any MinGW-w64 distribution with `g++`, `ninja` and `dlltool`
+   works, e.g. WinLibs):
+
+   ```bash
+   pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-ninja
+   ```
+
+2. Put the MinGW-w64 `bin` directory on `PATH` (e.g. `C:\msys64\mingw64\bin`)
+   so `g++`, `ninja` and `dlltool` are resolvable.
+
+3. Build:
+
+   ```shell script
+   npm run build:win
+   npm run build
+   ```
+
+`build:win` drives cmake-js with the Ninja generator and synthesizes a GNU
+import library for the Node-API symbols, so the resulting `.node` loads in the
+standard (MSVC-built) Node.js for Windows.
+
+### macOS
+
+Install the Xcode Command Line Tools (provides Clang and libc++):
+
+```bash
+xcode-select --install
+```
+
+```shell script
+npm run build:mac
+npm run build
+```
+
+### Documentation
+
+For detailed and user-friendly documentation, including installation, usage, API reference, error handling, debugging, and examples, please refer to the [documentation](docs/README.md).
+
+For contribution guidelines and developer documentation, refer to the [contribution guidelines](docs/CONTRIBUTING.md).