@steemit/steem-js 1.0.0 → 1.0.2

package/README.md

@@ -11,15 +11,21 @@ This is a complete refactoring of the original steem-js library, migrating from
 - ✅ **TypeScript Migration**: Complete migration from JavaScript to TypeScript
 - ✅ **Build System**: Migrated from Webpack to Rollup
 - ✅ **Testing**: Migrated from Mocha to Vitest
+- ✅ **Modern Dependencies (2024)**: Replaced outdated cryptographic libraries
+  - `bigi` → `bn.js` (modern big integer library)
+  - `ecurve` → `elliptic` (modern elliptic curve cryptography)
+  - Removed all shim layers for direct modern library usage
 - ✅ **Core Modules**: All core functionality implemented
   - API module with HTTP and WebSocket transports
   - Authentication and encryption (ECC secp256k1)
   - Broadcast operations
   - Memo encryption/decryption
-  - Transaction serialization
+  - Transaction serialization (95.8% test coverage)
 - ✅ **Security**: Fixed insecure random number generation, implemented proper cryptographic functions
 - ✅ **Tests**: 174 tests passing, 12 skipped (network-dependent integration tests)
 
+> 📖 **Detailed Refactoring Documentation**: See [docs/refactoring-2025.md](./docs/refactoring-2025.md) for complete modernization refactoring process, technical choices, and architectural improvements.
+
 ## Installation
 
 ```bash
@@ -47,7 +53,7 @@ yarn add @steemit/steem-js
 <script src="https://cdn.jsdelivr.net/npm/@steemit/steem-js/dist/index.umd.js"></script>
 ```
 
-**Note**: The UMD build includes all necessary polyfills (axios, events, buffer, util, stream, assert, crypto). No additional dependencies are required.
+**Note**: The UMD build includes all necessary polyfills (events, buffer, util, stream, assert, crypto-browserify). No additional dependencies are required.
 
 ## Usage
 

package/dist/auth/ecc/src/ecdsa.d.ts

@@ -1,9 +1,10 @@
-import BigInteger from 'bigi';
+import BN from 'bn.js';
 import ECSignature from './ecsignature';
-type Curve = any;
-type Point = any;
-export declare function sign(curve: Curve, hash: Buffer, d: BigInteger, nonce?: number): ECSignature;
-export declare function verify(curve: Curve, hash: Buffer, signature: ECSignature, Q: Point): boolean;
+import { ec as EC } from 'elliptic';
+type ECInstance = EC;
+type ECPoint = any;
+export declare function sign(curve: ECInstance, hash: Buffer, d: BN, nonce?: number): ECSignature;
+export declare function verify(curve: ECInstance, hash: Buffer, signature: ECSignature, Q: ECPoint): boolean;
 /**
  * Recover a public key from a signature.
  *
@@ -12,7 +13,7 @@ export declare function verify(curve: Curve, hash: Buffer, signature: ECSignatur
  *
  * http://www.secg.org/download/aid-780/sec1-v2.pdf
  */
-export declare function recoverPubKey(curve: Curve, e: BigInteger, signature: ECSignature, i: number): Point;
+export declare function recoverPubKey(curve: ECInstance, e: BN, signature: ECSignature, i: number): ECPoint;
 /**
  * Calculate pubkey extraction parameter.
  *
@@ -24,5 +25,5 @@ export declare function recoverPubKey(curve: Curve, e: BigInteger, signature: EC
  * This function simply tries all four cases and returns the value
  * that resulted in a successful pubkey recovery.
  */
-export declare function calcPubKeyRecoveryParam(curve: Curve, e: BigInteger, signature: ECSignature, Q: Point): number;
+export declare function calcPubKeyRecoveryParam(curve: ECInstance, e: BN, signature: ECSignature, Q: ECPoint): number;
 export {};

package/dist/auth/ecc/src/ecsignature.d.ts

