Node Keyring
A Node-API addon for the Cosmos Keyring Go library to store values using the OS keyring or the filesystem.
Project Design and Structure
The project uses the recommended tooling for NAPI projects:
- Built with C++ to expose Go API to Javascript using the node-addon-api.
- Uses the node-gyp build tool.
- Uses prebuildify to prebuild the binaries for your platform.
Folder structure:
-
src/go
: contains all go files -
src/keyring.cc
: exposes the C-bound native API to Node.js using C++ -
src/node
import thekeyring.cc
exports to Javascript
Development
Requirements
You will be building native code, and therefore, a comprehensive number of requirements are needed:
node --version
npm --version
make --version
go --version
python --version
On Mac
Install the XCode Command Line Tools
:
xcode-select --install
Which will install clang
:
cc --version
On Linux
gcc --version
[!NOTE] Confirm that you have a relatively recent version of each of these dependencies.
Setup
npm install --ignore-scripts
You should use the
--ignore-scripts
flag to avoid running the install script.
Build
npm run build
The build process uses cgo
to compile the Go
module into a static C library and node-gyp
to make the C++ addon available on Node.js via NAPI.
To avoid compiling the package on the user's machine, the script uses
prebuildify to prebuild the binaries
for specific platforms. All the prebuilt node binaries are bundled with the
package inside the prebuilds
folder.
When installing the package, the install script will check if a compatible prebuild is bundled for the current platform. If it is, it will be used instead of building from source.
Once the build completes, you should see the build
folder in the repository
root containing all NAPI-related files.
The npm run build
script will automatically run the build.sh
script to build
the Go module to a C library before producing the prebuild binary.
[!NOTE] On macOS, it's possible to build for both architectures (
x64
andarm64
). For that, you will need to runnpm run build:x64
and thennpm run build:arm64
. Be aware that you should execute runnpm run build
later. Otherwise, the generated binaries might not be compatible with your current platform.
cgo
Build the Go package to C using To build only the Go module for your current platform and architecture, run:
./build.sh
Once the build is complete, you should see the files keyring.h
and keyring.a
in the out
folder.
Test
To run the bindings tests:
npm run test