IOTA Wallet Library - Node.js binding
Requirements (only for building the binary yourself)
Ensure you have first installed the required dependencies for the library here and on Windows also LLVM, our workflow uses
https://github.com/llvm/llvm-project/releases/download/llvmorg-16.0.6/LLVM-16.0.6-win64.exe. On Windows, you may also need to set an environment variable
- Using NPM:
npm i @iota/wallet
- Using yarn:
yarn add @iota/wallet
Installation in repository
Installing nodejs bindings require a supported version of Node and Rust.
This fully installs the project, including installing any dependencies and running the build.
Building nodejs bindings
If you have already installed the project and only want to run the build, run:
npm run build
This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into
Prebuild requires that the binary is in
build/Release as though it was built with node-gyp.
In the project directory, you can run:
Installs the project, including running
npm run build.
Builds the Node addon (
index.node) from source.
The Cargo manifest file, which informs the
The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the
"main" key in
Under the hood, a Node addon is a dynamically-linked shared object. The
"build" script produces this file by copying it from within the
target/ directory, which is where the Rust build produces the shared object.
The npm manifest file, which informs the
The directory tree containing the Rust source code for the project.
The Rust library's main module.
Binary artifacts generated by the Rust build.
To learn more about Neon, see the Neon documentation.
To learn more about Rust, see the Rust documentation.
To learn more about Node, see the Node documentation.