@eosrio/node-abieos 3.1.0 → 3.3.0

package/.cache/jb/version.txt

@@ -0,0 +1 @@
+(ssh://git@git.jetbrains.team/llvm/llvm-project.git eeb64a79f164f241d539c0a3f0491b50a854ead9 based on LLVM a01392cc95a03e97d8dc19cc3b3484daf9a4f19e revision)

package/.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Node.js Addon with CMake
+
+on:
+  push:
+    branches: [ "master", "3.3-staging" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+
+    steps:
+    # Checkout repo and submodules
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    # Setup Node.js
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build:linux:ci
+    - run: npm run build:tsc
+    - run: npm run test

package/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "abieos"]
+	path = abieos
+	url = https://github.com/igorls/abieos.git

package/README.md

@@ -1,46 +1,58 @@
-# node-abieos
-
-Node.js native binding for [abieos](https://github.com/EOSIO/abieos), with some improvements:
-
-- Contracts can be directly updated on the map
-- Added `abieos_delete_contract`
-
-Made with ♥ by [EOS Rio](https://eosrio.io/)
-
-----
-**Only Linux is supported for now, import will be null on others**
-
-- Typescript typings included
-- Prebuilt binary included (Clang 9.0.0 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 * as nodeAbieos from "@eosrio/node-abieos";
-```
-
-Check the [/examples](https://github.com/eosrio/node-abieos/tree/master/examples) folder for implementation examples
-
-### Building
-
-env setup instructions soon
-```shell script
-git clone https://github.com/eosrio/node-abieos.git
-cd node-abieos
-# linux
-npm run build:linux
-# windows
-npm run build:win
-```
+# 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/EOSIO/abieos), with some improvements:
+
+- Contracts can be directly updated on the map
+- Added `abieos_delete_contract`
+
+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 * as nodeAbieos from "@eosrio/node-abieos";
+```
+
+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
+cd node-abieos
+npm install
+npm run build:linux
+npm run build:tsc
+```

package/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;
@@ -7,8 +7,8 @@ export declare class Abieos {
     static getInstance(): Abieos;
     stringToName(nameString: string): BigInteger;
     jsonToHex(contractName: string, type: string, json: string | object): string;
-    hexToJson(contractName: string, type: string, hex: string): string;
-    binToJson(contractName: string, type: string, buffer: Buffer): string;
+    hexToJson(contractName: string, type: string, hex: string): any;
+    binToJson(contractName: string, type: string, buffer: Buffer): any;
     loadAbi(contractName: string, abi: string | object): boolean;
     loadAbiHex(contractName: string, abihex: string): boolean;
     getTypeForAction(contractName: string, actionName: string): string;

package/lib/abieos.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"abieos.d.ts","sourceRoot":"","sources":["abieos.ts"],"names":[],"mappings":";AAKA,QAAA,IAAI,MAAM,EAAE,GAAG,GAAG,IAAW,CAAC;AAQ9B,qBAAa,MAAM;IACf,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO;WAIO,WAAW,IAAI,MAAM;IAO5B,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU;IAI5C,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAU5E,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAalE,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAarE,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAY5D,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAIzD,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IASlE,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IASjE,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;CAGvD"}
+{"version":3,"file":"abieos.d.ts","sourceRoot":"","sources":["abieos.ts"],"names":[],"mappings":";AAAA,QAAA,MAAM,MAAM,KAA2B,CAAC;AAExC,qBAAa,MAAM;IACf,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAS;IAChC,OAAc,MAAM,EAAE,OAAO,MAAM,CAAC;IAEpC,OAAO;WAIO,WAAW,IAAI,MAAM;IAO5B,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU;IAI5C,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAU5E,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG;IAa/D,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG;IAalE,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO;IAY5D,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAIzD,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IASlE,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IASjE,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;CAGvD"}

package/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;

package/lib/abieos.ts

@@ -1,106 +1,95 @@
-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;
-}
-
-export class Abieos {
-    private static instance: Abieos;
-    public static native: typeof abieos;
-
-    private constructor() {
-        Abieos.native = abieos;
-    }
-
-    public static getInstance(): Abieos {
-        if (!Abieos.instance) {
-            Abieos.instance = new Abieos();
-        }
-        return Abieos.instance;
-    }
-
-    public stringToName(nameString: string): BigInteger {
-        return Abieos.native.string_to_name(nameString) as BigInteger;
-    }
-
-    public jsonToHex(contractName: string, type: string, json: string | object): string {
-        const jsonData = typeof json === 'object' ? JSON.stringify(json) : json
-        const data: string = Abieos.native.json_to_hex(contractName, type, jsonData);
-        if (data === 'PARSING_ERROR') {
-            throw new Error('failed to parse data');
-        } else {
-            return data;
-        }
-    }
-
-    public hexToJson(contractName: string, type: string, hex: string): string {
-        const data = Abieos.native.hex_to_json(contractName, type, hex);
-        if (data) {
-            try {
-                return JSON.parse(data);
-            } catch (e) {
-                throw new Error('failed to parse json string: ' + data);
-            }
-        } else {
-            throw new Error('failed to parse hex data');
-        }
-    }
-
-    public binToJson(contractName: string, type: string, buffer: Buffer): string {
-        const data = Abieos.native.bin_to_json(contractName, type, buffer);
-        if (data[0] === '{' || data[0] === '[') {
-            try {
-                return JSON.parse(data);
-            } catch (e) {
-                throw new Error('json parse error');
-            }
-        } else {
-            throw new Error(data);
-        }
-    }
-
-    public loadAbi(contractName: string, abi: string | object): boolean {
-        if (typeof abi === 'string') {
-            return Abieos.native.load_abi(contractName, abi) as boolean;
-        } else {
-            if (typeof abi === 'object') {
-                return Abieos.native.load_abi(contractName, JSON.stringify(abi)) as boolean;
-            } else {
-                throw new Error('ABI must be a String or Object');
-            }
-        }
-    }
-
-    public loadAbiHex(contractName: string, abihex: string): boolean {
-        return Abieos.native.load_abi_hex(contractName, abihex) as boolean;
-    }
-
-    public getTypeForAction(contractName: string, actionName: string): string {
-        const result = Abieos.native.get_type_for_action(contractName, actionName);
-        if (result === 'NOT_FOUND') {
-            throw new Error('action ' + actionName + ' not found on contract ' + contractName);
-        } else {
-            return result;
-        }
-    }
-
-    public getTypeForTable(contractName: string, table_name: string): string {
-        const result = Abieos.native.get_type_for_table(contractName, table_name);
-        if (result === 'NOT_FOUND') {
-            throw new Error('table ' + table_name + ' not found on contract ' + contractName);
-        } else {
-            return result;
-        }
-    }
-
-    public deleteContract(contractName: string): boolean {
-        return Abieos.native.delete_contract(contractName) as boolean;
-    }
-}
+const abieos = require("./abieos.node");
+
+export class Abieos {
+    private static instance: Abieos;
+    public static native: typeof abieos;
+
+    private constructor() {
+        Abieos.native = abieos;
+    }
+
+    public static getInstance(): Abieos {
+        if (!Abieos.instance) {
+            Abieos.instance = new Abieos();
+        }
+        return Abieos.instance;
+    }
+
+    public stringToName(nameString: string): BigInteger {
+        return Abieos.native.string_to_name(nameString) as BigInteger;
+    }
+
+    public jsonToHex(contractName: string, type: string, json: string | object): string {
+        const jsonData = typeof json === 'object' ? JSON.stringify(json) : json
+        const data: string = Abieos.native.json_to_hex(contractName, type, jsonData);
+        if (data === 'PARSING_ERROR') {
+            throw new Error('failed to parse data');
+        } else {
+            return data;
+        }
+    }
+
+    public hexToJson(contractName: string, type: string, hex: string): any {
+        const data = Abieos.native.hex_to_json(contractName, type, hex);
+        if (data) {
+            try {
+                return JSON.parse(data);
+            } catch (e) {
+                throw new Error('failed to parse json string: ' + data);
+            }
+        } else {
+            throw new Error('failed to parse hex data');
+        }
+    }
+
+    public binToJson(contractName: string, type: string, buffer: Buffer): any {
+        const data = Abieos.native.bin_to_json(contractName, type, buffer);
+        if (data[0] === '{' || data[0] === '[') {
+            try {
+                return JSON.parse(data);
+            } catch (e) {
+                throw new Error('json parse error');
+            }
+        } else {
+            throw new Error(data);
+        }
+    }
+
+    public loadAbi(contractName: string, abi: string | object): boolean {
+        if (typeof abi === 'string') {
+            return Abieos.native.load_abi(contractName, abi) as boolean;
+        } else {
+            if (typeof abi === 'object') {
+                return Abieos.native.load_abi(contractName, JSON.stringify(abi)) as boolean;
+            } else {
+                throw new Error('ABI must be a String or Object');
+            }
+        }
+    }
+
+    public loadAbiHex(contractName: string, abihex: string): boolean {
+        return Abieos.native.load_abi_hex(contractName, abihex) as boolean;
+    }
+
+    public getTypeForAction(contractName: string, actionName: string): string {
+        const result = Abieos.native.get_type_for_action(contractName, actionName);
+        if (result === 'NOT_FOUND') {
+            throw new Error('action ' + actionName + ' not found on contract ' + contractName);
+        } else {
+            return result;
+        }
+    }
+
+    public getTypeForTable(contractName: string, table_name: string): string {
+        const result = Abieos.native.get_type_for_table(contractName, table_name);
+        if (result === 'NOT_FOUND') {
+            throw new Error('table ' + table_name + ' not found on contract ' + contractName);
+        } else {
+            return result;
+        }
+    }
+
+    public deleteContract(contractName: string): boolean {
+        return Abieos.native.delete_contract(contractName) as boolean;
+    }
+}

package/package.json

@@ -1,36 +1,51 @@
-{
-  "name": "@eosrio/node-abieos",
-  "version": "3.1.0",
-  "description": "Node Bindings for abieos: Binary <> JSON conversion using ABIs.",
-  "main": "./lib/abieos.js",
-  "typings": "./lib/abieos.d.ts",
-  "scripts": {
-    "install": "node -e 'process.exit(0)'",
-    "test": "cd examples && node basic.js",
-    "tsc:watch": "tsc --watch",
-    "build:linux": "cmake-js compile --cc /usr/bin/clang --cxx /usr/bin/clang++ && cp build/Release/node_abieos.node dist/abieos.node",
-    "build:win": "cmake-js"
-  },
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/eosrio/node-abieos.git"
-  },
-  "author": "EOS Rio",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/eosrio/node-abieos/issues"
-  },
-  "homepage": "https://github.com/eosrio/node-abieos#readme",
-  "devDependencies": {
-    "node-addon-api": "^5.0.0",
-    "cmake-js": "^7.0.0",
-    "@types/node": "^18.11.0",
-    "typescript": "^4.8.4"
-  },
-  "cmake-js": {
-    "runtime": "node",
-    "runtimeVersion": "18.0.0",
-    "arch": "x64"
-  }
-}
+{
+  "name": "@eosrio/node-abieos",
+  "version": "3.3.0",
+  "description": "Node Bindings for abieos: Binary <> JSON conversion using ABIs.",
+  "main": "./lib/abieos.js",
+  "types": "./lib/abieos.d.ts",
+  "exports": {
+    ".": {
+      "require": "./lib/abieos.js",
+      "types": "./lib/abieos.d.ts"
+    }
+  },
+  "scripts": {
+    "install": "node -e 'process.exit(0)'",
+    "test": "cd examples && node basic.mjs",
+    "tsc:watch": "tsc --watch",
+    "clean": "cmake-js clean",
+    "bundle": "tsup lib/abieos.ts --format cjs,esm --dts --clean",
+    "build:tsc": "tsc",
+    "build:linux": "cmake-js compile --cc /usr/bin/clang-18 --cxx /usr/bin/clang++-18 && cp build/Release/node_abieos.node lib/abieos.node",
+    "build:linux:ci": "cmake-js compile && cp build/Release/node_abieos.node lib/abieos.node",
+    "build:win": "cmake-js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eosrio/node-abieos.git"
+  },
+  "author": "EOS Rio",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/eosrio/node-abieos/issues"
+  },
+  "homepage": "https://github.com/eosrio/node-abieos#readme",
+  "devDependencies": {
+    "@types/node": "20.12.7",
+    "cmake-js": "7.3.0",
+    "node-addon-api": "8.0.0",
+    "tsup": "^8.0.2",
+    "typescript": "5.4.5"
+  },
+  "binary": {
+    "napi_versions": [
+      9
+    ]
+  },
+  "cmake-js": {
+    "runtime": "node",
+    "runtimeVersion": "20.0.0",
+    "arch": "x64"
+  }
+}