@sinai-standard/types 0.1.0 → 0.1.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.
- package/README.md +46 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @sinai-standard/types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types, program IDs, and PDA seeds for the Sinai Standard protocol.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @sinai-standard/types
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { PROGRAM_IDS, SEEDS } from "@sinai-standard/types";
|
|
15
|
+
import type { TokenCreateParams, RouterConfigData } from "@sinai-standard/types";
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Exports
|
|
19
|
+
|
|
20
|
+
### Constants
|
|
21
|
+
|
|
22
|
+
- `PROGRAM_IDS` — Deployed program addresses (allowlist, tax, hold, router, token factory, max balance)
|
|
23
|
+
- `SEEDS` — PDA seed buffers for all account derivations
|
|
24
|
+
|
|
25
|
+
### Types
|
|
26
|
+
|
|
27
|
+
| Type | Description |
|
|
28
|
+
|------|-------------|
|
|
29
|
+
| `TokenCreateParams` | Parameters for `AksumKit.createToken()` |
|
|
30
|
+
| `AllowlistRegistryData` | On-chain allowlist account state |
|
|
31
|
+
| `TaxConfigData` | Tax hook configuration account |
|
|
32
|
+
| `HoldConfigData` | Hold period configuration account |
|
|
33
|
+
| `WalletLockData` | Per-wallet lock state |
|
|
34
|
+
| `RouterConfigData` | Router hook with sub-hook program references |
|
|
35
|
+
| `MaxBalanceConfigData` | Max balance per wallet configuration |
|
|
36
|
+
| `TokenRecordData` | Token factory record |
|
|
37
|
+
| `ConfidentialTransferConfig` | Confidential transfer extension config |
|
|
38
|
+
| `AllowlistMode` | `"allowlist" \| "denylist"` |
|
|
39
|
+
|
|
40
|
+
## Network
|
|
41
|
+
|
|
42
|
+
All program IDs target Solana devnet. See [sinaistandard.org](https://sinaistandard.org) for details.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
ISC
|