Solana Toolkit aims to provide Solana developers with some utilities
Inspector: inspect encoded message to Solana message / transaction
import { inspectMessage } from `solana-toolkit`prettyLog: beatify program logs like Solscan
import { prettyProgramLogs } from `solana-toolkit`# Install dependencies
yarn install
# Now you can run various yarn commands:
yarn cli
yarn lint
yarn test
yarn build
...- Take a look at all the scripts in
package.json - For publishing to npm, use
yarn publish(ornpm publish)
esbuild is an extremely fast bundler that supports a large part of the TypeScript syntax. This project uses it to bundle for browsers (and Node.js if you want).
# Build for browsers
yarn esbuild-browser:dev
yarn esbuild-browser:watch
# Build the cli for node
yarn esbuild-node:dev
yarn esbuild-node:watchYou can generate a full clean build with yarn build-all (which uses both tsc and esbuild).
package.jsonincludesscriptsfor various esbuild commands: see hereesbuildhas a--global-name=xyzflag, to store the exports from the entry point in a global variable. See also the esbuild "Global name" docs.- Read more about the esbuild setup here.
- esbuild for the browser uses the IIFE (immediately-invoked function expression) format, which executes the bundled code on load (see also evanw/esbuild#29)
You can write Jest tests like this:
Run the tests with yarn test, no separate compile step is necessary.
- See also the Jest documentation.
- The tests can be automatically run in CI (GitHub Actions, GitLab CI):
.github/workflows/lint-and-test.yml,.gitlab-ci.yml - Take a look at other modern test runners such as ava, uvu and tape
You can auto-generate API documentation from the TyoeScript source files using TypeDoc. The generated documentation can be published to GitHub / GitLab pages through the CI.
Generate the documentation, using src/main.ts as entrypoint (configured in package.json):
yarn docsThe resulting HTML is saved in docs/.
You can publish the documentation through CI:
Reach out with feedback and ideas: