@bagsfm/bags-sdk 1.3.5 → 1.3.6
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 +88 -10
- package/dist/utils/helpers.d.ts.map +1 -1
- package/dist/utils/helpers.js +0 -1
- package/dist/utils/helpers.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
A TypeScript SDK for interacting with the Bags Public API - Solana token launch and management platform.
|
|
10
10
|
|
|
11
|
+
For detailed API documentation, guides, and examples, visit [docs.bags.fm](https://docs.bags.fm/).
|
|
12
|
+
|
|
11
13
|
## Installation
|
|
12
14
|
|
|
13
15
|
```bash
|
|
@@ -24,34 +26,92 @@ import { Connection, PublicKey } from '@solana/web3.js';
|
|
|
24
26
|
const connection = new Connection('https://mainnet.helius-rpc.com/?api-key=your-helius-api-key'); // Or any other RPC provider
|
|
25
27
|
const sdk = new BagsSDK('your-bags-api-key', connection, 'processed');
|
|
26
28
|
|
|
27
|
-
//
|
|
29
|
+
// Query token creators
|
|
28
30
|
const tokenMint = new PublicKey('your-token-mint-address');
|
|
29
31
|
const creators = await sdk.state.getTokenCreators(tokenMint);
|
|
30
32
|
console.log('Token creators:', creators);
|
|
33
|
+
|
|
34
|
+
// Get a swap quote
|
|
35
|
+
const quote = await sdk.trade.getQuote({
|
|
36
|
+
inputMint: 'So11111111111111111111111111111111111111112',
|
|
37
|
+
outputMint: 'your-token-mint-address',
|
|
38
|
+
amount: 1_000_000_000, // 1 SOL in lamports
|
|
39
|
+
slippageMode: 'dynamic',
|
|
40
|
+
});
|
|
41
|
+
console.log('Swap quote:', quote);
|
|
42
|
+
|
|
43
|
+
// Claim fees
|
|
44
|
+
const claimable = await sdk.fee.getAllClaimablePositions(walletPublicKey);
|
|
45
|
+
console.log('Claimable positions:', claimable);
|
|
31
46
|
```
|
|
32
47
|
|
|
33
48
|
## API Reference
|
|
34
49
|
|
|
35
50
|
### BagsSDK
|
|
36
51
|
|
|
37
|
-
The main SDK class that provides access to all services
|
|
38
|
-
|
|
39
|
-
- `bagsApiClient`: HTTP API client for Bags services
|
|
40
|
-
- `tokenLaunch`: Token launch management service
|
|
41
|
-
- `state`: State management service
|
|
42
|
-
- `config`: Configuration service
|
|
43
|
-
- `fee`: Fee management service
|
|
52
|
+
The main SDK class that provides access to all services.
|
|
44
53
|
|
|
45
|
-
|
|
54
|
+
#### Constructor
|
|
46
55
|
|
|
47
56
|
```typescript
|
|
48
57
|
new BagsSDK(apiKey: string, connection: Connection, commitment?: Commitment)
|
|
49
58
|
```
|
|
50
59
|
|
|
51
60
|
**Parameters:**
|
|
61
|
+
|
|
52
62
|
- `apiKey`: Your Bags API key
|
|
53
63
|
- `connection`: Solana web3.js Connection instance
|
|
54
|
-
- `commitment`: (optional) Transaction commitment level (default: 'processed')
|
|
64
|
+
- `commitment`: (optional) Transaction commitment level (default: `'processed'`)
|
|
65
|
+
|
|
66
|
+
### Services
|
|
67
|
+
|
|
68
|
+
| Service | Property | Description |
|
|
69
|
+
|---------|----------|-------------|
|
|
70
|
+
| **API Client** | `sdk.bagsApiClient` | Low-level HTTP client for direct Bags API calls |
|
|
71
|
+
| **Token Launch** | `sdk.tokenLaunch` | Create token launches and upload token metadata |
|
|
72
|
+
| **State** | `sdk.state` | Query token creators, lifetime fees, leaderboards, launch wallets, and claim stats |
|
|
73
|
+
| **Config** | `sdk.config` | Create and manage fee-share configurations and lookup tables |
|
|
74
|
+
| **Fees** | `sdk.fee` | List claimable fee positions and build claim transactions |
|
|
75
|
+
| **Partner** | `sdk.partner` | Read/create partner configs and claim partner fees |
|
|
76
|
+
| **Trade** | `sdk.trade` | Get swap quotes and build swap transactions |
|
|
77
|
+
| **Solana** | `sdk.solana` | Submit Jito bundles, check bundle statuses, and query Jito tip fees |
|
|
78
|
+
| **Fee Share Admin** | `sdk.feeShareAdmin` | Transfer admin roles, list admin mints, and update fee-share configs |
|
|
79
|
+
| **Dexscreener** | `sdk.dexscreener` | Check order availability, create orders, and submit payments for Dexscreener listings |
|
|
80
|
+
| **Incorporation** | `sdk.incorporation` | Start payments, register incorporation details, and manage incorporation projects |
|
|
81
|
+
|
|
82
|
+
### Exported Utilities
|
|
83
|
+
|
|
84
|
+
The SDK also exports helper functions and types you can import directly:
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import {
|
|
88
|
+
sleep,
|
|
89
|
+
chunkArray,
|
|
90
|
+
signAndSendTransaction,
|
|
91
|
+
sendBundleAndConfirm,
|
|
92
|
+
createTipTransaction,
|
|
93
|
+
serializeVersionedTransaction,
|
|
94
|
+
prepareImageForFormData,
|
|
95
|
+
detectImageInputType,
|
|
96
|
+
sortKeys,
|
|
97
|
+
} from '@bagsfm/bags-sdk';
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Exported Constants
|
|
101
|
+
|
|
102
|
+
Common program IDs and addresses are available as named exports:
|
|
103
|
+
|
|
104
|
+
```typescript
|
|
105
|
+
import {
|
|
106
|
+
BAGS_FEE_SHARE_V1_PROGRAM_ID,
|
|
107
|
+
BAGS_FEE_SHARE_V2_PROGRAM_ID,
|
|
108
|
+
METEORA_DBC_PROGRAM_ID,
|
|
109
|
+
METEORA_DAMM_V2_PROGRAM_ID,
|
|
110
|
+
BAGS_GLOBAL_LUT,
|
|
111
|
+
WRAPPED_SOL_MINT,
|
|
112
|
+
JITO_TIP_ACCOUNTS,
|
|
113
|
+
} from '@bagsfm/bags-sdk';
|
|
114
|
+
```
|
|
55
115
|
|
|
56
116
|
## Requirements
|
|
57
117
|
|
|
@@ -71,6 +131,24 @@ npm run build
|
|
|
71
131
|
# Watch mode for development
|
|
72
132
|
npm run dev
|
|
73
133
|
|
|
134
|
+
# Run tests
|
|
135
|
+
npm test
|
|
136
|
+
|
|
137
|
+
# Run tests in watch mode
|
|
138
|
+
npm run test:watch
|
|
139
|
+
|
|
140
|
+
# Lint source files
|
|
141
|
+
npm run lint
|
|
142
|
+
|
|
143
|
+
# Lint and auto-fix
|
|
144
|
+
npm run lint:fix
|
|
145
|
+
|
|
146
|
+
# Format source files
|
|
147
|
+
npm run format
|
|
148
|
+
|
|
149
|
+
# Check formatting
|
|
150
|
+
npm run format:check
|
|
151
|
+
|
|
74
152
|
# Clean build artifacts
|
|
75
153
|
npm run clean
|
|
76
154
|
```
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAqC,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAGtK,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAM5E;AAQD,wBAAsB,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,GAAE,MAAU,EAAE,cAAc,GAAE,MAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAsB7J;AAED,wBAAsB,sBAAsB,CAC3C,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,oBAAoB,EACjC,OAAO,EAAE,OAAO,EAChB,SAAS,CAAC,EAAE,8BAA8B,GACxC,OAAO,CAAC,MAAM,CAAC,
|
|
1
|
+
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAqC,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAGtK,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAM5E;AAQD,wBAAsB,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,GAAE,MAAU,EAAE,cAAc,GAAE,MAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAsB7J;AAED,wBAAsB,sBAAsB,CAC3C,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,oBAAoB,EACjC,OAAO,EAAE,OAAO,EAChB,SAAS,CAAC,EAAE,8BAA8B,GACxC,OAAO,CAAC,MAAM,CAAC,CA8BjB;AAQD,wBAAgB,6BAA6B,CAAC,WAAW,EAAE,oBAAoB,GAAG,MAAM,GAAG,MAAM,CAahG;AAYD,wBAAsB,oBAAoB,CACzC,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,SAAS,EAChB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE;IACR,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACd,GACJ,OAAO,CAAC,oBAAoB,CAAC,CA2B/B;AASD,wBAAsB,oBAAoB,CAAC,kBAAkB,EAAE,oBAAoB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAE,UAAsB,GAAG,OAAO,CAAC,MAAM,CAAC,CAiCpJ"}
|
package/dist/utils/helpers.js
CHANGED
|
@@ -61,7 +61,6 @@ async function signAndSendTransaction(connection, commitment, transaction, keypa
|
|
|
61
61
|
if (confirmed.value.err) {
|
|
62
62
|
throw new Error(`Transaction failed: ${confirmed.value.err}`);
|
|
63
63
|
}
|
|
64
|
-
console.log('✅ Transaction confirmed:', signature);
|
|
65
64
|
return signature;
|
|
66
65
|
}
|
|
67
66
|
function serializeVersionedTransaction(transaction) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":";;;;;AAMA,sBAEC;AAED,gCAMC;AAQD,gDAsBC;AAED,
|
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/utils/helpers.ts"],"names":[],"mappings":";;;;;AAMA,sBAEC;AAED,gCAMC;AAQD,gDAsBC;AAED,wDAoCC;AAQD,sEAaC;AAYD,oDAoCC;AASD,oDAiCC;AAnMD,6CAAsK;AACtK,gDAAwB;AACxB,4CAAiD;AAIjD,SAAgB,KAAK,CAAC,EAAU;IAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAgB,UAAU,CAAI,KAAe,EAAE,IAAY;IAC1D,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAQM,KAAK,UAAU,kBAAkB,CAAC,UAAsB,EAAE,UAAsB,EAAE,cAAsB,CAAC,EAAE,iBAAyB,GAAG;IAC7I,IAAI,CAAC;QAEJ,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACzD,MAAM,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;QAG7C,OAAO,IAAI,EAAE,CAAC;YACb,MAAM,WAAW,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAEzD,IAAI,WAAW,IAAI,UAAU,EAAE,CAAC;gBAC/B,MAAM;YACP,CAAC;YAED,MAAM,KAAK,CAAC,cAAc,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,KAAK,CAAC,CAAC;QAGzD,MAAM,KAAK,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC;IAChC,CAAC;AACF,CAAC;AAEM,KAAK,UAAU,sBAAsB,CAC3C,UAAsB,EACtB,UAAsB,EACtB,WAAiC,EACjC,OAAgB,EAChB,SAA0C;IAE1C,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAE5B,IAAI,cAAc,GAAG,SAAS,CAAC;IAE/B,IAAI,CAAC,SAAS,EAAE,CAAC;QAChB,cAAc,GAAG,MAAM,UAAU,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC;SAAM,CAAC;QACP,cAAc,GAAG,SAAS,CAAC;IAC5B,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,eAAe,CAAC,WAAW,EAAE;QAC/D,aAAa,EAAE,IAAI;QACnB,UAAU,EAAE,CAAC;KACb,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,kBAAkB,CACpD;QACC,SAAS,EAAE,cAAc,CAAC,SAAS;QACnC,oBAAoB,EAAE,cAAc,CAAC,oBAAoB;QACzD,SAAS,EAAE,SAAS;KACpB,EACD,UAAU,CACV,CAAC;IAEF,IAAI,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,uBAAuB,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAQD,SAAgB,6BAA6B,CAAC,WAA0C;IACvF,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAErC,IAAI,CAAC,cAAI,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,WAAW,CAAC;IACpB,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,EAAE,CAAC;IAE3C,OAAO,cAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAChC,CAAC;AAYM,KAAK,UAAU,oBAAoB,CACzC,UAAsB,EACtB,UAAsB,EACtB,KAAgB,EAChB,WAAmB,EACnB,UAGI,EAAE;IAEN,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,oBAAoB,GAAG,6BAAiB,CAAC;IAC/C,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvH,IAAI,CAAC,UAAU,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,eAAe,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,MAAM,UAAU,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;IAEzG,MAAM,cAAc,GAAG,uBAAa,CAAC,QAAQ,CAAC;QAC7C,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,UAAU;QACpB,QAAQ,EAAE,WAAW;KACrB,CAAC,CAAC;IAEH,MAAM,kBAAkB,GAAG,IAAI,4BAAkB,CAAC;QACjD,QAAQ,EAAE,KAAK;QACf,eAAe;QACf,YAAY,EAAE,CAAC,cAAc,CAAC;KAC9B,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAExB,OAAO,IAAI,8BAAoB,CAAC,kBAAkB,CAAC,CAAC;AACrD,CAAC;AASM,KAAK,UAAU,oBAAoB,CAAC,kBAA0C,EAAE,GAAY,EAAE,SAAqB,SAAS;IAClI,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IAEzE,MAAM,UAAU,GAAG,EAAE,CAAC;IACtB,MAAM,YAAY,GAAG,GAAG,CAAC;IAEzB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACxD,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QAE9E,IAAI,cAAc,EAAE,KAAK,EAAE,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YACtE,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,EAAE,mBAAmB,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,YAAY,CAAC;YAEhE,IAAI,mBAAmB,KAAK,WAAW,IAAI,mBAAmB,KAAK,WAAW,EAAE,CAAC;gBAEhF,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC;gBAEhD,IAAI,CAAC,SAAS,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;gBAC1D,CAAC;gBAED,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBAC/D,CAAC;gBAED,OAAO,QAAQ,CAAC;YACjB,CAAC;QACF,CAAC;QAED,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,uCAAuC,UAAU,WAAW,CAAC,CAAC;AAC/E,CAAC"}
|