From 5bc5ad06e9347f6b104aef53d99662448ab5312e Mon Sep 17 00:00:00 2001 From: LucienSong Date: Sat, 23 May 2026 18:06:10 +0800 Subject: [PATCH 1/2] docs: replace EVM-compatible headline; clarify PQTx fee-field comments - README: PQVM-native chain description - src/transactions.ts: EIP-1559-style fee fields (not claiming ECDSA-based signing), Shell chain ID label instead of EIP-155, removed bare EIP-1559 and EIP-155 labels Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- README.md | 2 +- src/transactions.ts | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) 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..9a5fcfc 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` (EIP-1559-style fee fields; Shell PQTx format). */ 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. */ + /** Shell chain ID. 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-style max fee per gas in wei. 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-style priority fee in wei. Defaults to {@link DEFAULT_MAX_PRIORITY_FEE_PER_GAS}. */ maxPriorityFeePerGas?: number; /** Transaction type. Defaults to {@link DEFAULT_TX_TYPE}. */ txType?: number; From 13ce3ec0179b85f13c2606a3f4dce0973b5ba366 Mon Sep 17 00:00:00 2001 From: LucienSong Date: Sat, 23 May 2026 23:09:15 +0800 Subject: [PATCH 2/2] =?UTF-8?q?docs(transactions):=20address=20review=20co?= =?UTF-8?q?mments=20=E2=80=94=20standardize=20chainId/fee-field=20JSDoc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Standardize chainId description to 'EIP-155 chain ID (Shell Chain)' in BuildTransactionOptions (was 'Shell chain ID'), matching all other helpers - Remove '-style' suffix from EIP-1559 fee field docs in BuildTransactionOptions for consistency with DEFAULT_MAX_FEE_PER_GAS / DEFAULT_MAX_PRIORITY_FEE_PER_GAS - Add '(scaffolded; not enforced by the chain)' note to maxFeePerGas and maxPriorityFeePerGas fields to clarify gas fields are present in encoding but not yet active on-chain - Update DEFAULT_TX_TYPE comment to explain fee-field scaffolding intent Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/transactions.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/transactions.ts b/src/transactions.ts index 9a5fcfc..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-style fee fields; Shell PQTx format). */ +/** 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 { - /** Shell 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-style 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-style 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;