🚨 GitBross is launching the **Open Source Backup Campaign** for #Solana and beyond 🚨

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.

244 提交歷史

3 Branches

0 版本發佈

github-actions[bot] 8c953c4298 Version Packages (#218)		1 月之前
.changeset	8c953c4298 Version Packages (#218)	1 月之前
.github	70a14b5582 improved readme and contributing (#269)	1 月之前
.vscode	4f69014f18 [react] esm and relative imports (#271)	2 月之前
docs	ec362e2ae9 docs: improve React section documentation (#211)	2 月之前
e2e	9c22897112 "token" import paths (#264)	2 月之前
examples	b94c6f4cf0 add version detection and tests (#257)	1 月之前
idls	825d808794 use codama cli to generate clients (#137)	5 月之前
packages	8c953c4298 Version Packages (#218)	1 月之前
.bundlemonrc.json	5dd8900ad6 ci: bundlemon (#31)	9 月之前
.gitignore	4a249196e4 feat: fathom (#185)	4 月之前
.prettierignore	ff37d8d2cb [chore] prettier style check and fix (#226)	2 月之前
.prettierrc	a320da828d use kit under the hood (#68)	8 月之前
CONTRIBUTING.md	70a14b5582 improved readme and contributing (#269)	1 月之前
LICENSE	45c4380416 chore: MIT license	9 月之前
MAINTAINERS.md	0ea6b83271 docs: maintainers (#266)	2 月之前
README.md	a0b1405c1a assorted tweaks (#309)	1 月之前
eslint.config.mjs	e4258af144 feat: added test runners	1 年之前
package.json	a0b1405c1a assorted tweaks (#309)	1 月之前
pnpm-lock.yaml	91a3ac24d2 feat: add basic wallet hooks (#270)	1 月之前
pnpm-workspace.yaml	0be650e92c Refactor reexports (#143)	5 月之前
turbo.json	ff37d8d2cb [chore] prettier style check and fix (#226)	2 月之前
typedoc.json	9e4bc55431 [docs] api reference (#132)	5 月之前
typedoc.plugin.mjs	9e4bc55431 [docs] api reference (#132)	5 月之前

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:

Packages

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

Package	Description	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

Install NodeJS
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.

README.md