mmn-client-js 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MezonAI Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# @mezon/mmn-client-js
+
+A TypeScript client for interacting with the MMN blockchain via JSON-RPC. It supports creating, signing, and submitting transactions, plus basic account and transaction queries.
+
+## Features
+
+- 🔐 Transaction signing (Ed25519)
+- 📝 Create and sign transactions
+- 🚀 JSON-RPC client for MMN
+- 📦 TypeScript with exported types
+- 🌐 Browser & Node.js compatible
+
+## Installation
+
+```bash
+npm install @mezonai/mmn-client-js
+```
+
+## Quick Start
+
+```typescript
+import { MmnClient } from '@mezonai/mmn-client-js';
+
+// Create a client instance
+const client = new MmnClient({
+  baseUrl: 'http://localhost:8080',
+  timeout: 30000
+});
+
+// Send a transaction
+const response = await client.sendTransaction({
+  sender: 'sender-address',
+  recipient: 'recipient-address',
+  amount: '1000000000000000000',
+  textData: 'Hello MMN!',
+  privateKey: 'private-key-hex'
+});
+
+if (response.ok) {
+  console.log('Transaction Hash:', response.tx_hash);
+} else {
+  console.error('Error:', response.error);
+}
+```
+
+## API Reference
+
+### Client Configuration
+
+```typescript
+interface MmnClientConfig {
+  baseUrl: string;                    // MMN JSON-RPC base URL
+  timeout?: number;                   // Request timeout in ms (default: 30000)
+  headers?: Record<string, string>;   // Additional headers
+  axiosConfig?: AxiosRequestConfig;   // Optional axios overrides
+}
+```
+
+### Transaction Signing
+
+The client signs transactions with Ed25519. Provide a 64‑byte secret key or a 32‑byte seed (as `Uint8Array` or string hex/base58).
+
+### Transaction Operations
+
+#### `sendTransaction(params): Promise<AddTxResponse>`
+Create, sign, and submit a transaction in one call.
+
+```typescript
+const response = await client.sendTransaction({
+  sender: 'sender-address',
+  recipient: 'recipient-address',
+  amount: '1000000000000000000',
+  nonce,
+  textData: 'Optional message',
+  extraInfo: 'Optional extra',
+  privateKey: new Uint8Array(/* 64-byte secretKey */)
+});
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Support
+
+For support, please open an issue on the [GitHub repository](https://github.com/mezonai/mmn/issues).

package/dist/index.d.ts

@@ -0,0 +1,206 @@
+import { AxiosRequestConfig } from 'axios';
+
+interface JsonRpcRequest {
+    jsonrpc: '2.0';
+    method: string;
+    params?: unknown;
+    id: string | number;
+}
+interface JsonRpcError {
+    code: number;
+    message: string;
+    data?: unknown;
+}
+interface JsonRpcResponse<T = unknown> {
+    jsonrpc: '2.0';
+    result?: T;
+    error?: JsonRpcError;
+    id: string | number;
+}
+interface IWallet {
+    address: string;
+    privateKey: string;
+    recoveryPhrase: string;
+}
+declare enum ETransferType {
+    GiveCoffee = "give_coffee",
+    TransferToken = "transfer_token",
+    UnlockItem = "unlock_item"
+}
+interface ExtraInfo {
+    type: ETransferType;
+    ItemId?: string;
+    ItemType?: string;
+    ClanId?: string;
+    UserSenderId: string;
+    UserSenderUsername: string;
+    UserReceiverId: string;
+    ChannelId?: string;
+    MessageRefId?: string;
+}
+interface TxMsg {
+    type: number;
+    sender: string;
+    recipient: string;
+    amount: string;
+    timestamp: number;
+    text_data: string;
+    nonce: number;
+    extra_info: string;
+}
+interface SignedTx {
+    tx_msg: TxMsg;
+    signature: string;
+}
+interface AddTxResponse {
+    ok: boolean;
+    tx_hash: string;
+    error: string;
+}
+interface GetCurrentNonceResponse {
+    address: string;
+    nonce: number;
+    tag: string;
+    error: string;
+}
+interface GetAccountByAddressResponse {
+    address: string;
+    balance: string;
+    nonce: number;
+    decimals: number;
+}
+interface MmnClientConfig {
+    baseUrl: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    axiosConfig?: AxiosRequestConfig;
+}
+interface Transaction {
+    chain_id: string;
+    hash: string;
+    nonce: number;
+    block_hash: string;
+    block_number: number;
+    block_timestamp: number;
+    transaction_index: number;
+    from_address: string;
+    to_address: string;
+    value: string;
+    gas: number;
+    gas_price: string;
+    data: string;
+    function_selector: string;
+    max_fee_per_gas: string;
+    max_priority_fee_per_gas: string;
+    max_fee_per_blob_gas?: string;
+    blob_versioned_hashes?: string[];
+    transaction_type: number;
+    r: string;
+    s: string;
+    v: string;
+    access_list_json?: string;
+    authorization_list_json?: string;
+    contract_address?: string;
+    gas_used?: number;
+    cumulative_gas_used?: number;
+    effective_gas_price?: string;
+    blob_gas_used?: number;
+    blob_gas_price?: string;
+    logs_bloom?: string;
+    status?: number;
+    transaction_timestamp: number;
+    text_data: string;
+}
+interface Meta {
+    chain_id: number;
+    address?: string;
+    signature?: string;
+    page: number;
+    limit?: number;
+    total_items?: number;
+    total_pages?: number;
+}
+interface WalletDetail {
+    address: string;
+    balance: string;
+    account_nonce: number;
+    last_balance_update: number;
+}
+interface WalletDetailResponse {
+    data: WalletDetail;
+}
+interface ListTransactionResponse {
+    meta: Meta;
+    data?: Transaction[];
+}
+interface TransactionDetailResponse {
+    data: {
+        transaction: Transaction;
+    };
+}
+interface IndexerClientConfig {
+    endpoint: string;
+    chainId: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+
+declare class IndexerClient {
+    private axiosInstance;
+    private endpoint;
+    private chainId;
+    constructor(config: IndexerClientConfig);
+    private makeRequest;
+    getTransactionByHash(hash: string): Promise<Transaction>;
+    getTransactionByWallet(wallet: string, page: number | undefined, limit: number | undefined, filter: number): Promise<ListTransactionResponse>;
+    getWalletDetail(wallet: string): Promise<WalletDetail>;
+}
+
+declare class MmnClient {
+    private config;
+    private axiosInstance;
+    private requestId;
+    constructor(config: MmnClientConfig);
+    private makeRequest;
+    private rawEd25519ToPkcs8Hex;
+    createWallet(): IWallet;
+    /**
+     * Create and sign a transaction message
+     */
+    private createAndSignTx;
+    /**
+     * Sign a transaction with Ed25519
+     */
+    private signTransaction;
+    /**
+     * Serialize transaction for signing
+     */
+    private serializeTransaction;
+    /**
+     * Add a signed transaction to the blockchain
+     */
+    private addTx;
+    /**
+     * Send a transaction (create, sign, and submit)
+     */
+    sendTransaction(params: {
+        sender: string;
+        recipient: string;
+        amount: string;
+        nonce: number;
+        timestamp?: number;
+        textData?: string;
+        extraInfo?: ExtraInfo;
+        privateKey: string;
+    }): Promise<AddTxResponse>;
+    /**
+     * Get current nonce for an account
+     */
+    getCurrentNonce(address: string, tag?: 'latest' | 'pending'): Promise<GetCurrentNonceResponse>;
+    getAccountByAddress(address: string): Promise<GetAccountByAddressResponse>;
+    scaleAmountToDecimals(originalAmount: string | number, decimals: number): string;
+}
+declare function createMmnClient(config: MmnClientConfig): MmnClient;
+
+export { ETransferType, IndexerClient, MmnClient, createMmnClient };
+export type { AddTxResponse, ExtraInfo, GetAccountByAddressResponse, GetCurrentNonceResponse, IWallet, IndexerClientConfig, JsonRpcError, JsonRpcRequest, JsonRpcResponse, ListTransactionResponse, Meta, MmnClientConfig, SignedTx, Transaction, TransactionDetailResponse, TxMsg, WalletDetail, WalletDetailResponse };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC"}