@steemit/steem-js 1.0.3 → 1.0.4

package/README.md

@@ -1,246 +1,121 @@
 # Steem.js
 
-Steem.js is a JavaScript/TypeScript library for interacting with the Steem blockchain.
+A modern JavaScript/TypeScript library for interacting with the Steem blockchain. Complete refactoring with TypeScript, modern tooling, and improved security.
 
-## Status
+[![npm version](https://img.shields.io/npm/v/@steemit/steem-js.svg)](https://www.npmjs.com/package/@steemit/steem-js)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-This is a complete refactoring of the original steem-js library, migrating from JavaScript to TypeScript with modern tooling and improved code quality. Published as `@steemit/steem-js`.
+## 📚 Documentation
 
-### Refactoring Progress
+**[👉 Complete API Documentation](./docs/README.md)** - Comprehensive guide with all methods, examples, and usage patterns
 
-- ✅ **TypeScript Migration**: Complete migration from JavaScript to TypeScript
-- ✅ **Build System**: Migrated from Webpack to Rollup
-- ✅ **Testing**: Migrated from Mocha to Vitest
-- ✅ **Modern Dependencies (2025)**: 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 (95.8% test coverage)
-- ✅ **Security**: Fixed insecure random number generation, implemented proper cryptographic functions
-- ✅ **Tests**: 174 tests passing, 12 skipped (network-dependent integration tests)
+**[🔧 Refactoring Details](./docs/refactoring-2025.md)** - Technical details about the 2025 modernization
 
-> 📖 **Detailed Refactoring Documentation**: See [docs/refactoring-2025.md](./docs/refactoring-2025.md) for complete modernization refactoring process, technical choices, and architectural improvements.
+## 🚀 Quick Start
 
-## Installation
-
-```bash
-pnpm install
-# or
-npm install
-```
-
-## Installation
-
-### npm / pnpm / yarn
+### Installation
 
 ```bash
+# npm
 npm install @steemit/steem-js
-# or
-pnpm install @steemit/steem-js
-# or
-yarn add @steemit/steem-js
-```
 
-### Browser (CDN)
-
-```html
-<!-- Include @steemit/steem-js (all dependencies are bundled) -->
-<!-- For production: use minified version (692KB) -->
-<script src="https://cdn.jsdelivr.net/npm/@steemit/steem-js/dist/index.umd.min.js"></script>
+# pnpm (recommended)
+pnpm install @steemit/steem-js
 
-<!-- For development: use regular version (1.7MB) with better debugging -->
-<script src="https://cdn.jsdelivr.net/npm/@steemit/steem-js/dist/index.umd.js"></script>
+# yarn
+yarn add @steemit/steem-js
 ```
 
-**Note**: The UMD build includes all necessary polyfills (events, buffer, util, stream, assert, crypto-browserify). No additional dependencies are required. The minified version is recommended for production use.
-
-## Usage
-
-### Node.js / TypeScript / ES Modules
+### Basic Usage
 
 ```typescript
 import { steem } from '@steemit/steem-js';
 
-// Configure the API endpoint
+// Configure API endpoint
 steem.config.set({
   node: 'https://api.steemit.com',
-  address_prefix: 'STM',
-  chain_id: '0000000000000000000000000000000000000000000000000000000000000000'
+  address_prefix: 'STM'
 });
 
 // Get account information
-const account = await steem.api.getAccountAsync('ned');
-console.log(account);
-
-// Generate keys
-const keys = steem.auth.generateKeys('username', 'password', ['owner', 'active', 'posting', 'memo']);
-console.log(keys);
-
-// Sign and verify messages
-import { generateKeyPair, sign, verify } from '@steemit/steem-js/crypto';
-const keyPair = generateKeyPair();
-const message = 'Hello, Steem!';
-const signature = sign(message, keyPair.privateKey);
-const isValid = verify(message, signature, keyPair.publicKey);
-console.log('Signature valid:', isValid);
-```
-
-### Node.js / CommonJS
-
-```javascript
-const { steem } = require('@steemit/steem-js');
-
-steem.config.set({
-  node: 'https://api.steemit.com',
-  address_prefix: 'STM'
-});
+const accounts = await steem.api.getAccountsAsync(['username']);
+console.log(accounts[0]);
 
-const account = await steem.api.getAccountAsync('ned');
-console.log(account);
+// Vote on a post
+const postingWif = steem.auth.toWif('username', 'password', 'posting');
+await steem.broadcast.voteAsync(postingWif, 'voter', 'author', 'permlink', 10000);
 ```
 
-### Browser (Script Tag)
-
-The UMD build includes all necessary dependencies and polyfills, so you can use it directly without any additional setup.
+### Browser Usage
 
 ```html
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Steem.js Example</title>
-  <!-- Include @steemit/steem-js (minified for production) -->
-  <script src="https://cdn.jsdelivr.net/npm/@steemit/steem-js/dist/index.umd.min.js"></script>
-</head>
-<body>
-  <script>
-    // Use the global 'steem' object
-    steem.config.set({
-      node: 'https://api.steemit.com',
-      address_prefix: 'STM'
-    });
-
-    // Get account information
-    steem.api.getAccountAsync('ned')
-      .then(account => {
-        console.log('Account:', account);
-      })
-      .catch(error => {
-        console.error('Error:', error);
-      });
-  </script>
-</body>
-</html>
+<script src="https://cdn.jsdelivr.net/npm/@steemit/steem-js/dist/index.umd.min.js"></script>
+<script>
+  steem.config.set({ node: 'https://api.steemit.com' });
+  steem.api.getAccountsAsync(['username']).then(console.log);
+</script>
 ```
 
-**Note**: The UMD build comes in two versions:
-- **Minified** (`index.umd.min.js` - 692KB): Recommended for production
-- **Regular** (`index.umd.js` - 1.7MB): Better for development and debugging
-
-Both include all polyfills, making them ready to use in browsers without additional dependencies. For production use with bundlers (Webpack, Vite, Rollup), use the ES Module or CommonJS builds instead.
-
-### Broadcast Operations
-
-```typescript
-import { steem } from '@steemit/steem-js';
-
-// Vote on a post
-const postingWif = steem.auth.toWif('username', 'password', 'posting');
-await steem.broadcast.voteAsync(
-  postingWif,
-  'voter',
-  'author',
-  'permlink',
-  10000 // weight
-);
-
-// Transfer STEEM
-await steem.broadcast.transferAsync(
-  activeWif,
-  'from',
-  'to',
-  '1.000 STEEM',
-  'memo'
-);
-```
+## ✨ Key Features
 
-## Development
+- **🔒 Type Safety** - Full TypeScript support with complete type definitions
+- **⚡ Modern** - ES modules, async/await, modern cryptography libraries
+- **🌐 Universal** - Works in Node.js, browsers, and bundlers
+- **🔐 Secure** - Proper cryptographic implementations, no key exposure
+- **📖 Well Documented** - Comprehensive API documentation with examples
 
-### Build
+## 🏗️ Development
 
 ```bash
-pnpm build
-```
+# Install dependencies
+pnpm install
 
-### Test
+# Build the library
+pnpm build
 
-```bash
-# Run all tests
+# Run tests
 pnpm test
 
-# Run tests in watch mode
-pnpm test:watch
-
-# Run tests with coverage
-pnpm test:coverage
-```
-
-### Type Check
-
-```bash
+# Type checking
 pnpm typecheck
 ```
 
-### Lint
+## 📦 What's New in 2025
 
-```bash
-pnpm lint
-```
+This is a complete modernization of the original steem-js library:
+
+- ✅ **TypeScript Migration** - Full type safety and better developer experience
+- ✅ **Modern Dependencies** - Replaced outdated crypto libraries (`bigi` → `bn.js`, `ecurve` → `elliptic`)
+- ✅ **Build System** - Migrated from Webpack to Rollup for better output
+- ✅ **Testing** - Migrated from Mocha to Vitest with 95.8% test coverage
+- ✅ **Security** - Fixed insecure random number generation and crypto implementations
 
-## Project Structure
+## 📋 Project Structure
 
 ```
 src/
-  api/          # API client with HTTP and WebSocket transports
-  auth/         # Authentication and key management
-  broadcast/    # Transaction broadcasting
-  crypto/       # Cryptographic utilities
-  formatter/    # Data formatting
-  memo/         # Encrypted memo handling
-  operations/   # Operation type definitions
-  serializer/   # Transaction serialization
-  utils/        # Utility functions
+├── api/          # Blockchain API client (HTTP/WebSocket)
+├── auth/         # Authentication and key management
+├── broadcast/    # Transaction broadcasting
+├── crypto/       # Cryptographic utilities
+├── formatter/    # Data formatting helpers
+├── memo/         # Encrypted memo handling
+├── operations/   # Operation type definitions
+├── serializer/   # Transaction serialization
+└── utils/        # Utility functions
 ```
 
-## Key Features
-
-- **Type Safety**: Full TypeScript support with type definitions
-- **Modern ES Modules**: Uses ES modules with CommonJS fallback
-- **Secure Cryptography**: Proper implementation using Node.js crypto module
-- **Multiple Transports**: Supports both HTTP and WebSocket connections
-- **Promise and Callback Support**: Compatible with both async/await and callback patterns
-
-## Breaking Changes from Original
-
-This is a complete refactor with the following changes:
-
-1. **TypeScript**: All code is now TypeScript
-2. **ES Modules**: Uses ES modules by default (CommonJS available)
-3. **Build System**: Uses Rollup instead of Webpack
-4. **Testing**: Uses Vitest instead of Mocha
-5. **API**: Some method signatures may have changed for better type safety
+## 🔗 Links
 
-## Security Notes
+- **[📖 API Documentation](./docs/README.md)** - Complete method reference
+- **[🔧 Refactoring History](./docs/refactoring-2025.md)** - Technical modernization details
+- **[📦 NPM Package](https://www.npmjs.com/package/@steemit/steem-js)** - Published package
+- **[🐛 Issues](https://github.com/steemit/steem-js/issues)** - Bug reports and feature requests
 
-- Private keys are never logged or exposed
-- Uses cryptographically secure random number generation
-- All cryptographic operations use proper implementations
+## 📄 License
 
-## License
+MIT - see [LICENSE](LICENSE) file for details.
 
-MIT
+---
 
+> 💡 **Need help?** Check the [complete documentation](./docs/README.md) for detailed examples and API reference.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@steemit/steem-js",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Steem blockchain JavaScript/TypeScript library",
   "type": "module",
   "main": "dist/index.cjs",