xyqon 0.2.0 → 0.4.0

package/README.md

@@ -67,6 +67,7 @@ xyqon send \
 ```
 
 The transaction is broadcast to reachable public nodes. A miner must include it in a block before the receiver sees the confirmed balance.
+The client checks the best reachable public chain before broadcasting and refuses sends that exceed the wallet's confirmed XYQON balance.
 
 ## Create And Send Coins
 
@@ -83,6 +84,7 @@ xyqon coin send \
 ```
 
 Coin creation and coin sends are signed 0 XYQON transactions. A miner must include them before the new coin or transfer appears on-chain.
+Before broadcasting a coin transfer, the client checks the best reachable public chain and refuses sends that exceed the wallet's confirmed coin balance.
 
 ## Mint And Send NFTs
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xyqon",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Friendly wallet CLI and JavaScript client for the XYQON network.",
   "keywords": [
     "xyqon",

package/src/cli.js

@@ -42,7 +42,7 @@ ${color('bold', 'Usage')}
   xyqon wallet new --name <NAME> [--out <FILE>]
   xyqon wallet show [--wallet <FILE>] [--private]
   xyqon balance [--wallet <FILE>] [--address <PUBLIC_KEY>]
-  xyqon send --to <PUBLIC_KEY> --amount <AMOUNT> [--wallet <FILE>]
+  xyqon send --to <PUBLIC_KEY> --amount <AMOUNT> [--fee <AMOUNT>] [--wallet <FILE>]
   xyqon coin create --symbol <SYMBOL> --name <NAME> --supply <AMOUNT> [--wallet <FILE>]
   xyqon coin send --symbol <SYMBOL> --to <PUBLIC_KEY> --amount <AMOUNT> [--wallet <FILE>]
   xyqon nft mint --collection <SYMBOL> --token-id <ID> --name <NAME> [--image-url <URL>] [--wallet <FILE>]
@@ -152,14 +152,17 @@ async function run() {
       wallet,
       recipient: options.to,
       amount: options.amount,
+      fee: options.fee,
       peers: peersFromOptions(options)
     });
 
     printHero('Transaction Sent');
     console.log(`${color('bold', 'Amount:')} ${result.transaction.amount} XYQON`);
+    console.log(`${color('bold', 'Fee:')} ${result.transaction.fee} XYQON`);
     console.log(`${color('bold', 'To:')} ${result.transaction.recipient}`);
     console.log(`${color('bold', 'Transaction ID:')} ${result.transactionId}`);
-    console.log(`${color('green', 'Broadcast:')} ${result.acceptedBy}/${result.peers.length} reachable nodes`);
+    console.log(`${color('dim', 'Checked balance:')} ${result.preflight.balance} XYQON at block ${result.preflight.blockHeight}`);
+    console.log(`${color('green', 'Delivered:')} ${result.acceptedBy}/${result.peers.length} reachable nodes`);
     console.log(color('yellow', 'The receiver balance updates after a miner includes this transaction in a block.'));
     return;
   }
@@ -217,7 +220,8 @@ async function run() {
     console.log(`${color('bold', 'Amount:')} ${result.transaction.asset_operation.TransferCoin.amount} ${result.transaction.asset_operation.TransferCoin.symbol}`);
     console.log(`${color('bold', 'To:')} ${result.transaction.recipient}`);
     console.log(`${color('bold', 'Transaction ID:')} ${result.transactionId}`);
-    console.log(`${color('green', 'Broadcast:')} ${result.acceptedBy}/${result.peers.length} reachable nodes`);
+    console.log(`${color('dim', 'Checked balance:')} ${result.preflight.balance} ${result.preflight.symbol} at block ${result.preflight.blockHeight}`);
+    console.log(`${color('green', 'Delivered:')} ${result.acceptedBy}/${result.peers.length} reachable nodes`);
     return;
   }
 

package/src/index.js

@@ -8,6 +8,8 @@ export const DEFAULT_PEERS = [
   '143.244.149.8:7101',
   '147.182.138.183:7101'
 ];
+const XYQON_EPSILON = 0.00000001;
+export const DEFAULT_XYQON_TRANSACTION_FEE = 0.001;
 
 export const DEFAULT_WALLET_PATH = 'xyqon.wallet.json';
 
@@ -102,8 +104,11 @@ function stringifyAssetOperationForSigning(assetOperation) {
   throw new Error('unknown asset operation');
 }
 
