Skip to content
BranchesTags
 
 

Repository files navigation

CAUTION: This is an experimental SDK. Use at your own risk.

Comprehensive SDK documentation: see README-SDK.md.

QuantumCoin.js

QuantumCoin.js is a SDK for the QuantumCoin blockchain that maintains close compatibility with ethers.js v6.

Key differences vs Ethereum/ethers:

  • Addresses are 32 bytes (66 hex chars including 0x)
  • No HDWallet support (not applicable to QuantumCoin)
  • All signing, address derivation, and ABI packing/unpacking are delegated to quantum-coin-js-sdk (as required by SPEC.md)

Install

npm install quantumcoin

Initialize (required)

You must initialize once before using wallet/address/ABI helpers:

const { Initialize, Config } = require("quantumcoin/config");

// defaults: chainId=123123, rpcEndpoint=https://public.rpc.quantumcoinapi.com
await Initialize(null);

// or custom
await Initialize(new Config(123123, "https://public.rpc.quantumcoinapi.com"));

Provider (read-only)

const { JsonRpcProvider } = require("quantumcoin");

const provider = new JsonRpcProvider("https://public.rpc.quantumcoinapi.com", 123123);
console.log(await provider.getBlockNumber());

Wallet (offline + online)

const { Wallet } = require("quantumcoin");
const { Initialize } = require("quantumcoin/config");

await Initialize(null);

const wallet = Wallet.createRandom();

const encrypted = wallet.encryptSync("mySecurePassword123");
const restored = Wallet.fromEncryptedJsonSync(encrypted, "mySecurePassword123");
console.log(restored.address);

Seed phrase (getPhrase())

Any wallet that was constructed from a seed exposes its seed words via getPhrase():

const wallet = Wallet.createRandom();
const phrase = wallet.getPhrase();      // string[] of seed words, or null
const restored = Wallet.fromPhrase(phrase);
console.log(restored.address === wallet.address); // true

getPhrase() returns the seed words whenever wallet.seed is non-null — i.e. wallets produced by createRandom, fromPhrase, fromSeed, or fromEncryptedJsonSync on a version-5 keystore (produced by encryptSync on a seed-bearing wallet or by encryptSeedSync). It returns null for wallets constructed via fromKeys or from v3/v4 keystores.

Encrypt a raw seed

You can encrypt raw seed bytes (pre-expansion) into a portable wallet JSON (version 5 format) without first opening the wallet:

const { Wallet } = require("quantumcoin");
const { Initialize } = require("quantumcoin/config");

await Initialize(null);

// 64-byte seed (keyType 3), 72-byte (keyType 5), or 96-byte (legacy)
const seed = [51,214,149,165, /* ...remaining bytes... */];
const json = Wallet.encryptSeedSync(seed, "mySecurePassword123");
const restored = Wallet.fromEncryptedJsonSync(json, "mySecurePassword123");
console.log(restored.address);

Message signing (EIP-191 / personal_sign)

Sign and verify arbitrary messages using QuantumCoin's post-quantum keys. The message digest uses the exact same EIP-191 prefix as Ethereum (keccak256("\x19Ethereum Signed Message:\n" + len + message)), so it is byte-for-byte compatible with personal_sign in quantum-coin-go.

const { Wallet, verifyMessage, hashMessage } = require("quantumcoin");
const { Initialize } = require("quantumcoin/config");

await Initialize(null);

const wallet = Wallet.createRandom();

// async (ethers Signer contract) or sync
const signature = await wallet.signMessage("Hello Joe");
const signatureSync = wallet.signMessageSync("Hello Joe");

// verifyMessage is synchronous and returns the recovered signer address
const signer = verifyMessage("Hello Joe", signature);
console.log(signer === wallet.address); // true

// The EIP-191 digest is available on its own if needed
console.log(hashMessage("Hello Joe")); // 0x...32-byte hash

Differences vs Ethereum

  • Signature shape: not a 65-byte (r, s, v) value. It is an opaque, scheme-dependent multi-kilobyte hex blob whose first byte is the scheme id and which embeds the signer's public key. There is no Signature/r/s/v object.
  • Address size: recovered addresses are the full 32 bytes (66 hex chars).
  • No ecrecover: verifyMessage does not recover a key from (digest, sig) cryptographically. It extracts the embedded public key, verifies it against the digest, and returns its address; a signature that fails verification throws.
  • Signing context: signMessage/signMessageSync accept an optional signingContext. When omitted it derives the compact context from the key type (0 for keyType 3, 1 for keyType 5); pass 2 to request the full-signature scheme for a keyType 3 wallet.
  • Message size: the message must be at most 1 MiB (once UTF-8 encoded); larger inputs throw INVALID_ARGUMENT. The message is only ever hashed to a 32-byte digest, so there is no need for larger payloads.
  • EIP-712 (signTypedData) is not yet supported.

Contracts (read-only)

const { Initialize } = require("quantumcoin/config");
const { JsonRpcProvider, Contract } = require("quantumcoin");

await Initialize(null);

const provider = new JsonRpcProvider("https://public.rpc.quantumcoinapi.com", 123123);
const abi = require("./test/fixtures/StakingContract.abi.json");
const address = "0x0000000000000000000000000000000000000000000000000000000000001000";

const staking = new Contract(address, abi, provider);
console.log(await staking.getDepositorCount());

ABI encoding & decoding

Interface and AbiCoder provide ethers.js v6-compatible ABI handling. Beyond encoding, you can resolve fragments by name, canonical signature, or hex identifier, and decode/parse raw calldata — useful for a strict "what you see is what you sign" verification (decode the real bytes, then re-encode and compare).

const { Initialize } = require("quantumcoin/config");
const { Interface, AbiCoder } = require("quantumcoin");

