gill

gill sdk

javascript/typescript client library for interacting with the Solana blockchain

Overview

Welcome to the gill sdk, a JavaScript/TypeScript client library for interacting with the Solana blockchain. You can use it to build Solana apps in Node, web, React Native, or just about any other JavaScript environment.

Gill is built on top of the modern javascript libraries for Solana built by Anza called @solana/kit (formerly known as "web3.js v2"). By utilizing the same types and functions under the hood, gill is compatible with kit. See Replacing Kit with gill.

For a comparison of using gill vs @solana/kit, take a look at the gill vs @solana/kit comparison docs and the comparison examples.

Documentation

You can find the gill library docs here:

• gill docs site
• gill setup guide
• gill API references

Packages

The following packages are published from within this repo, collectively known as the "gill sdk":

Package	Description	Version	Source
gill	SDK for building on the Solana blockchain		Source
@gillsdk/react	React hooks library for the Solana blockchain		Source
@gillsdk/solana-pay	Modern Solana Pay protocol client library		Source

Development

Environment setup

1. Install NodeJS
2. Install pnpm

Clone and prepare this repo locally:

git clone https://github.com/gillsdk/gill.git
cd gill
pnpm install

Build

To build all the packages in parallel (via Turborepo):

pnpm build

Note: You must run the build command the first time manually before running the test commands detailed below.

To build a specific package, use the --filter flag:

pnpm build --filter=gill
pnpm build --filter=@gillsdk/react
# or multiple specific packages
pnpm build --filter=gill --filter=@gillsdk/react

Testing

All unit tests can be run at the same time (including rebuilding):

pnpm test

Note: You must run the build command the first time manually before running the test command.

Contributing

Contributions are welcome and loved! Please open an issue before working on specific code changes to ensure it is within scope and desire for this library.

See the CONTRIBUTING.md document for full details.

Seriously. Read (and follow) this document if you want to contribute.

Maintainers

See the MAINTAINERS.md document for full details.