-export function transactionPayload(sender, recipient, amount, senderPublicKey, assetOperation = null) {
-  const base = `${sender}|${recipient}|${Number(amount).toFixed(8)}|${senderPublicKey}`;
+export function transactionPayload(sender, recipient, amount, senderPublicKey, assetOperation = null, fee = 0) {
+  let base = `${sender}|${recipient}|${Number(amount).toFixed(8)}|${senderPublicKey}`;
+  if (Math.abs(Number(fee)) > XYQON_EPSILON) {
+    base = `${base}|fee:${Number(fee).toFixed(8)}`;
+  }
   const serializedAsset = stringifyAssetOperationForSigning(assetOperation);
   return serializedAsset ? `${base}|${serializedAsset}` : base;
 }
@@ -173,22 +178,27 @@ export function normalizeTokenAmount(amount, label = 'amount') {
   return numeric;
 }
 
-export function createSignedTransaction(wallet, recipient, amount) {
+export function createSignedTransaction(wallet, recipient, amount, fee = DEFAULT_XYQON_TRANSACTION_FEE) {
   const numericAmount = Number(amount);
   if (!Number.isFinite(numericAmount) || numericAmount <= 0) {
     throw new Error('amount must be a positive number');
   }
+  const numericFee = Number(fee);
+  if (!Number.isFinite(numericFee) || numericFee < 0) {
+    throw new Error('fee must be a non-negative number');
+  }
 
   const privateKey = hexToBytes(wallet.private_key);
   const senderPublicKey = assertWalletMatchesPrivateKey(wallet, privateKey);
 
-  const payload = transactionPayload(wallet.name, recipient, numericAmount, senderPublicKey);
+  const payload = transactionPayload(wallet.name, recipient, numericAmount, senderPublicKey, null, numericFee);
   const signature = ed25519.sign(new TextEncoder().encode(payload), privateKey);
 
   return {
     sender: wallet.name,
     recipient,
     amount: numericAmount,
+    fee: numericFee,
     sender_public_key: senderPublicKey,
     signature: bytesToHex(signature)
   };
@@ -401,7 +411,7 @@ export function calculateBalances(chain) {
       if (transaction.asset_operation) {
         continue;
       }
-      debit(transaction.sender_public_key, transaction.amount);
+      debit(transaction.sender_public_key, transaction.amount + (transaction.fee ?? 0));
       credit(transaction.recipient, transaction.amount);
     }
   }
@@ -524,6 +534,52 @@ export async function getBalance(addressOrWallet, seedPeers = DEFAULT_PEERS) {
   };
 }
 
+export async function assertSpendableXyqonBalance(wallet, amount, seedPeers = DEFAULT_PEERS, fee = 0) {
+  const numericAmount = Number(amount);
+  const numericFee = Number(fee);
+  const { chain, sourcePeer, peers } = await getBestChain(seedPeers);
+  const balances = calculateBalances(chain);
+  const balance = balances.get(wallet.public_key) ?? 0;
+  const totalDebit = numericAmount + numericFee;
+
+  if (balance + XYQON_EPSILON < totalDebit) {
+    throw new Error(
+      `insufficient confirmed XYQON balance; balance is ${balance}, attempted to spend ${numericAmount} plus fee ${numericFee}`
+    );
+  }
+
+  return {
+    balance,
+    fee: numericFee,
+    totalDebit,
+    blockHeight: chain.chain.at(-1)?.index ?? 0,
+    sourcePeer,
+    peers
+  };
+}
+
+export async function assertSpendableCoinBalance(wallet, symbol, amount, seedPeers = DEFAULT_PEERS) {
+  const normalizedSymbol = normalizeCoinSymbol(symbol);
+  const numericAmount = Number(amount);
+  const { chain, sourcePeer, peers } = await getBestChain(seedPeers);
+  const holding = listCoinHoldings(chain, wallet).find((coin) => coin.symbol === normalizedSymbol);
+  const balance = holding?.balance ?? 0;
+
+  if (balance + XYQON_EPSILON < numericAmount) {
+    throw new Error(
+      `insufficient confirmed ${normalizedSymbol} balance; balance is ${balance}, attempted to spend ${numericAmount}`
+    );
+  }
+
+  return {
+    symbol: normalizedSymbol,
+    balance,
+    blockHeight: chain.chain.at(-1)?.index ?? 0,
+    sourcePeer,
+    peers
+  };
+}
+
 export async function getCreatedCoins(addressOrWallet, seedPeers = DEFAULT_PEERS) {
   const { chain, sourcePeer, peers } = await getBestChain(seedPeers);
   return {
@@ -581,10 +637,12 @@ export async function broadcastTransaction(transaction, seedPeers = DEFAULT_PEER
   };
 }
 
-export async function sendTransaction({ wallet, recipient, amount, peers = DEFAULT_PEERS }) {
-  const transaction = createSignedTransaction(wallet, recipient, amount);
+export async function sendTransaction({ wallet, recipient, amount, fee = DEFAULT_XYQON_TRANSACTION_FEE, peers = DEFAULT_PEERS }) {
+  const transaction = createSignedTransaction(wallet, recipient, amount, fee);
+  const preflight = await assertSpendableXyqonBalance(wallet, transaction.amount, peers, transaction.fee);
   return {
     transaction,
+    preflight,
     ...(await broadcastTransaction(transaction, peers))
   };
 }
@@ -599,8 +657,15 @@ export async function createCoin({ wallet, symbol, name, supply, peers = DEFAULT
 
 export async function sendCoin({ wallet, recipient, symbol, amount, peers = DEFAULT_PEERS }) {
   const transaction = createCoinTransferTransaction(wallet, { recipient, symbol, amount });
+  const preflight = await assertSpendableCoinBalance(
+    wallet,
+    transaction.asset_operation.TransferCoin.symbol,
+    transaction.asset_operation.TransferCoin.amount,
+    peers
+  );
   return {
     transaction,
+    preflight,
     ...(await broadcastTransaction(transaction, peers))
   };
 }