@eosrio/node-abieos 4.0.2-2039717 → 4.0.3-f7d5b45

package/LICENSE

@@ -0,0 +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.

package/README.md

@@ -1,65 +1,89 @@
-# 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)
-
-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)
-
-### Install
-
-```shell script
-npm i @eosrio/node-abieos --save
-```
-
-### Usage
-
-CommonJS
-```js
-const nodeAbieos = require('@eosrio/node-abieos');
-```
-
-ES Modules
-```typescript
-import {Abieos} from "@eosrio/node-abieos";
-const abieos = Abieos.getInstance();
-```
-
-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/)
+
+----
+**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).

package/dist/_tsup-dts-rollup.d.cts

@@ -1,105 +1,105 @@
-/**
- * Abieos class provides a singleton instance for interacting with the native abieos module.
- * This pattern is used to ensure a single global context for the underlying C++ abieos library,
- * which manages internal state and resources.
- */
-export declare class Abieos {
-    static logTag: string;
-    private static instance;
-    static native: typeof abieos;
-    private static loadedContracts;
-    static debug: boolean;
-    /**
-     * Private constructor to enforce the Singleton pattern.
-     * Throws an error if an attempt is made to create a second instance.
-     */
-    private constructor();
-    /**
-     * Returns the singleton instance of the Abieos class.
-     * If an instance does not already exist, it creates one.
-     * @returns {Abieos} The singleton instance of Abieos.
-     */
-    static getInstance(): Abieos;
-    getLoadedAbis(): string[];
-    /**
-     * Cleans up all loaded contracts by deleting them from the native context.
-     * This is useful for freeing up resources and ensuring a clean state.
-     */
-    cleanup(): void;
-    /**
-     * Converts a string name to its corresponding 64-bit unsigned integer representation (BigInt).
-     * @param {string} nameString The string name to convert.
-     * @returns {BigInt} The BigInt representation of the name.
-     */
-    stringToName(nameString: string): BigInt;
-    /**
-     * Converts a JSON string or object to its hexadecimal binary representation.
-     * @param {string} contractName The name of the contract.
-     * @param {string} type The type within the ABI to use for conversion.
-     * @param {string | object} json The JSON data as a string or object.
-     * @returns {string} The hexadecimal string representation of the binary data.
-     * @throws {Error} If parsing fails or an error occurs in the native module.
-     */
-    jsonToHex(contractName: string, type: string, json: string | object): string;
-    /**
-     * Converts a hexadecimal binary string to its JSON representation.
-     * @param {string} contractName The name of the contract.
-     * @param {string} type The type within the ABI to use for conversion.
-     * @param {string} hex The hexadecimal string to convert.
-     * @returns {any} The parsed JSON object.
-     * @throws {Error} If parsing fails or an error occurs in the native module.
-     */
-    hexToJson(contractName: string, type: string, hex: string): any;
-    /**
-     * Converts a binary buffer to its JSON representation.
-     * @param {string} contractName The name of the contract.
-     * @param {string} type The type within the ABI to use for conversion.
-     * @param {Buffer} buffer The binary data as a Buffer.
-     * @returns {any} The parsed JSON object.
-     * @throws {Error} If parsing fails or an error occurs in the native module.
-     */
-    binToJson(contractName: string, type: string, buffer: Buffer): any;
-    /**
-     * Loads an ABI for a given contract.
-     * @param {string} contractName The name of the contract for which to load the ABI.
-     * @param {string | object} abi The ABI as a JSON string or object.
-     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
-     * @throws {Error} If the ABI format is invalid or loading fails.
-     */
-    loadAbi(contractName: string, abi: string | object): boolean;
-    /**
-     * Loads an ABI for a given contract from its hexadecimal representation.
-     * @param {string} contractName The name of the contract for which to load the ABI.
-     * @param {string} abihex The ABI as a hexadecimal string.
-     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
-     * @throws {Error} If loading fails.
-     */
-    loadAbiHex(contractName: string, abihex: string): boolean;
-    /**
-     * Retrieves the type name for a specific action within a contract's ABI.
-     * @param {string} contractName The name of the contract.
-     * @param {string} actionName The name of the action.
-     * @returns {string} The type name associated with the action.
-     * @throws {Error} If the contract or action is not found or another error occurs.
-     */
-    getTypeForAction(contractName: string, actionName: string): string;
-    /**
-     * Retrieves the type name for a specific table within a contract's ABI.
-     * @param {string} contractName The name of the contract.
-     * @param {string} table_name The name of the table.
-     * @returns {string} The type name associated with the table.
-     * @throws {Error} If the contract or table is not found or another error occurs.
-     */
-    getTypeForTable(contractName: string, table_name: string): string;
-    /**
-     * Deletes a contract's ABI from the abieos context.
-     * @param {string} contractName The name of the contract to delete.
-     * @returns {boolean} True if the contract was successfully deleted, false otherwise.
-     * @throws {Error} If deletion fails.
-     */
-    deleteContract(contractName: string): boolean;
-}
-
-declare const abieos: any;
-
-export { }
+/**
+ * Abieos class provides a singleton instance for interacting with the native abieos module.
+ * This pattern is used to ensure a single global context for the underlying C++ abieos library,
+ * which manages internal state and resources.
+ */
+export declare class Abieos {
+    static logTag: string;
+    private static instance;
+    static native: typeof abieos;
+    private static loadedContracts;
+    static debug: boolean;
+    /**
+     * Private constructor to enforce the Singleton pattern.
+     * Throws an error if an attempt is made to create a second instance.
+     */
+    private constructor();
+    /**
+     * Returns the singleton instance of the Abieos class.
+     * If an instance does not already exist, it creates one.
+     * @returns {Abieos} The singleton instance of Abieos.
+     */
+    static getInstance(): Abieos;
+    getLoadedAbis(): string[];
+    /**
+     * Cleans up all loaded contracts by deleting them from the native context.
+     * This is useful for freeing up resources and ensuring a clean state.
+     */
+    cleanup(): void;
+    /**
+     * Converts a string name to its corresponding 64-bit unsigned integer representation (BigInt).
+     * @param {string} nameString The string name to convert.
+     * @returns {BigInt} The BigInt representation of the name.
+     */
+    stringToName(nameString: string): BigInt;
+    /**
+     * Converts a JSON string or object to its hexadecimal binary representation.
+     * @param {string} contractName The name of the contract.
+     * @param {string} type The type within the ABI to use for conversion.
+     * @param {string | object} json The JSON data as a string or object.
+     * @returns {string} The hexadecimal string representation of the binary data.
+     * @throws {Error} If parsing fails or an error occurs in the native module.
+     */
+    jsonToHex(contractName: string, type: string, json: string | object): string;
+    /**
+     * Converts a hexadecimal binary string to its JSON representation.
+     * @param {string} contractName The name of the contract.
+     * @param {string} type The type within the ABI to use for conversion.
+     * @param {string} hex The hexadecimal string to convert.
+     * @returns {any} The parsed JSON object.
+     * @throws {Error} If parsing fails or an error occurs in the native module.
+     */
+    hexToJson(contractName: string, type: string, hex: string): any;
+    /**
+     * Converts a binary buffer to its JSON representation.
+     * @param {string} contractName The name of the contract.
+     * @param {string} type The type within the ABI to use for conversion.
+     * @param {Buffer} buffer The binary data as a Buffer.
+     * @returns {any} The parsed JSON object.
+     * @throws {Error} If parsing fails or an error occurs in the native module.
+     */
+    binToJson(contractName: string, type: string, buffer: Buffer): any;
+    /**
+     * Loads an ABI for a given contract.
+     * @param {string} contractName The name of the contract for which to load the ABI.
+     * @param {string | object} abi The ABI as a JSON string or object.
+     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
+     * @throws {Error} If the ABI format is invalid or loading fails.
+     */
+    loadAbi(contractName: string, abi: string | object): boolean;
+    /**
+     * Loads an ABI for a given contract from its hexadecimal representation.
+     * @param {string} contractName The name of the contract for which to load the ABI.
+     * @param {string} abihex The ABI as a hexadecimal string.
+     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
+     * @throws {Error} If loading fails.
+     */
+    loadAbiHex(contractName: string, abihex: string): boolean;
+    /**
+     * Retrieves the type name for a specific action within a contract's ABI.
+     * @param {string} contractName The name of the contract.
+     * @param {string} actionName The name of the action.
+     * @returns {string} The type name associated with the action.
+     * @throws {Error} If the contract or action is not found or another error occurs.
+     */
+    getTypeForAction(contractName: string, actionName: string): string;
+    /**
+     * Retrieves the type name for a specific table within a contract's ABI.
+     * @param {string} contractName The name of the contract.
+     * @param {string} table_name The name of the table.
+     * @returns {string} The type name associated with the table.
+     * @throws {Error} If the contract or table is not found or another error occurs.
+     */
+    getTypeForTable(contractName: string, table_name: string): string;
+    /**
+     * Deletes a contract's ABI from the abieos context.
+     * @param {string} contractName The name of the contract to delete.
+     * @returns {boolean} True if the contract was successfully deleted, false otherwise.
+     * @throws {Error} If deletion fails.
+     */
+    deleteContract(contractName: string): boolean;
+}
+
+declare const abieos: any;
+
+export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -1,105 +1,105 @@
-/**
- * Abieos class provides a singleton instance for interacting with the native abieos module.
- * This pattern is used to ensure a single global context for the underlying C++ abieos library,
- * which manages internal state and resources.
- */
-export declare class Abieos {
-    static logTag: string;
-    private static instance;
-    static native: typeof abieos;
-    private static loadedContracts;
-    static debug: boolean;
-    /**
-     * Private constructor to enforce the Singleton pattern.
-     * Throws an error if an attempt is made to create a second instance.
-     */
-    private constructor();
-    /**
-     * Returns the singleton instance of the Abieos class.
-     * If an instance does not already exist, it creates one.
-     * @returns {Abieos} The singleton instance of Abieos.
-     */
-    static getInstance(): Abieos;
-    getLoadedAbis(): string[];
-    /**
-     * Cleans up all loaded contracts by deleting them from the native context.
-     * This is useful for freeing up resources and ensuring a clean state.
-     */
-    cleanup(): void;
-    /**
-     * Converts a string name to its corresponding 64-bit unsigned integer representation (BigInt).
-     * @param {string} nameString The string name to convert.
-     * @returns {BigInt} The BigInt representation of the name.
-     */
-    stringToName(nameString: string): BigInt;
-    /**
-     * Converts a JSON string or object to its hexadecimal binary representation.
-     * @param {string} contractName The name of the contract.
-     * @param {string} type The type within the ABI to use for conversion.
-     * @param {string | object} json The JSON data as a string or object.
-     * @returns {string} The hexadecimal string representation of the binary data.
-     * @throws {Error} If parsing fails or an error occurs in the native module.
-     */
-    jsonToHex(contractName: string, type: string, json: string | object): string;
-    /**
-     * Converts a hexadecimal binary string to its JSON representation.
-     * @param {string} contractName The name of the contract.
-     * @param {string} type The type within the ABI to use for conversion.
-     * @param {string} hex The hexadecimal string to convert.
-     * @returns {any} The parsed JSON object.
-     * @throws {Error} If parsing fails or an error occurs in the native module.
-     */
-    hexToJson(contractName: string, type: string, hex: string): any;
-    /**
-     * Converts a binary buffer to its JSON representation.
-     * @param {string} contractName The name of the contract.
-     * @param {string} type The type within the ABI to use for conversion.
-     * @param {Buffer} buffer The binary data as a Buffer.
-     * @returns {any} The parsed JSON object.
-     * @throws {Error} If parsing fails or an error occurs in the native module.
-     */
-    binToJson(contractName: string, type: string, buffer: Buffer): any;
-    /**
-     * Loads an ABI for a given contract.
-     * @param {string} contractName The name of the contract for which to load the ABI.
-     * @param {string | object} abi The ABI as a JSON string or object.
-     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
-     * @throws {Error} If the ABI format is invalid or loading fails.
-     */
-    loadAbi(contractName: string, abi: string | object): boolean;
-    /**
-     * Loads an ABI for a given contract from its hexadecimal representation.
-     * @param {string} contractName The name of the contract for which to load the ABI.
-     * @param {string} abihex The ABI as a hexadecimal string.
-     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
-     * @throws {Error} If loading fails.
-     */
-    loadAbiHex(contractName: string, abihex: string): boolean;
-    /**
-     * Retrieves the type name for a specific action within a contract's ABI.
-     * @param {string} contractName The name of the contract.
-     * @param {string} actionName The name of the action.
-     * @returns {string} The type name associated with the action.
-     * @throws {Error} If the contract or action is not found or another error occurs.
-     */
-    getTypeForAction(contractName: string, actionName: string): string;
-    /**
-     * Retrieves the type name for a specific table within a contract's ABI.
-     * @param {string} contractName The name of the contract.
-     * @param {string} table_name The name of the table.
-     * @returns {string} The type name associated with the table.
-     * @throws {Error} If the contract or table is not found or another error occurs.
-     */
-    getTypeForTable(contractName: string, table_name: string): string;
-    /**
-     * Deletes a contract's ABI from the abieos context.
-     * @param {string} contractName The name of the contract to delete.
-     * @returns {boolean} True if the contract was successfully deleted, false otherwise.
-     * @throws {Error} If deletion fails.
-     */
-    deleteContract(contractName: string): boolean;
-}
-
-declare const abieos: any;
-
-export { }
+/**
+ * Abieos class provides a singleton instance for interacting with the native abieos module.
+ * This pattern is used to ensure a single global context for the underlying C++ abieos library,
+ * which manages internal state and resources.
+ */
+export declare class Abieos {
+    static logTag: string;
+    private static instance;
+    static native: typeof abieos;
+    private static loadedContracts;
+    static debug: boolean;
+    /**
+     * Private constructor to enforce the Singleton pattern.
+     * Throws an error if an attempt is made to create a second instance.
+     */
+    private constructor();
+    /**
+     * Returns the singleton instance of the Abieos class.
+     * If an instance does not already exist, it creates one.
+     * @returns {Abieos} The singleton instance of Abieos.
+     */
+    static getInstance(): Abieos;
+    getLoadedAbis(): string[];
+    /**
+     * Cleans up all loaded contracts by deleting them from the native context.
+     * This is useful for freeing up resources and ensuring a clean state.
+     */
+    cleanup(): void;
+    /**
+     * Converts a string name to its corresponding 64-bit unsigned integer representation (BigInt).
+     * @param {string} nameString The string name to convert.
+     * @returns {BigInt} The BigInt representation of the name.
+     */
+    stringToName(nameString: string): BigInt;
+    /**
+     * Converts a JSON string or object to its hexadecimal binary representation.
+     * @param {string} contractName The name of the contract.
+     * @param {string} type The type within the ABI to use for conversion.
+     * @param {string | object} json The JSON data as a string or object.
+     * @returns {string} The hexadecimal string representation of the binary data.
+     * @throws {Error} If parsing fails or an error occurs in the native module.
+     */
+    jsonToHex(contractName: string, type: string, json: string | object): string;
+    /**
+     * Converts a hexadecimal binary string to its JSON representation.
+     * @param {string} contractName The name of the contract.
+     * @param {string} type The type within the ABI to use for conversion.
+     * @param {string} hex The hexadecimal string to convert.
+     * @returns {any} The parsed JSON object.
+     * @throws {Error} If parsing fails or an error occurs in the native module.
+     */
+    hexToJson(contractName: string, type: string, hex: string): any;
+    /**
+     * Converts a binary buffer to its JSON representation.
+     * @param {string} contractName The name of the contract.
+     * @param {string} type The type within the ABI to use for conversion.
+     * @param {Buffer} buffer The binary data as a Buffer.
+     * @returns {any} The parsed JSON object.
+     * @throws {Error} If parsing fails or an error occurs in the native module.
+     */
+    binToJson(contractName: string, type: string, buffer: Buffer): any;
+    /**
+     * Loads an ABI for a given contract.
+     * @param {string} contractName The name of the contract for which to load the ABI.
+     * @param {string | object} abi The ABI as a JSON string or object.
+     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
+     * @throws {Error} If the ABI format is invalid or loading fails.
+     */
+    loadAbi(contractName: string, abi: string | object): boolean;
+    /**
+     * Loads an ABI for a given contract from its hexadecimal representation.
+     * @param {string} contractName The name of the contract for which to load the ABI.
+     * @param {string} abihex The ABI as a hexadecimal string.
+     * @returns {boolean} True if the ABI was loaded successfully, false otherwise.
+     * @throws {Error} If loading fails.
+     */
+    loadAbiHex(contractName: string, abihex: string): boolean;
+    /**
+     * Retrieves the type name for a specific action within a contract's ABI.
+     * @param {string} contractName The name of the contract.
+     * @param {string} actionName The name of the action.
+     * @returns {string} The type name associated with the action.
+     * @throws {Error} If the contract or action is not found or another error occurs.
+     */
+    getTypeForAction(contractName: string, actionName: string): string;
+    /**
+     * Retrieves the type name for a specific table within a contract's ABI.
+     * @param {string} contractName The name of the contract.
+     * @param {string} table_name The name of the table.
+     * @returns {string} The type name associated with the table.
+     * @throws {Error} If the contract or table is not found or another error occurs.
+     */
+    getTypeForTable(contractName: string, table_name: string): string;
+    /**
+     * Deletes a contract's ABI from the abieos context.
+     * @param {string} contractName The name of the contract to delete.
+     * @returns {boolean} True if the contract was successfully deleted, false otherwise.
+     * @throws {Error} If deletion fails.
+     */
+    deleteContract(contractName: string): boolean;
+}
+
+declare const abieos: any;
+
+export { }