@hawksightco/hawk-sdk 0.0.8 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
1
|
# Hawksight SDK
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The Hawksight SDK is designed to facilitate interaction with the HawkSight blockchain API, enabling developers to easily manage transactions, query system health, and access general and utility endpoints for various blockchain operations. This library is particularly useful for working with decentralized finance (DeFi) applications on the Solana blockchain, including features for both Meteora DLMM and Orca CLMM systems.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Health Checks**: Monitor and verify the status of the HawkSight API.
|
|
8
|
+
- **General Utilities**: Manage and retrieve portfolio information, pool data, and token details.
|
|
9
|
+
- **Transaction Generation**: Create and manage transactions for different DeFi protocols.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
To install the Hawksight SDK, you need to have Node.js and npm installed on your machine. Then, you can add it to your project with the following command:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @hawksightco/hawk-sdk
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
OR
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
yarn add @hawksightco/hawk-sdk
|
|
23
|
+
```
|