Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hubbleprotocol/hubble-common
🛰 Hubble Protocol common npm packages
https://github.com/hubbleprotocol/hubble-common
crypto hubble hubble-sdk hubbleprotocol lending
Last synced: about 1 hour ago
JSON representation
🛰 Hubble Protocol common npm packages
- Host: GitHub
- URL: https://github.com/hubbleprotocol/hubble-common
- Owner: hubbleprotocol
- License: apache-2.0
- Created: 2022-02-10T12:31:56.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T14:09:46.000Z (3 months ago)
- Last Synced: 2025-01-01T03:12:28.565Z (7 days ago)
- Topics: crypto, hubble, hubble-sdk, hubbleprotocol, lending
- Language: TypeScript
- Homepage: https://hubbleprotocol.io
- Size: 11.7 MB
- Stars: 15
- Watchers: 11
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hubble Common 🛰
Hubble common NPM packages.
## Packages
| Package | Description | Docs | Version |
|---------------------------------|------------------------------------|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `@hubbleprotocol/hubble-config` | Hubble Solana config (public keys) | [README](./packages/hubble-config/README.md) | [](https://www.npmjs.com/package/@hubbleprotocol/hubble-config) |
| `@hubbleprotocol/hubble-sdk` | Hubble Protocol client SDK | [README](./packages/hubble-sdk/README.md) | [](https://www.npmjs.com/package/@hubbleprotocol/hubble-sdk) |
| `@hubbleprotocol/hubble-db` | Hubble Protocol database schema | [README](./packages/hubble-db/README.md) | [](https://www.npmjs.com/package/@hubbleprotocol/hubble-db) |
### Deprecated Packages
| Package | Description | Comments | Version |
|------------------------------|-------------|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| `@hubbleprotocol/kamino-sdk` | Kamino SDK | Moved to: `@kamino-finance/kliquidity-sdk` https://github.com/Kamino-Finance/kliquidity-sdk | [](https://www.npmjs.com/package/@hubbleprotocol/kamino-sdk) |
| `@hubbleprotocol/scope-sdk` | Scope SDK | Moved to: `@kamino-finance/scope-sdk` https://github.com/Kamino-Finance/scope-sdk | [](https://www.npmjs.com/package/@kamino=finance/scope-sdk) |
## Deployment
[](https://lerna.js.org/)
We use [lernajs](https://lerna.js.org/) 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](./.github/workflows/release_packages.yml). 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](https://github.com/hubbleprotocol/hubble-common/actions/workflows/release_packages.yml)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
- `git clone [email protected]: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](https://choosealicense.com/licenses/apache-2.0/)
## Installing hubble common
```shell
npm install
npm run bootstrap
```
## Testing hubble common packages
```shell
npm run test
```