diff --git a/README.md b/README.md index d2c01aa..5003c36 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # shell-sdk -**TypeScript / JavaScript SDK for Shell Chain** — build quantum-safe dApps on the first EVM chain secured before Q-Day. +**TypeScript / JavaScript SDK for Shell Chain** — build quantum-safe dApps on the PQVM-native post-quantum blockchain secured before Q-Day. [![Node ≥ 18](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/) [![ESM only](https://img.shields.io/badge/module-ESM-blue)](https://nodejs.org/api/esm.html) diff --git a/src/transactions.ts b/src/transactions.ts index 0ae60c2..8694f15 100644 --- a/src/transactions.ts +++ b/src/transactions.ts @@ -31,7 +31,7 @@ import { } from "./system-contracts.js"; import { shellAddressToBytes } from "./address.js"; -/** Default transaction type: `2` (EIP-1559). */ +/** Default transaction type: `2` (Shell PQTx format; encodes EIP-1559 fee fields, which are scaffolded and not yet enforced on-chain). */ export const DEFAULT_TX_TYPE = 2; /** Default gas limit for simple SHELL token transfers (`21_000`). */ @@ -48,7 +48,7 @@ export const DEFAULT_MAX_PRIORITY_FEE_PER_GAS = 100_000_000; /** Options accepted by {@link buildTransaction}. */ export interface BuildTransactionOptions { - /** EIP-155 chain ID. Devnet = 424242. */ + /** EIP-155 chain ID (Shell Chain). Devnet = 424242. */ chainId: number; /** Sender account nonce. */ nonce: number; @@ -60,9 +60,9 @@ export interface BuildTransactionOptions { data?: HexString; /** Gas limit. Defaults to {@link DEFAULT_TRANSFER_GAS_LIMIT}. */ gasLimit?: number; - /** EIP-1559 max fee per gas in wei. Defaults to {@link DEFAULT_MAX_FEE_PER_GAS}. */ + /** EIP-1559 max fee per gas in wei (scaffolded; not enforced by the chain). Defaults to {@link DEFAULT_MAX_FEE_PER_GAS}. */ maxFeePerGas?: number; - /** EIP-1559 priority fee in wei. Defaults to {@link DEFAULT_MAX_PRIORITY_FEE_PER_GAS}. */ + /** EIP-1559 priority fee in wei (scaffolded; not enforced by the chain). Defaults to {@link DEFAULT_MAX_PRIORITY_FEE_PER_GAS}. */ maxPriorityFeePerGas?: number; /** Transaction type. Defaults to {@link DEFAULT_TX_TYPE}. */ txType?: number;