@d9-network/spec 0.1.1 → 0.2.0

package/README.md

@@ -0,0 +1,89 @@
+# @d9-network/spec
+
+TypeScript SDK for D9 blockchain interactions, wallet cryptography, and chain specifications.
+
+## Installation
+
+```bash
+npm install @d9-network/spec
+# or
+bun add @d9-network/spec
+# or
+pnpm add @d9-network/spec
+```
+
+## Quick Start
+
+```typescript
+import { createD9SdkClient, generateMnemonic, createSR25519Wallet } from "@d9-network/spec";
+
+// Create SDK client
+const d9 = createD9SdkClient({
+  endpoint: "wss://mainnet.d9network.xyz:40300",
+});
+
+// Generate a new wallet
+const mnemonic = generateMnemonic();
+const wallet = createSR25519Wallet(mnemonic);
+console.log("Address:", wallet.address);
+
+// Query USDT balance
+const result = await d9.contracts.usdt.query("PSP22::balance_of", {
+  origin: wallet.address,
+  args: { owner: wallet.address },
+});
+
+if (result.success) {
+  console.log("Balance:", result.value);
+}
+```
+
+## Features
+
+- **D9 Blockchain Client**: Pre-configured Polkadot-API client for D9 network
+- **Wallet Management**: HD wallet derivation, SR25519 signing, SS58 encoding
+- **Contract Descriptors**: Type-safe descriptors for D9 smart contracts
+- **Chain Specifications**: D9 network metadata and type definitions
+- **Utility Functions**: Balance formatting, address validation, gas estimation
+
+## API Overview
+
+### Client
+
+| Export              | Description                                |
+| ------------------- | ------------------------------------------ |
+| `createD9SdkClient` | Create D9 SDK client with contract support |
+
+### Wallet
+
+| Export                | Description                         |
+| --------------------- | ----------------------------------- |
+| `generateMnemonic`    | Generate BIP39 mnemonic             |
+| `createSR25519Wallet` | Create SR25519 wallet from mnemonic |
+| `deriveKeyPair`       | Derive key pair with HD path        |
+
+### Utilities
+
+| Export           | Description                      |
+| ---------------- | -------------------------------- |
+| `formatBalance`  | Format token balance for display |
+| `parseBalance`   | Parse balance string to bigint   |
+| `isValidAddress` | Validate SS58 address            |
+
+### Contract Descriptors
+
+Pre-built descriptors for D9 smart contracts:
+
+- `usdt` - USDT PSP22 token
+- `burnManager` - Token burning mechanism
+- `miningPool` - Mining reward contracts
+
+## Documentation
+
+For complete documentation, examples, and API reference, visit:
+
+- [D9 SDK Documentation](https://docs.d9network.xyz/docs/sdk/spec/overview)
+
+## License
+
+MIT

package/dist/index.cjs

@@ -7584,110 +7584,6 @@ function createAccountFromPrivateKey(options) {
 	};
 }
 
