@unclaimedsol/spl-burn-close-sdk 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +26 -8
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -14,16 +14,27 @@ This library only **builds unsigned transactions** – you handle signing and se
14
14
 
15
15
  ---
16
16
 
17
+ ## 🧩 How It Works
18
+
19
+ 1. The SDK prepares TransactionInstructions for your on-chain burn+close program.
20
+ 2. Program burns tokens in each ATA, then closes it, sending rent back to the owner.
21
+ 3. A 5% fee is enforced on-chain and sent to the hardcoded recipient.
22
+ 4. The SDK never asks for private keys — you sign & send transactions yourself.
23
+
24
+ ---
25
+
17
26
  ## 📦 Installation
18
27
 
19
28
  ```bash
20
- npm i @unclaimedsol/spl-burn-close-sdk @solana/web3.js
29
+ npm i @unclaimedsol/spl-burn-close-sdk
21
30
  ```
22
31
 
23
- We use peerDependencies to avoid version conflicts.
32
+ We use @solana/web3.js in peerDependencies to avoid version conflicts. So, make sure you already have it installed.
24
33
 
25
34
  Requires Node 18+.
26
35
 
36
+ ---
37
+
27
38
  ## 🔑 Usage
28
39
 
29
40
  ### Signing with Keypair
@@ -109,13 +120,20 @@ for (const stx of signed) {
109
120
  }
110
121
  ```
111
122
 
112
- ## 🧩 How It Works
123
+ ---
113
124
 
114
- 1. The SDK prepares TransactionInstructions for your on-chain burn+close program.
115
- 2. Program burns tokens in each ATA, then closes it, sending rent back to the owner.
116
- 3. A 5% fee is enforced on-chain and sent to the hardcoded recipient.
117
- 4. The SDK never asks for private keys — you sign & send transactions yourself.
125
+ ## 💻 Demo
126
+
127
+ There is a nice tutorial guide with a demo repository that shows the usage of the SDK to burn and close all token accounts for the wallet. You can find it [here](https://cryptolover12.medium.com/how-to-close-and-burn-token-accounts-on-solana-simple-way-in-web3-js-2ede68f3fcd7).
128
+
129
+ ---
130
+
131
+ ## 📜 Disclaimer
132
+
133
+ This SDK only **builds transactions** to burn tokens and close accounts. You are solely responsible for signing and sending them. We are not liable for any loss of funds.
134
+
135
+ ---
118
136
 
119
- ## 📜 License
137
+ ## 📃 License
120
138
 
121
139
  MIT © [Unclaimed SOL](https://unclaimedsol.com)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@unclaimedsol/spl-burn-close-sdk",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "SDK to burn and close SPL token accounts via the Unclaimed SOL program (with a built-in 5% fee).",
5
5
  "license": "MIT",
6
6
  "author": "Unclaimed SOL",
@@ -46,6 +46,7 @@
46
46
  "sdk",
47
47
  "token-account",
48
48
  "close-account",
49
- "burn"
49
+ "burn",
50
+ "close"
50
51
  ]
51
52
  }