@@ -1,8 +1,8 @@
-import BigInteger from 'bigi';
+import BN from 'bn.js';
 export default class ECSignature {
-    r: BigInteger;
-    s: BigInteger;
-    constructor(r: BigInteger, s: BigInteger);
+    r: BN;
+    s: BN;
+    constructor(r: BN, s: BN);
     static parseCompact(buffer: Buffer): {
         compressed: boolean;
         i: number;

package/dist/auth/ecc/src/key_private.d.ts

@@ -1,14 +1,14 @@
-import BigInteger from 'bigi';
+import BN from 'bn.js';
 import { PublicKey } from './key_public';
-type Point = any;
+type ECPoint = any;
 export declare class PrivateKey {
-    d: BigInteger;
+    d: BN;
     public_key?: PublicKey;
     /**
      * @private see static functions
-     * @param {BigInteger} d
+     * @param {BN} d
      */
-    constructor(d: BigInteger);
+    constructor(d: BN);
     static fromBuffer(buf: Buffer): PrivateKey;
     /** @arg {string} seed - any length string. This is private, the same seed produces the same private key every time. */
     static fromSeed(seed: string): PrivateKey;
@@ -24,7 +24,7 @@ export declare class PrivateKey {
     /**
      * @return {Point}
      */
-    toPublicKeyPoint(): Point;
+    toPublicKeyPoint(): ECPoint;
     toPublic(): PublicKey;
     toBuffer(): Buffer;
     /** ECIES */

package/dist/auth/ecc/src/key_public.d.ts

@@ -1,13 +1,13 @@
-type Point = any;
+type ECPoint = any;
 export declare class PublicKey {
-    Q: Point | null;
+    Q: ECPoint | null;
     pubdata?: string;
     /** @param {Point} public key */
-    constructor(Q: Point | null);
+    constructor(Q: ECPoint | null);
     static fromBinary(bin: string): PublicKey;
     static fromBuffer(buffer: Buffer): PublicKey;
-    toBuffer(compressed?: any): Buffer;
-    static fromPoint(point: Point): PublicKey;
+    toBuffer(compressed?: boolean): Buffer;
+    static fromPoint(point: ECPoint): PublicKey;
     toUncompressed(): PublicKey;
     /** bts::blockchain::address (unique but not a full public key) */
     toBlockchainAddress(): Buffer;

package/dist/auth/ecc/src/signature.d.ts

@@ -1,15 +1,16 @@
-import bigi from 'bigi';
+import BN from 'bn.js';
 import { PrivateKey } from './key_private';
 import { PublicKey } from './key_public';
 export declare class Signature {
-    r: bigi;
-    s: bigi;
+    r: BN;
+    s: BN;
     i: number;
-    constructor(r: bigi, s: bigi, i: number);
+    constructor(r: BN, s: BN, i: number);
     static fromBuffer(buffer: Buffer): Signature;
     toBuffer(): Buffer;
     static signBuffer(buf: Buffer, private_key: PrivateKey | string): Signature;
     static signBufferSha256(buf_sha256: Buffer, private_key: PrivateKey | string): Signature;
+    static isCanonical(r: Buffer, s: Buffer): boolean;
     static sign(string: string, private_key: PrivateKey | string): Signature;
     verifyBuffer(buf: Buffer, public_key: PublicKey): boolean;
     verifyHash(hash: Buffer, public_key: PublicKey): boolean;

package/dist/auth/serializer/transaction.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Serialize a transaction to binary format for Steem blockchain
+ * This is a simplified implementation that handles the basic structure
+ */
+export declare function serializeTransaction(trx: any): Buffer;

package/dist/config.d.ts

@@ -5,6 +5,8 @@ interface SteemConfig {
     websocket?: string;
     address_prefix?: string;
     chain_id?: string;
+    debug?: boolean;
+    debug_warnings?: boolean;
 }
 export declare class Config {
     private config;