-//#endregion
-//#region src/utils/balance.ts
-/**
-* Balance formatting utilities for D9 blockchain
-*/
-const D9_DECIMALS = _d9_network_ink.D9_DECIMALS;
-const D9_SYMBOL = _d9_network_ink.D9_SYMBOL;
-const D9_SS58_PREFIX = _d9_network_ink.D9_SS58_PREFIX;
-const USDT_DECIMALS = _d9_network_ink.USDT_DECIMALS;
-const USDT_SYMBOL = _d9_network_ink.USDT_SYMBOL;
-/**
-* Pre-configured D9 token
-*/
-const D9_TOKEN = {
-	decimals: D9_DECIMALS,
-	symbol: D9_SYMBOL
-};
-/**
-* Pre-configured USDT token
-*/
-const USDT_TOKEN = {
-	decimals: USDT_DECIMALS,
-	symbol: USDT_SYMBOL
-};
-/**
-* Format a raw planck value to a human-readable balance string
-*
-* @param planck - The raw balance in planck units (smallest unit)
-* @param options - Formatting options
-* @returns Formatted balance string
-*
-* @example
-* ```typescript
-* formatBalance(1_500_000_000_000n, { decimals: 12 }); // "1.5"
-* formatBalance(1_500_000_000_000n, { decimals: 12, maxDecimals: 2 }); // "1.50"
-* formatBalance(1_000_000_000_000_000n, { decimals: 12, thousandsSeparator: "," }); // "1,000"
-* ```
-*/
-function formatBalance(planck, options = {}) {
-	const { decimals = D9_DECIMALS, maxDecimals = 4, trimTrailingZeros = true, thousandsSeparator } = options;
-	if (decimals < 0 || decimals > 30) throw new Error("Decimals must be between 0 and 30");
-	const divisor = 10n ** BigInt(decimals);
-	const isNegative = planck < 0n;
-	const absolutePlanck = isNegative ? -planck : planck;
-	const wholePart = absolutePlanck / divisor;
-	const fractionalPart = absolutePlanck % divisor;
-	let wholeStr = wholePart.toString();
-	if (thousandsSeparator && wholeStr.length > 3) wholeStr = wholeStr.replace(/\B(?=(\d{3})+(?!\d))/g, thousandsSeparator);
-	if (decimals === 0 || maxDecimals === 0) return isNegative ? `-${wholeStr}` : wholeStr;
-	let fractionalStr = fractionalPart.toString().padStart(decimals, "0");
-	if (fractionalStr.length > maxDecimals) fractionalStr = fractionalStr.slice(0, maxDecimals);
-	if (trimTrailingZeros) fractionalStr = fractionalStr.replace(/0+$/, "");
-	const prefix = isNegative ? "-" : "";
-	if (fractionalStr === "") return `${prefix}${wholeStr}`;
-	return `${prefix}${wholeStr}.${fractionalStr}`;
-}
-/**
-* Parse a human-readable amount string to planck units
-*
-* @param amount - The amount as a string or number
-* @param options - Parse options
-* @returns The amount in planck units (bigint)
-*
-* @example
-* ```typescript
-* parseAmount("1.5", { decimals: 12 }); // 1_500_000_000_000n
-* parseAmount(1.5, { decimals: 12 }); // 1_500_000_000_000n
-* parseAmount("1,000.50", { decimals: 12 }); // 1_000_500_000_000_000n
-* ```
-*/
-function parseAmount(amount, options = {}) {
-	const { decimals = D9_DECIMALS } = options;
-	if (decimals < 0 || decimals > 30) throw new Error("Decimals must be between 0 and 30");
-	let amountStr = String(amount).replace(/,/g, "").trim();
-	const isNegative = amountStr.startsWith("-");
-	if (isNegative) amountStr = amountStr.slice(1);
-	if (!/^\d*\.?\d*$/.test(amountStr) || amountStr === "" || amountStr === ".") throw new Error(`Invalid amount format: ${amount}`);
-	const [wholePart = "0", fractionalPart = ""] = amountStr.split(".");
-	if (fractionalPart.length > decimals) throw new Error(`Amount has more decimal places (${fractionalPart.length}) than supported (${decimals})`);
-	const planckStr = wholePart + fractionalPart.padEnd(decimals, "0");
-	const planck = BigInt(planckStr);
-	return isNegative ? -planck : planck;
-}
-/**
-* Format a token amount with symbol
-*
-* @param planck - The raw balance in planck units
-* @param token - Token configuration
-* @param options - Additional formatting options
-* @returns Formatted string with token symbol
-*
-* @example
-* ```typescript
-* formatTokenAmount(1_500_000_000_000n, D9_TOKEN); // "1.5 D9"
-* formatTokenAmount(1000n, USDT_TOKEN); // "10 USDT"
-* ```
-*/
-function formatTokenAmount(planck, token, options = {}) {
-	return `${formatBalance(planck, {
-		...options,
-		decimals: token.decimals
-	})} ${token.symbol}`;
-}
-
 //#endregion
 //#region src/wallet/validation.ts
 /**
@@ -7728,7 +7624,7 @@ function isValidAddress(address) {
 * ```
 */
 function isValidD9Address(address) {
-	return isValidAddressForNetwork(address, D9_SS58_PREFIX);
+	return isValidAddressForNetwork(address, _d9_network_ink.D9_SS58_PREFIX);
 }
 /**
 * Check if a value is a valid address for a specific network
@@ -7827,7 +7723,106 @@ function toNetworkAddress(address, targetPrefix) {
 * ```
 */
 function toD9Address(address) {
-	return toNetworkAddress(address, D9_SS58_PREFIX);
+	return toNetworkAddress(address, _d9_network_ink.D9_SS58_PREFIX);
+}
+
+//#endregion
+//#region src/utils/balance.ts
+/**
+* Balance formatting utilities for D9 blockchain
+*/
+/**
+* Pre-configured D9 token
+*/
+const D9_TOKEN = {
+	decimals: _d9_network_ink.D9_DECIMALS,
+	symbol: _d9_network_ink.D9_SYMBOL
+};
+/**
+* Pre-configured USDT token
+*/
+const USDT_TOKEN = {
+	decimals: _d9_network_ink.USDT_DECIMALS,
+	symbol: _d9_network_ink.USDT_SYMBOL
+};
+/**
+* Format a raw planck value to a human-readable balance string
+*
+* @param planck - The raw balance in planck units (smallest unit)
+* @param options - Formatting options
+* @returns Formatted balance string
+*
+* @example
+* ```typescript
+* formatBalance(1_500_000_000_000n, { decimals: 12 }); // "1.5"
+* formatBalance(1_500_000_000_000n, { decimals: 12, maxDecimals: 2 }); // "1.50"
+* formatBalance(1_000_000_000_000_000n, { decimals: 12, thousandsSeparator: "," }); // "1,000"
+* ```
+*/
+function formatBalance(planck, options = {}) {
+	const { decimals = _d9_network_ink.D9_DECIMALS, maxDecimals = 4, trimTrailingZeros = true, thousandsSeparator } = options;
+	if (decimals < 0 || decimals > 30) throw new Error("Decimals must be between 0 and 30");
+	const divisor = 10n ** BigInt(decimals);
+	const isNegative = planck < 0n;
+	const absolutePlanck = isNegative ? -planck : planck;
+	const wholePart = absolutePlanck / divisor;
+	const fractionalPart = absolutePlanck % divisor;
+	let wholeStr = wholePart.toString();
+	if (thousandsSeparator && wholeStr.length > 3) wholeStr = wholeStr.replace(/\B(?=(\d{3})+(?!\d))/g, thousandsSeparator);
+	if (decimals === 0 || maxDecimals === 0) return isNegative ? `-${wholeStr}` : wholeStr;
+	let fractionalStr = fractionalPart.toString().padStart(decimals, "0");
+	if (fractionalStr.length > maxDecimals) fractionalStr = fractionalStr.slice(0, maxDecimals);
+	if (trimTrailingZeros) fractionalStr = fractionalStr.replace(/0+$/, "");
+	const prefix = isNegative ? "-" : "";
+	if (fractionalStr === "") return `${prefix}${wholeStr}`;
+	return `${prefix}${wholeStr}.${fractionalStr}`;
+}
+/**
+* Parse a human-readable amount string to planck units
+*
+* @param amount - The amount as a string or number
+* @param options - Parse options
+* @returns The amount in planck units (bigint)
+*
+* @example
+* ```typescript
+* parseAmount("1.5", { decimals: 12 }); // 1_500_000_000_000n
+* parseAmount(1.5, { decimals: 12 }); // 1_500_000_000_000n
+* parseAmount("1,000.50", { decimals: 12 }); // 1_000_500_000_000_000n
+* ```
+*/
+function parseAmount(amount, options = {}) {
+	const { decimals = _d9_network_ink.D9_DECIMALS } = options;
+	if (decimals < 0 || decimals > 30) throw new Error("Decimals must be between 0 and 30");
+	let amountStr = String(amount).replace(/,/g, "").trim();
+	const isNegative = amountStr.startsWith("-");
+	if (isNegative) amountStr = amountStr.slice(1);
+	if (!/^\d*\.?\d*$/.test(amountStr) || amountStr === "" || amountStr === ".") throw new Error(`Invalid amount format: ${amount}`);
+	const [wholePart = "0", fractionalPart = ""] = amountStr.split(".");
+	if (fractionalPart.length > decimals) throw new Error(`Amount has more decimal places (${fractionalPart.length}) than supported (${decimals})`);
+	const planckStr = wholePart + fractionalPart.padEnd(decimals, "0");
+	const planck = BigInt(planckStr);
+	return isNegative ? -planck : planck;
+}
+/**
+* Format a token amount with symbol
+*
+* @param planck - The raw balance in planck units
+* @param token - Token configuration
+* @param options - Additional formatting options
+* @returns Formatted string with token symbol
+*
+* @example
+* ```typescript
+* formatTokenAmount(1_500_000_000_000n, D9_TOKEN); // "1.5 D9"
+* formatTokenAmount(1000n, USDT_TOKEN); // "10 USDT"
+* ```
+*/
+function formatTokenAmount(planck, token, options = {}) {
+	return `${formatBalance(planck, {
+		...options,
+		decimals: token.decimals
+	})} ${token.symbol}`;
 }
 
 //#endregion
@@ -7979,9 +7974,6 @@ Object.defineProperty(exports, 'ContractEventParser', {
   }
 });
 exports.D9_BLOCK_TIME_MS = D9_BLOCK_TIME_MS;
-exports.D9_DECIMALS = D9_DECIMALS;
-exports.D9_SS58_PREFIX = D9_SS58_PREFIX;
-exports.D9_SYMBOL = D9_SYMBOL;
 exports.D9_TOKEN = D9_TOKEN;
 exports.DigestItem = DigestItem;
 exports.DispatchClass = DispatchClass;
@@ -7994,8 +7986,6 @@ exports.SessionEvent = SessionEvent;
 exports.TransactionPaymentEvent = TransactionPaymentEvent;
 exports.TransactionPaymentReleases = TransactionPaymentReleases;
 exports.TransactionalError = TransactionalError;
-exports.USDT_DECIMALS = USDT_DECIMALS;
-exports.USDT_SYMBOL = USDT_SYMBOL;
 exports.USDT_TOKEN = USDT_TOKEN;
 exports.addressesEqual = addressesEqual;
 exports.blocksToMs = blocksToMs;