v3.3.0

adjust module settings to ensure hyperion 3.3.10 compatibility

.npmignore

@@ -7,3 +7,4 @@ tools
 CMakeLists.txt
 tsconfig.json
 *.tgz
+abieos

README.md

@@ -12,10 +12,10 @@ Node.js native binding for [abieos](https://github.com/EOSIO/abieos), with some
 Made with ♥ by [EOS Rio](https://eosrio.io/)
 
 ----
-**Only Linux is supported for now, import will be null on others**
+**Only Linux is supported for now**
 
 - Typescript typings included
-- Prebuilt binary included (Clang 9.0.0 required to build)
+- Prebuilt binary included (Clang 18 required to build)
 
 ### Install
 
@@ -39,12 +39,20 @@ Check the [/examples](https://github.com/eosrio/node-abieos/tree/master/examples
 
 ### Building
 
-env setup instructions soon
+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
 cd node-abieos
-# linux
+npm install
 npm run build:linux
-# windows
-npm run build:win
+npm run build:tsc
 ```

examples/basic.js → examples/basic.mjs

@@ -1,6 +1,6 @@
 import {Abieos} from "../lib/abieos.js";
 import {readFileSync} from "node:fs";
-import {typeTests} from "./tests.js";
+import {typeTests} from "./tests.mjs";
 
 const ABIs = [
     {code: 'eosio', path: './ABIs/eosio.json'},

lib/abieos.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-declare let abieos: any | null;
+declare const abieos: any;
 export declare class Abieos {
     private static instance;
     static native: typeof abieos;

lib/abieos.js

@@ -1,15 +1,8 @@
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-let modulePath = "../dist/abieos.node";
-let abieos = null;
-if (process.platform === 'linux') {
-    abieos = require(modulePath);
-}
-else if (process.platform === 'win32') {
-    // throw new Error(`${process.platform} is not supported by node-abieos`);
-    abieos = null;
-}
-export class Abieos {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Abieos = void 0;
+const abieos = require("./abieos.node");
+class Abieos {
     constructor() {
         Abieos.native = abieos;
     }
@@ -98,3 +91,4 @@ export class Abieos {
         return Abieos.native.delete_contract(contractName);
     }
 }
+exports.Abieos = Abieos;

lib/abieos.ts

@@ -1,15 +1,4 @@
-import {createRequire} from 'module';
-
-const require = createRequire(import.meta.url);
-
-let modulePath = "../dist/abieos.node";
-let abieos: any | null = null;
-if (process.platform === 'linux') {
-    abieos = require(modulePath);
-} else if (process.platform === 'win32') {
-    // throw new Error(`${process.platform} is not supported by node-abieos`);
-    abieos = null;
-}
+const abieos = require("./abieos.node");
 
 export class Abieos {
     private static instance: Abieos;
@@ -103,4 +92,4 @@ export class Abieos {
     public deleteContract(contractName: string): boolean {
         return Abieos.native.delete_contract(contractName) as boolean;
     }
-}
+}