@huma-finance/permissionless-sdk 1.0.3-beta.20250904195059.ae633b4 → 1.0.3
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/package.json +2 -3
- package/README.md +0 -39
package/package.json
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@huma-finance/permissionless-sdk",
|
|
3
|
-
"version": "1.0.3
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Huma Finance Permissionless SDK for Solana",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"files": [
|
|
8
|
-
"dist/**/*"
|
|
9
|
-
"README.md"
|
|
8
|
+
"dist/**/*"
|
|
10
9
|
],
|
|
11
10
|
"publishConfig": {
|
|
12
11
|
"access": "public"
|
package/README.md
DELETED
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# Huma Permissionless SDK
|
|
2
|
-
|
|
3
|
-
This is an [NPM Package](https://www.npmjs.com/package/@huma-finance/permissionless-sdk) that helps build deposit instructions for the various modes + lockups on Huma 2.0 (Permissionless).
|
|
4
|
-
|
|
5
|
-
## Current supported features
|
|
6
|
-
|
|
7
|
-
- Deposit into classic or maxi mode (PST and mPST respectively)
|
|
8
|
-
- Optionally specify a lockup on these tokens, in most cases you'll want to use the default NO_COMMIT option.
|
|
9
|
-
|
|
10
|
-
## Depositing
|
|
11
|
-
|
|
12
|
-
An example Node script integration in /examples/deposit.ts is provided in this repo. For those integrating with react, an example repo using vite and @solana/web3.js is available at https://github.com/00labs/permissionless-sdk-example.
|
|
13
|
-
|
|
14
|
-
1. Create a `PermissionlessClient`
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
import {
|
|
18
|
-
PermissionlessClient,
|
|
19
|
-
SolanaChainEnum,
|
|
20
|
-
} from "@huma-finance/permissionless-sdk";
|
|
21
|
-
|
|
22
|
-
new PermissionlessClient(connection, SolanaChainEnum.MAINNET);
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
2. Build a deposit instruction for either PST (DepositMode.CLASSIC) or mPST (DepositMode.MAXI) (note that token amounts should be denoted in smallest units)
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
import {
|
|
29
|
-
DepositMode
|
|
30
|
-
} from "@huma-finance/permissionless-sdk";
|
|
31
|
-
|
|
32
|
-
const tx = await client.buildDepositTx(
|
|
33
|
-
publicKey,
|
|
34
|
-
new BN(1000000), /* Deposit 1 USDC */
|
|
35
|
-
DepositMode.CLASSIC /* Will receive PST */
|
|
36
|
-
);
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
3. The deposit transaction is intended to only handle the instructions for depositing and creating relevant Huma accounts. It should be up to the implementation to optimize the transaction with the correct blockhashes, compute unit limits, priority fees, etc.
|