ecash-lib 2.1.0 → 3.1.0

package/src/token/alp.ts

@@ -7,7 +7,7 @@ import { strToBytes } from '../io/str.js';
 import { Writer } from '../io/writer.js';
 import { WriterBytes } from '../io/writerbytes.js';
 import { WriterLength } from '../io/writerlength.js';
-import { Amount, BURN, GENESIS, GenesisInfo, MINT, SEND } from './common.js';
+import { BURN, GENESIS, GenesisInfo, MINT, SEND } from './common.js';
 
 /** LOKAD ID for ALP */
 export const ALP_LOKAD_ID = strToBytes('SLP2');
@@ -15,12 +15,12 @@ export const ALP_LOKAD_ID = strToBytes('SLP2');
 /** ALP standard token type number */
 export const ALP_STANDARD = 0;
 
-/** Mint data specifying mint amounts and batons of a GENESIS/MINT tx */
+/** Mint data specifying mint amounts (in atoms) and batons of a GENESIS/MINT tx */
 export interface MintData {
     /**
-     * List of amounts to be minted by this tx, each having their own tx output.
+     * Array of amounts in atoms to be minted by this tx, each having their own tx output.
      */
-    amounts: Amount[];
+    atomsArray: bigint[];
     /** Number of mint batons to create, each having their own tx output. */
     numBatons: number;
 }
