Developing

Prerequisites

• Node.js >= 24.6.0 (see .nvmrc)
• A GitHub account with access to the KagamiDigital organisation

Registry setup

salt-sdk depends on @kagamidigital/salt-signer-sdk, hosted on GitHub Packages. Authenticate once before installing:

npm login --registry=https://npm.pkg.github.com
Copy

Use your GitHub username and a classic personal access token with read:packages scope as the password. To create one: github.com/settings/tokens → "Generate new token (classic)" → check read:packages. Fine-grained PATs do not support GitHub Packages. This writes credentials to ~/.npmrc and is a one-time setup per machine.

Install and build

npm ci
npm run build
Copy

Tests

npm test          # unit tests
npm run test:e2e  # end-to-end tests
Copy