Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 3.84 KB

README.md

File metadata and controls

61 lines (40 loc) · 3.84 KB
Raw

Hubble Common 🛰

Hubble common NPM packages.

Packages

Release packages

Package Description Docs Version
@hubbleprotocol/hubble-config Hubble Solana config (public keys) README npm
@hubbleprotocol/hubble-sdk Hubble Protocol client SDK README npm
@hubbleprotocol/hubble-db Hubble Protocol database schema README npm

Deprecated Packages

Package Description Comments Version
@hubbleprotocol/kamino-sdk Kamino SDK Moved to: @kamino-finance/kliquidity-sdk https://github.com/Kamino-Finance/kliquidity-sdk npm
@hubbleprotocol/scope-sdk Scope SDK Moved to: @kamino-finance/scope-sdk https://github.com/Kamino-Finance/scope-sdk npm

Deployment

lerna

We use lernajs for monorepo package management and publishing. Versioning and publishing is done automatically (detects changes if any) by Lerna.

Currently, deployment is done manually by using a GitHub Action called Release NPM packages. You can only deploy from the master branch and can either specify a specific new version number or increase it by specifying patch (default), minor or major to the action input. You may run the action from here

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

  • git clone git@github.com:hubbleprotocol/hubble-common.git
  • cd hubble-common/
  • npm install
  • Put in your RPC (see below)

Create a free mainnet RPC:

  • go to https://www.hellomoon.io/dashboard
  • get a mainnet rpc
  • paste it where it says const clusterUrl: string = 'https://api.mainnet-beta.solana.com';

License

Apache 2.0

Installing hubble common

npm install
npm run bootstrap

Testing hubble common packages

npm run test