@@ -80,7 +80,7 @@ export function alpMint(
 export function alpSend(
     tokenId: string,
     tokenType: number,
-    sendAmounts: Amount[],
+    sendAtomsArray: bigint[],
 ): Uint8Array {
     const tokenIdBytes = fromHexRev(tokenId);
     const writeSection = (writer: Writer) => {
@@ -89,9 +89,9 @@ export function alpSend(
         writer.putU8(SEND.length);
         writer.putBytes(SEND);
         writer.putBytes(tokenIdBytes);
-        writer.putU8(sendAmounts.length);
-        for (const amount of sendAmounts) {
-            putAlpAmount(amount, writer);
+        writer.putU8(sendAtomsArray.length);
+        for (const atoms of sendAtomsArray) {
+            putAlpAtoms(atoms, writer);
         }
     };
     const writerLength = new WriterLength();
@@ -105,7 +105,7 @@ export function alpSend(
 export function alpBurn(
     tokenId: string,
     tokenType: number,
-    burnAmount: Amount,
+    burnAtoms: bigint,
 ): Uint8Array {
     const tokenIdBytes = fromHexRev(tokenId);
     const writeSection = (writer: Writer) => {
@@ -114,7 +114,7 @@ export function alpBurn(
         writer.putU8(BURN.length);
         writer.putBytes(BURN);
         writer.putBytes(tokenIdBytes);
-        putAlpAmount(burnAmount, writer);
+        putAlpAtoms(burnAtoms, writer);
     };
     const writerLength = new WriterLength();
     writeSection(writerLength);
@@ -124,17 +124,17 @@ export function alpBurn(
 }
 
 function putMintData(mintData: MintData, writer: Writer) {
-    writer.putU8(mintData.amounts.length);
-    for (const amount of mintData.amounts) {
-        putAlpAmount(amount, writer);
+    writer.putU8(mintData.atomsArray.length);
+    for (const atoms of mintData.atomsArray) {
+        putAlpAtoms(atoms, writer);
     }
     writer.putU8(mintData.numBatons);
 }
 
-function putAlpAmount(amount: Amount, writer: Writer) {
-    const amountN = BigInt(amount);
-    writer.putU32(amountN & 0xffffffffn);
-    writer.putU16(amountN >> 32n);
+function putAlpAtoms(atoms: bigint, writer: Writer) {
+    const atomsN = BigInt(atoms);
+    writer.putU32(atomsN & 0xffffffffn);
+    writer.putU16(atomsN >> 32n);
 }
 
 function putVarBytes(bytes: Uint8Array, writer: Writer) {

package/src/token/common.ts

@@ -4,8 +4,6 @@
 
 import { strToBytes } from '../io/str.js';
 
-export type Amount = bigint | number;
-
 export const GENESIS = strToBytes('GENESIS');
 export const MINT = strToBytes('MINT');
 export const SEND = strToBytes('SEND');

package/src/token/slp.ts

@@ -7,7 +7,7 @@ import { strToBytes } from '../io/str.js';
 import { Op, pushBytesOp } from '../op.js';
 import { OP_PUSHDATA1, OP_RETURN } from '../opcode.js';
 import { Script } from '../script.js';
-import { Amount, BURN, GENESIS, GenesisInfo, MINT, SEND } from './common.js';
+import { BURN, GENESIS, GenesisInfo, MINT, SEND } from './common.js';
 
 /** LOKAD ID for SLP */
 export const SLP_LOKAD_ID = strToBytes('SLP\0');
@@ -25,7 +25,7 @@ export const SLP_NFT1_GROUP = 0x81;
 export function slpGenesis(
     tokenType: number,
     genesisInfo: GenesisInfo,
-    initialQuantity: Amount,
+    initialQuantity: bigint,
     mintBatonOutIdx?: number,
 ): Script {
     verifyTokenType(tokenType);
@@ -53,7 +53,7 @@ export function slpGenesis(
             data.push(new Uint8Array());
         }
     }
-    data.push(slpAmount(initialQuantity));
+    data.push(slpAtoms(initialQuantity));
     return Script.fromOps([OP_RETURN as Op].concat(data.map(pushdataOpSlp)));
 }
 
@@ -64,7 +64,7 @@ export function slpGenesis(
 export function slpMint(
     tokenId: string,
     tokenType: number,
-    additionalQuantity: Amount,
+    additionalAtoms: bigint,
     mintBatonOutIdx?: number,
 ): Script {
     verifyTokenType(tokenType);
@@ -80,7 +80,7 @@ export function slpMint(
                 mintBatonOutIdx !== undefined ? [mintBatonOutIdx] : [],
             ),
         ),
-        pushdataOpSlp(slpAmount(additionalQuantity)),
+        pushdataOpSlp(slpAtoms(additionalAtoms)),
     ]);
 }
 
@@ -90,10 +90,10 @@ export function slpMint(
  **/
 export function slpMintVault(
     tokenId: string,
-    additionalQuantities: Amount[],
+    additionalAtomsArray: bigint[],
 ): Script {
     verifyTokenId(tokenId);
-    verifySendAmounts(additionalQuantities);
+    verifySendAtomsArray(additionalAtomsArray);
     return Script.fromOps(
         [
             OP_RETURN,
@@ -102,7 +102,7 @@ export function slpMintVault(
             pushdataOpSlp(MINT),
             pushdataOpSlp(fromHex(tokenId)),
         ].concat(
-            additionalQuantities.map(qty => pushdataOpSlp(slpAmount(qty))),
+            additionalAtomsArray.map(atoms => pushdataOpSlp(slpAtoms(atoms))),
         ),
     );
 }
@@ -113,11 +113,11 @@ export function slpMintVault(
 export function slpSend(
     tokenId: string,
     tokenType: number,
-    sendAmounts: Amount[],
+    sendAtomsArray: bigint[],
 ): Script {
     verifyTokenType(tokenType);
     verifyTokenId(tokenId);
-    verifySendAmounts(sendAmounts);
+    verifySendAtomsArray(sendAtomsArray);
     return Script.fromOps(
         [
             OP_RETURN,
@@ -125,7 +125,7 @@ export function slpSend(
             pushdataOpSlp(new Uint8Array([tokenType])),
             pushdataOpSlp(SEND),
             pushdataOpSlp(fromHex(tokenId)),
-        ].concat(sendAmounts.map(qty => pushdataOpSlp(slpAmount(qty)))),
+        ].concat(sendAtomsArray.map(atoms => pushdataOpSlp(slpAtoms(atoms)))),
     );
 }
 
@@ -136,7 +136,7 @@ export function slpSend(
 export function slpBurn(
     tokenId: string,
     tokenType: number,
-    burnAmount: Amount,
+    burnAtoms: bigint,
 ): Script {
     verifyTokenType(tokenType);
     verifyTokenId(tokenId);
@@ -146,7 +146,7 @@ export function slpBurn(
         pushdataOpSlp(new Uint8Array([tokenType])),
         pushdataOpSlp(BURN),
         pushdataOpSlp(fromHex(tokenId)),
-        pushdataOpSlp(slpAmount(burnAmount)),
+        pushdataOpSlp(slpAtoms(burnAtoms)),
     ]);
 }
 
@@ -170,13 +170,13 @@ function verifyTokenId(tokenId: string) {
     }
 }
 
-function verifySendAmounts(sendAmounts: Amount[]) {
-    if (sendAmounts.length == 0) {
-        throw new Error('Send amount cannot be empty');
+function verifySendAtomsArray(sendAtomsArray: bigint[]) {
+    if (sendAtomsArray.length == 0) {
+        throw new Error('sendAtomsArray cannot be empty');
     }
-    if (sendAmounts.length > 19) {
+    if (sendAtomsArray.length > 19) {
         throw new Error(
-            `Cannot use more than 19 amounts, but got ${sendAmounts.length}`,
+            `Cannot use more than 19 amounts, but got ${sendAtomsArray.length}`,
         );
     }
 }
@@ -197,16 +197,16 @@ function pushdataOpSlp(pushdata: Uint8Array): Op {
     return pushBytesOp(pushdata);
 }
 
-export function slpAmount(amount: Amount): Uint8Array {
-    if (amount < 0 || BigInt(amount) > 0xffffffffffffffffn) {
-        throw new Error(`Amount out of range: ${amount}`);
+export function slpAtoms(atoms: bigint): Uint8Array {
+    if (atoms < 0n || atoms > 0xffffffffffffffffn) {
+        throw new Error(`Atoms out of range: ${atoms}`);
     }
-    const amountBytes = new Uint8Array(8);
+    const atomsBytes = new Uint8Array(8);
     const view = new DataView(
-        amountBytes.buffer,
-        amountBytes.byteOffset,
-        amountBytes.byteLength,
+        atomsBytes.buffer,
+        atomsBytes.byteOffset,
+        atomsBytes.byteLength,
     );
-    view.setBigUint64(0, BigInt(amount), /*little endian=*/ false);
-    return amountBytes;
+    view.setBigUint64(0, atoms, /*little endian=*/ false);
+    return atomsBytes;
 }

package/src/tx.ts

@@ -49,7 +49,7 @@ export interface TxInput {
 /** CTxOut, creating a new output. */
 export interface TxOutput {
     /** Value in satoshis of the output (1 XEC = 100 satoshis) */
-    value: number | bigint;
+    sats: bigint;
     /** Script locking the output */
     script: Script;
 }
@@ -57,7 +57,7 @@ export interface TxOutput {
 /** All the data required to sign an input (using BIP143). */
 export interface SignData {
     /** Value of the output being spent */
-    value: number | bigint;
+    sats: bigint;
     /** Script of the output being spent (not for P2SH) */
     outputScript?: Script;
     /**
@@ -120,10 +120,10 @@ export class Tx {
 }
 
 export function readTxOutput(bytes: Bytes): TxOutput {
-    const value = bytes.readU64();
+    const sats = bytes.readU64();
     const script = Script.readWithSize(bytes);
     return {
-        value,
+        sats,
         script,
     };
 }
@@ -147,7 +147,7 @@ export function writeTxInput(input: TxInput, writer: Writer): void {
 
 /** Write a TxOutput to a Writer */
 export function writeTxOutput(output: TxOutput, writer: Writer): void {
-    writer.putU64(output.value);
+    writer.putU64(output.sats);
     output.script.writeWithSize(writer);
 }
 
@@ -164,7 +164,7 @@ export function copyTxInput(input: TxInput): TxInput {
         script: input.script?.copy(),
         sequence: input.sequence,
         signData: input.signData && {
-            value: input.signData.value,
+            sats: input.signData.sats,
             outputScript: input.signData.outputScript?.copy(),
             redeemScript: input.signData.redeemScript?.copy(),
         },
@@ -174,7 +174,7 @@ export function copyTxInput(input: TxInput): TxInput {
 /** Create a deep copy of the TxOutput */
 export function copyTxOutput(output: TxOutput): TxOutput {
     return {
-        value: output.value,
+        sats: output.sats,
         script: output.script.copy(),
     };
 }

package/src/txBuilder.ts

@@ -84,7 +84,7 @@ export class TxBuilder {
             if (input.input.signData === undefined) {
                 return undefined;
             }
-            inputSum += BigInt(input.input.signData.value);
+            inputSum += BigInt(input.input.signData.sats);
         }
         return inputSum;
     }
@@ -96,7 +96,7 @@ export class TxBuilder {
     } {
         let fixedOutputSum = 0n;
         let leftoverIdx: number | undefined = undefined;
-        let outputs: TxOutput[] = new Array(this.outputs.length);
+        const outputs: TxOutput[] = new Array(this.outputs.length);
         for (let idx = 0; idx < this.outputs.length; ++idx) {
             const builderOutput = this.outputs[idx];
             if ('bytecode' in builderOutput) {
@@ -108,11 +108,11 @@ export class TxBuilder {
                 }
                 leftoverIdx = idx;
                 outputs[idx] = {
-                    value: 0, // placeholder
+                    sats: 0n, // placeholder
                     script: builderOutput.copy(),
                 };
             } else {
-                fixedOutputSum += BigInt(builderOutput.value);
+                fixedOutputSum += BigInt(builderOutput.sats);
                 outputs[idx] = copyTxOutput(builderOutput);
             }
         }
@@ -122,8 +122,8 @@ export class TxBuilder {
     /** Sign the tx built by this builder and return a Tx */
     public sign(params?: {
         ecc?: Ecc;
-        feePerKb?: number;
-        dustLimit?: number;
+        feePerKb?: bigint;
+        dustSats?: bigint;
     }): Tx {
         const ecc = params?.ecc ?? new Ecc();
         const { fixedOutputSum, leftoverIdx, outputs } = this.prepareOutputs();
@@ -147,7 +147,7 @@ export class TxBuilder {
             const inputSum = this.inputSum();
             if (inputSum === undefined) {
                 throw new Error(
-                    'Using a leftover output requires setting SignData.value for all inputs',
+                    'Using a leftover output requires setting SignData.sats for all inputs',
                 );
             }
             if (params?.feePerKb === undefined) {
@@ -155,12 +155,12 @@ export class TxBuilder {
                     'Using a leftover output requires setting feePerKb',
                 );
             }
-            if (!Number.isInteger(params.feePerKb)) {
-                throw new Error('feePerKb must be an integer');
+            if (typeof params.feePerKb !== 'bigint') {
+                throw new Error('feePerKb must be a bigint');
             }
-            if (params?.dustLimit === undefined) {
+            if (params?.dustSats === undefined) {
                 throw new Error(
-                    'Using a leftover output requires setting dustLimit',
+                    'Using a leftover output requires setting dustSats',
                 );
             }
             const dummyUnsignedTx = UnsignedTx.dummyFromTx(
@@ -175,8 +175,8 @@ export class TxBuilder {
             updateSignatories(new EccDummy(), dummyUnsignedTx);
             let txSize = dummyUnsignedTx.tx.serSize();
             let txFee = calcTxFee(txSize, params.feePerKb);
-            const leftoverValue = inputSum - (fixedOutputSum + txFee);
-            if (leftoverValue < params.dustLimit) {
+            const leftoverSats = inputSum - (fixedOutputSum + txFee);
+            if (leftoverSats < params.dustSats) {
                 // inputs cannot pay for a dust leftover -> remove & recalc
                 outputs.splice(leftoverIdx, 1);
                 dummyUnsignedTx.tx.outputs = outputs;
@@ -185,11 +185,11 @@ export class TxBuilder {
                 txSize = dummyUnsignedTx.tx.serSize();
                 txFee = calcTxFee(txSize, params.feePerKb);
             } else {
-                outputs[leftoverIdx].value = leftoverValue;
+                outputs[leftoverIdx].sats = leftoverSats;
             }
             if (inputSum < fixedOutputSum + txFee) {
                 throw new Error(
-                    `Insufficient input value (${inputSum}): Can only pay for ${
+                    `Insufficient input sats (${inputSum}): Can only pay for ${
                         inputSum - fixedOutputSum
                     } fees, but ${txFee} required`,
                 );
@@ -210,7 +210,7 @@ export class TxBuilder {
 
 /** Calculate the required tx fee for the given txSize and feePerKb,
  *  rounding up */
-export function calcTxFee(txSize: number, feePerKb: number): bigint {
+export function calcTxFee(txSize: number, feePerKb: bigint): bigint {
     return (BigInt(txSize) * BigInt(feePerKb) + 999n) / 1000n;
 }
 

package/src/unsignedTx.ts

@@ -146,7 +146,7 @@ function writeLegacyPreimage(
             idx != inputIdx
         ) {
             // Do not lock-in the txout payee at other indices as txin
-            writeTxOutput({ value: 0, script: new Script() }, writer);
+            writeTxOutput({ sats: 0n, script: new Script() }, writer);
         } else {
             writeTxOutput(tx.outputs[idx], writer);
         }
@@ -288,7 +288,7 @@ export class UnsignedTxInput {
             }
             writeOutPoint(input.prevOut, writer);
             scriptCode.writeWithSize(writer);
-            writer.putU64(signData.value);
+            writer.putU64(signData.sats);
             writer.putU32(input.sequence ?? DEFAULT_SEQUENCE);
             writer.putBytes(hashOutputs);
             writer.putU32(tx.locktime);

package/.eslintignore

@@ -1,8 +0,0 @@
-# Dependency directories
-node_modules/*
-
-# artifact from testing CI locally
-test_results/*
-
-# compiled ts
-dist/*

package/eslint.config.js

@@ -1,16 +0,0 @@
-// Copyright (c) 2024 The Bitcoin developers
-// Distributed under the MIT software license, see the accompanying
-// file COPYING or http://www.opensource.org/licenses/mit-license.php.
-
-// @ts-check
-
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-
-export default tseslint.config(
-    eslint.configs.recommended,
-    ...tseslint.configs.recommended,
-    {
-        ignores: ['dist/*'],
-    },
-);