@sinai-standard/types 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,46 @@
+# @sinai-standard/types
+
+Shared TypeScript types, program IDs, and PDA seeds for the Sinai Standard protocol.
+
+## Install
+
+```bash
+npm install @sinai-standard/types
+```
+
+## Usage
+
+```ts
+import { PROGRAM_IDS, SEEDS } from "@sinai-standard/types";
+import type { TokenCreateParams, RouterConfigData } from "@sinai-standard/types";
+```
+
+## Exports
+
+### Constants
+
+- `PROGRAM_IDS` — Deployed program addresses (allowlist, tax, hold, router, token factory, max balance)
+- `SEEDS` — PDA seed buffers for all account derivations
+
+### Types
+
+| Type | Description |
+|------|-------------|
+| `TokenCreateParams` | Parameters for `AksumKit.createToken()` |
+| `AllowlistRegistryData` | On-chain allowlist account state |
+| `TaxConfigData` | Tax hook configuration account |
+| `HoldConfigData` | Hold period configuration account |
+| `WalletLockData` | Per-wallet lock state |
+| `RouterConfigData` | Router hook with sub-hook program references |
+| `MaxBalanceConfigData` | Max balance per wallet configuration |
+| `TokenRecordData` | Token factory record |
+| `ConfidentialTransferConfig` | Confidential transfer extension config |
+| `AllowlistMode` | `"allowlist" \| "denylist"` |
+
+## Network
+
+All program IDs target Solana devnet. See [sinaistandard.org](https://sinaistandard.org) for details.
+
+## License
+
+ISC

package/dist/index.d.ts

@@ -7,6 +7,12 @@ export declare const PROGRAM_IDS: {
     readonly routerHook: PublicKey;
     readonly tokenFactory: PublicKey;
     readonly maxBalanceHook: PublicKey;
+    readonly protocolFee: PublicKey;
+    readonly distribution: PublicKey;
+    readonly capTable: PublicKey;
+    readonly vesting: PublicKey;
+    readonly forcedTransfer: PublicKey;
+    readonly redemption: PublicKey;
 };
 export declare const SEEDS: {
     readonly allowlist: Buffer<ArrayBuffer>;
@@ -19,6 +25,22 @@ export declare const SEEDS: {
     readonly maxBalanceConfig: Buffer<ArrayBuffer>;
     readonly tokenRecord: Buffer<ArrayBuffer>;
     readonly freezeAuthority: Buffer<ArrayBuffer>;
+    readonly protocolFeeConfig: Buffer<ArrayBuffer>;
+    readonly distribution: Buffer<ArrayBuffer>;
+    readonly claimStatus: Buffer<ArrayBuffer>;
+    readonly distributionTracker: Buffer<ArrayBuffer>;
+    readonly distributionEscrow: Buffer<ArrayBuffer>;
+    readonly capTableConfig: Buffer<ArrayBuffer>;
+    readonly holder: Buffer<ArrayBuffer>;
+    readonly vesting: Buffer<ArrayBuffer>;
+    readonly vestingTracker: Buffer<ArrayBuffer>;
+    readonly vestingEscrow: Buffer<ArrayBuffer>;
+    readonly forcedTransferConfig: Buffer<ArrayBuffer>;
+    readonly ftRecord: Buffer<ArrayBuffer>;
+    readonly redemptionPool: Buffer<ArrayBuffer>;
+    readonly redemptionRecord: Buffer<ArrayBuffer>;
+    readonly redemptionTracker: Buffer<ArrayBuffer>;
+    readonly redemptionEscrow: Buffer<ArrayBuffer>;
 };
 export interface TokenCreateParams {
     name: string;
@@ -39,6 +61,12 @@ export interface TokenCreateParams {
             seconds: number;
         };
     };
+    protocolFee?: {
+        feeBps: number;
+        maxFee: number | bigint;
+        treasury: PublicKey;
+    };
+    capTable?: boolean;
 }
 export interface AllowlistRegistryData {
     authority: PublicKey;
@@ -101,3 +129,125 @@ export interface ConfidentialTransferConfig {
     autoApproveNewAccounts: boolean;
     auditorElGamalPubkey?: Uint8Array;
 }
+export interface ProtocolFeeConfigData {
+    authority: PublicKey;
+    mint: PublicKey;
+    treasury: PublicKey;
+    feeBps: number;
+    maxFee: bigint;
+    isActive: boolean;
+    totalCollected: bigint;
+}
+export interface DistributionTrackerData {
+    authority: PublicKey;
+    mint: PublicKey;
+    nextDistributionId: bigint;
+    totalDistributed: bigint;
+}
+export interface DistributionData {
+    authority: PublicKey;
+    mint: PublicKey;
+    paymentMint: PublicKey;
+    distributionId: bigint;
+    merkleRoot: number[];
+    totalAmount: bigint;
+    claimedAmount: bigint;
+    recordDate: bigint;
+    createdAt: bigint;
+    escrow: PublicKey;
+    numHolders: number;
+    isFinalized: boolean;
+    isActive: boolean;
+}
+export interface ClaimStatusData {
+    isClaimed: boolean;
+    claimedAmount: bigint;
+    claimedAt: bigint;
+}
+export interface CapTableConfigData {
+    authority: PublicKey;
+    mint: PublicKey;
+    totalHolders: number;
+    isActive: boolean;
+}
+export interface HolderRecordData {
+    holder: PublicKey;
+    mint: PublicKey;
+    balance: bigint;
+    firstAcquired: bigint;
+    lastTransfer: bigint;
+    transferCount: number;
+    isActive: boolean;
+}
+export interface VestingTrackerData {
+    authority: PublicKey;
+    mint: PublicKey;
+    nextScheduleId: bigint;
+    totalVestingAmount: bigint;
+    totalReleased: bigint;
+}
+export interface VestingScheduleData {
+    authority: PublicKey;
+    beneficiary: PublicKey;
+    mint: PublicKey;
+    escrow: PublicKey;
+    totalAmount: bigint;
+    releasedAmount: bigint;
+    startTs: bigint;
+    cliffTs: bigint;
+    endTs: bigint;
+    cliffAmount: bigint;
+    intervalSeconds: bigint;
+    revocable: boolean;
+    isActive: boolean;
+    scheduleId: bigint;
+}
+export interface ForcedTransferConfigData {
+    authority: PublicKey;
+    mint: PublicKey;
+    complianceOfficer: PublicKey;
+    thresholdAmount: bigint;
+    isActive: boolean;
+    totalForcedTransfers: bigint;
+    totalForcedAmount: bigint;
+}
+export interface ForcedTransferRecordData {
+    mint: PublicKey;
+    recordId: bigint;
+    fromWallet: PublicKey;
+    toWallet: PublicKey;
+    amount: bigint;
+    reason: string;
+    executedBy: PublicKey;
+    executedAt: bigint;
+    referenceId: string;
+}
+export interface RedemptionTrackerData {
+    authority: PublicKey;
+    mint: PublicKey;
+    nextPoolId: bigint;
+    totalPoolsCreated: number;
+}
+export interface RedemptionPoolData {
+    authority: PublicKey;
+    mint: PublicKey;
+    paymentMint: PublicKey;
+    poolId: bigint;
+    pricePerToken: bigint;
+    tokenDecimals: number;
+    paymentDecimals: number;
+    escrow: PublicKey;
+    totalDeposited: bigint;
+    totalRedeemedTokens: bigint;
+    totalPaidOut: bigint;
+    startTs: bigint;
+    endTs: bigint;
+    maxRedemptionPerWallet: bigint;
+    isActive: boolean;
+}
+export interface RedemptionRecordData {
+    redeemer: PublicKey;
+    tokensRedeemed: bigint;
+    paymentReceived: bigint;
+    redeemedAt: bigint;
+}

package/dist/index.js

@@ -12,6 +12,12 @@ exports.PROGRAM_IDS = {
     routerHook: new web3_js_1.PublicKey("HHnt7Hfnp2fDftFNCFPqEhebgXGizuqubXqhiEi8C1of"),
     tokenFactory: new web3_js_1.PublicKey("VXQL8u4NVUYG1zaejujwh5gr21iinmk4yYCXn1g9TXr"),
     maxBalanceHook: new web3_js_1.PublicKey("Ctx9ZtNzPFYyjqxdZSMYLgHdqNNpAS61G6ok1dYVBHWi"),
+    protocolFee: new web3_js_1.PublicKey("DFhGwMiWdAqZW1Pfr8hrnrSKuH91qzw9jkXm3aFUYSSi"),
+    distribution: new web3_js_1.PublicKey("968Gd9K5siYBqHVw7BYWPaMKxGfiaaaUbYrAWYJnYkFN"),
+    capTable: new web3_js_1.PublicKey("FAJyBPALnKamLHkiJWEM7GTGK1LSixvphjo3zPfXeTGh"),
+    vesting: new web3_js_1.PublicKey("2YuPxPyBVoYNda8ZEfWcW61A7BDpaL9ce9Y1M4fJwgb5"),
+    forcedTransfer: new web3_js_1.PublicKey("3RTBG7htQkP888AsvZTygbkp85xBHfXQHo2u32bsFfm3"),
+    redemption: new web3_js_1.PublicKey("HQF1SnVs6n3MjcHdqZ52qQB5WLEDiVR2XxMMUFhbQ6Ju"),
 };
 // ============================================================================
 // PDA Seeds
@@ -27,4 +33,26 @@ exports.SEEDS = {
     maxBalanceConfig: Buffer.from("max-balance-config"),
     tokenRecord: Buffer.from("token-record"),
     freezeAuthority: Buffer.from("freeze-authority"),
+    // Protocol Fee
+    protocolFeeConfig: Buffer.from("protocol-fee-config"),
+    // Distribution
+    distribution: Buffer.from("distribution"),
+    claimStatus: Buffer.from("claim-status"),
+    distributionTracker: Buffer.from("distribution-tracker"),
+    distributionEscrow: Buffer.from("escrow"),
+    // Cap Table
+    capTableConfig: Buffer.from("cap-table-config"),
+    holder: Buffer.from("holder"),
+    // Vesting
+    vesting: Buffer.from("vesting"),
+    vestingTracker: Buffer.from("vesting-tracker"),
+    vestingEscrow: Buffer.from("vesting-escrow"),
+    // Forced Transfer
+    forcedTransferConfig: Buffer.from("forced-transfer-config"),
+    ftRecord: Buffer.from("ft-record"),
+    // Redemption
+    redemptionPool: Buffer.from("redemption-pool"),
+    redemptionRecord: Buffer.from("redemption-record"),
+    redemptionTracker: Buffer.from("redemption-tracker"),
+    redemptionEscrow: Buffer.from("redemption-escrow"),
 };

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@sinai-standard/types",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Sinai Standard shared TypeScript types",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "license": "ISC",
   "scripts": {
     "build": "tsc"