await Initialize(null);
const iface = new Interface([
  { type: "function", name: "transfer",
    inputs: [{ name: "to", type: "address" }, { name: "amount", type: "uint256" }],
    outputs: [{ type: "bool" }] },
]);

const to = "0x" + "ab".repeat(32);           // 32-byte QuantumCoin address
const data = iface.encodeFunctionData("transfer", [to, 1000n]);

const tx = iface.parseTransaction({ data }); // resolves by selector, decodes args
// tx.name === "transfer", tx.selector === "0xa9059cbb", tx.args.amount === 1000n

// Re-encode the decoded args and confirm they reproduce the original calldata.
const verified = iface.encodeFunctionData(tx.fragment, Array.from(tx.args)) === data;

const coder = AbiCoder.defaultAbiCoder();
coder.encode(["uint256"], [1n]);

Highlights: getFunction/getError (by name, signature, or 4-byte selector), getEvent (by name, signature, or topic0), decodeFunctionData, parseTransaction, parseError, getSighash, FunctionFragment.selector, EventFragment.topicHash, Interface.encodeDeploy, and AbiCoder.defaultAbiCoder().

QuantumCoin addresses are 32 bytes and fill a full ABI word (Ethereum left-pads a 20-byte address). Canonical signatures are identical, so selectors and event topics match Ethereum exactly; only address-bearing calldata words differ. See README-SDK.md for the full API.

Typed contract generator

This repo includes a generator described in SPEC.md section 15.

# Non-interactive
node generate-sdk.js --abi path/to/abi.json --bin path/to/bytecode.bin --out ./generated --name MyContract --non-interactive

# JavaScript output (with TypeScript `.d.ts` types)
node generate-sdk.js --lang js --abi path/to/abi.json --bin path/to/bytecode.bin --out ./generated --name MyContract --non-interactive

# Interactive
node generate-sdk.js --abi path/to/abi.json --bin path/to/bytecode.bin

If installed as a package, you can also run:

npx sdkgen --abi path/to/abi.json --bin path/to/bytecode.bin --out ./generated --name MyContract --non-interactive

For more options (Solidity sources, artifacts JSON, package scaffolding), see README-SDK.md.

Generator typing model

  • Hard types: generated wrappers use concrete types from quantumcoin/types (e.g. Uint256Like for inputs, Uint256 for outputs).
  • Single return values are unwrapped: a Solidity function returning one value returns that value directly (not [value]).
  • Multiple returns: returned as a tuple type (e.g. Promise<[Uint256, Bool]>).
  • No returns: Promise<void>.
  • Structs / tuples: generated as export type <Name>Input / export type <Name>Output and used directly in method signatures.

Interface contracts

When the input artifact has empty bytecode ("0x" or empty .bin, typically produced by solc for a Solidity interface), the generator emits a transactional test that skips the post-deploy bytecode check. The deploy step still runs (the receipt-status assertion validates SDK wrapper wiring), but provider.getCode(contract.target) is not asserted to be non-empty — an interface deploys with no runtime code by design. Concrete contracts (non-empty bytecode) continue to assert that provider.getCode(contract.target) is non-empty.

Solidity types (TypeScript)

QuantumCoin.js exports core Solidity-related typings from:

  • quantumcoin/types

Common types:

  • AddressLike (currently string, 32-byte address)
  • BytesLike (string | Uint8Array)
  • BigNumberish (string | number | bigint)
  • Hard Solidity aliases (preferred for typed wrappers): Uint256Like / Uint256, Int256Like / Int256, Bytes32Like / Bytes32, and all widths Uint8Like…Uint256Like, Int8Like…Int256Like, plus Bytes1Like…Bytes32Like
  • SolidityTypeName, SolidityInputValue<T>, SolidityOutputValue<T> (advanced type-level mapping helpers; the generator no longer uses these for wrapper signatures)

Examples

npm run example
npm run example:wallet
npm run example:sign-message
npm run example:contract:read
npm run example:events
# Run all examples (including SDK generator JS/TS)
npm run examples

To try the typed SDK generator (generates a full package from Solidity or ABI+BIN):

node examples/example-generator-sdk-js.js   # JavaScript output
node examples/example-generator-sdk-ts.js   # TypeScript output

Requires solc on QC_SOLC_PATH or SOLC_PATH, or at default c:\solc\solc.exe. See README-SDK.md for all generator options (--artifacts-json, --sol, --create-package, etc.).

Tests

npm test
npm run test:unit
npm run test:non-transactional
npm run test:e2e

Troubleshooting

  • “SDK not initialized”: call Initialize(null) once at startup.
  • JSON-RPC errors/timeouts: verify Config.rpcEndpoint or pass an explicit URL to JsonRpcProvider.
  • Node version: quantum-coin-js-sdk tooling is developed primarily against Node 20+. If you see runtime issues, try Node 20 LTS.

Transactional (write) tests

The E2E tests broadcast real transactions and require a funded test wallet.

  • Set RPC URL via env var: QC_RPC_URL
  • (Optional) chain id via env var: QC_CHAIN_ID (default: 123123)
  • Solidity in tests is compiled with the JS-based @quantumcoin/solc package (installed via npm install); no external solc binary is needed. The generate-sdk.js CLI also defaults to it, with --solc <path> / QC_SOLC_PATH available as an optional external-binary override.

For local testing, run the QuantumCoin devnet (network ID 123123, prefilled funded wallet) and point QC_RPC_URL at its HTTP RPC port (e.g. http://127.0.0.1:8545) — see https://github.com/quantumcoinproject/quantum-coin-go/blob/main/quantumcoin-devnet-readme.md

About

QuantumCoin SDK for close compatibility with ethers.js

Resources

Readme
MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages