Skip to content

docs: align README and PQTx comments with PQVM-native design #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LucienSong merged 2 commits into from
May 23, 2026
Merged

docs: align README and PQTx comments with PQVM-native design #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bc5ad0
docs: replace EVM-compatible headline; clarify PQTx fee-field comments
LucienSong May 23, 2026
13ce3ec
docs(transactions): address review comments — standardize chainId/fee…
LucienSong May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 4 additions & 4 deletions src/transactions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`). */
Expand All @@ -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;
Expand All @@ -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;
Comment on lines 61 to 66
Copy link
Copy Markdown
Collaborator Author

@LucienSong LucienSong May 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 13ce3ec. All three issues addressed: standardized chainId to EIP-155 chain ID (Shell Chain) in BuildTransactionOptions; removed -style suffix from fee-field docs for consistency with the constant declarations; added (scaffolded; not enforced by the chain) clarification to both maxFeePerGas and maxPriorityFeePerGas.

/** Transaction type. Defaults to {@link DEFAULT_TX_TYPE}. */
txType?: number;
Expand Down
Loading