@spirobel/monero-wallet-api 0.1.2 → 0.3.0

package/dist/node-interaction/jsonEndpoints.d.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import type { SignedTransaction } from "../send-functionality/transactionBuilding";
 export declare const GetInfoResponseSchema: z.ZodObject<{
     id: z.ZodString;
     jsonrpc: z.ZodLiteral<"2.0">;
@@ -46,196 +47,39 @@ export declare const GetInfoResponseSchema: z.ZodObject<{
         white_peerlist_size: z.ZodNumber;
         wide_cumulative_difficulty: z.ZodString;
         wide_difficulty: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        status: string;
-        adjusted_time: number;
-        alt_blocks_count: number;
-        block_size_limit: number;
-        block_size_median: number;
-        block_weight_limit: number;
-        block_weight_median: number;
-        bootstrap_daemon_address: string;
-        busy_syncing: boolean;
-        credits: number;
-        cumulative_difficulty: number;
-        cumulative_difficulty_top64: number;
-        database_size: number;
-        difficulty: number;
-        difficulty_top64: number;
-        free_space: number;
-        grey_peerlist_size: number;
-        height: number;
-        height_without_bootstrap: number;
-        incoming_connections_count: number;
-        mainnet: boolean;
-        nettype: string;
-        offline: boolean;
-        outgoing_connections_count: number;
-        restricted: boolean;
-        rpc_connections_count: number;
-        stagenet: boolean;
-        start_time: number;
-        synchronized: boolean;
-        target: number;
-        target_height: number;
-        testnet: boolean;
-        top_block_hash: string;
-        top_hash: string;
-        tx_count: number;
-        tx_pool_size: number;
-        untrusted: boolean;
-        update_available: boolean;
-        version: string;
-        was_bootstrap_ever_used: boolean;
-        white_peerlist_size: number;
-        wide_cumulative_difficulty: string;
-        wide_difficulty: string;
-    }, {
-        status: string;
-        adjusted_time: number;
-        alt_blocks_count: number;
-        block_size_limit: number;
-        block_size_median: number;
-        block_weight_limit: number;
-        block_weight_median: number;
-        bootstrap_daemon_address: string;
-        busy_syncing: boolean;
-        credits: number;
-        cumulative_difficulty: number;
-        cumulative_difficulty_top64: number;
-        database_size: number;
-        difficulty: number;
-        difficulty_top64: number;
-        free_space: number;
-        grey_peerlist_size: number;
-        height: number;
-        height_without_bootstrap: number;
-        incoming_connections_count: number;
-        mainnet: boolean;
-        nettype: string;
-        offline: boolean;
-        outgoing_connections_count: number;
-        restricted: boolean;
-        rpc_connections_count: number;
-        stagenet: boolean;
-        start_time: number;
-        synchronized: boolean;
-        target: number;
-        target_height: number;
-        testnet: boolean;
-        top_block_hash: string;
-        top_hash: string;
-        tx_count: number;
-        tx_pool_size: number;
-        untrusted: boolean;
-        update_available: boolean;
-        version: string;
-        was_bootstrap_ever_used: boolean;
-        white_peerlist_size: number;
-        wide_cumulative_difficulty: string;
-        wide_difficulty: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    jsonrpc: "2.0";
-    result: {
-        status: string;
-        adjusted_time: number;
-        alt_blocks_count: number;
-        block_size_limit: number;
-        block_size_median: number;
-        block_weight_limit: number;
-        block_weight_median: number;
-        bootstrap_daemon_address: string;
-        busy_syncing: boolean;
-        credits: number;
-        cumulative_difficulty: number;
-        cumulative_difficulty_top64: number;
-        database_size: number;
-        difficulty: number;
-        difficulty_top64: number;
-        free_space: number;
-        grey_peerlist_size: number;
-        height: number;
-        height_without_bootstrap: number;
-        incoming_connections_count: number;
-        mainnet: boolean;
-        nettype: string;
-        offline: boolean;
-        outgoing_connections_count: number;
-        restricted: boolean;
-        rpc_connections_count: number;
-        stagenet: boolean;
-        start_time: number;
-        synchronized: boolean;
-        target: number;
-        target_height: number;
-        testnet: boolean;
-        top_block_hash: string;
-        top_hash: string;
-        tx_count: number;
-        tx_pool_size: number;
-        untrusted: boolean;
-        update_available: boolean;
-        version: string;
-        was_bootstrap_ever_used: boolean;
-        white_peerlist_size: number;
-        wide_cumulative_difficulty: string;
-        wide_difficulty: string;
-    };
-}, {
-    id: string;
-    jsonrpc: "2.0";
-    result: {
-        status: string;
-        adjusted_time: number;
-        alt_blocks_count: number;
-        block_size_limit: number;
-        block_size_median: number;
-        block_weight_limit: number;
-        block_weight_median: number;
-        bootstrap_daemon_address: string;
-        busy_syncing: boolean;
-        credits: number;
-        cumulative_difficulty: number;
-        cumulative_difficulty_top64: number;
-        database_size: number;
-        difficulty: number;
-        difficulty_top64: number;
-        free_space: number;
-        grey_peerlist_size: number;
-        height: number;
-        height_without_bootstrap: number;
-        incoming_connections_count: number;
-        mainnet: boolean;
-        nettype: string;
-        offline: boolean;
-        outgoing_connections_count: number;
-        restricted: boolean;
-        rpc_connections_count: number;
-        stagenet: boolean;
-        start_time: number;
-        synchronized: boolean;
-        target: number;
-        target_height: number;
-        testnet: boolean;
-        top_block_hash: string;
-        top_hash: string;
-        tx_count: number;
-        tx_pool_size: number;
-        untrusted: boolean;
-        update_available: boolean;
-        version: string;
-        was_bootstrap_ever_used: boolean;
-        white_peerlist_size: number;
-        wide_cumulative_difficulty: string;
-        wide_difficulty: string;
-    };
-}>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 export type GetInfoResponse = z.infer<typeof GetInfoResponseSchema>;
+/**
+ * Response schema for the get_output_distribution method.
+ *
+ * @property id - The request ID.
+ * @property jsonrpc - The JSON-RPC version.
+ * @property result - The result object containing:
+ *   - distributions: An array of distribution objects, each with:
+ *     - amount: unsigned int Same as in the request. Use 0 to get all RingCT outputs.
+ *     - base: unsigned int; The total number of outputs of amount in the chain before, not including, the block at start_height.
+ *     - distribution: array of unsigned int
+ *     - start_height:  unsigned int; Note that this is not necessarily equal to from_height, especially for amount=0 where start_height will be no less than the height of the v4 hardfork.
+ *   - status: string; General RPC error code. "OK" means everything looks good.
+ */
+export declare const GetOutputDistributionResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    jsonrpc: z.ZodLiteral<"2.0">;
+    result: z.ZodObject<{
+        distributions: z.ZodArray<z.ZodObject<{
+            amount: z.ZodNumber;
+            base: z.ZodNumber;
+            distribution: z.ZodArray<z.ZodNumber>;
+            start_height: z.ZodNumber;
+        }, z.core.$strip>>;
+        status: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type GetOutputDistributionResponse = z.infer<typeof GetOutputDistributionResponseSchema>;
+export declare function parseGetOutputDistributionResponse(data: unknown): GetOutputDistributionResponse | null;
 export declare function parseGetInfoResponse(data: unknown): GetInfoResponse | null;
 export declare function get_info(NODE_URL: string): Promise<{
-    status: string;
     adjusted_time: number;
     alt_blocks_count: number;
     block_size_limit: number;
@@ -263,6 +107,7 @@ export declare function get_info(NODE_URL: string): Promise<{
     rpc_connections_count: number;
     stagenet: boolean;
     start_time: number;
+    status: string;
     synchronized: boolean;
     target: number;
     target_height: number;
@@ -279,3 +124,220 @@ export declare function get_info(NODE_URL: string): Promise<{
     wide_cumulative_difficulty: string;
     wide_difficulty: string;
 }>;
+/**
+ * Parameters for retrieving output distribution information.
+ *
+ * @property amounts - Array of unsigned integers representing cleartext amounts to look for.
+ *   Use 0 to get all RingCT outputs. defaults to [0].
+ * @property cumulative - (Optional) If true, the result will be cumulative. Defaults to false.
+ * @property from_height - (Optional) Starting block height (inclusive) to check from. Defaults to 0.
+ * @property to_height - (Optional) Ending block height (inclusive) to check up to. Set to 0 to get the entire chain after from_height. Defaults to 0.
+ * @property binary - boolean; for disabling epee encoding, defaults to false.
+ * @property compress - (Optional) If true, enables compression. Ignored if binary is set to false.
+ */
+export type GetOutputDistributionParams = {
+    amounts?: number[];
+    cumulative?: boolean;
+    from_height?: number;
+    to_height?: number;
+    binary?: boolean;
+    compress?: boolean;
+};
+export declare function get_output_distribution(NODE_URL: string, params?: GetOutputDistributionParams): Promise<{
+    distributions: {
+        amount: number;
+        base: number;
+        distribution: number[];
+        start_height: number;
+    }[];
+    status: string;
+}>;
+/**
+ * Response schema for the get_fee_estimate method.
+ *
+ * @property id - The request ID.
+ * @property jsonrpc - The JSON-RPC version.
+ * @property result - The result object containing:
+ *   - status: string; General RPC error code. "OK" means everything looks good.
+ *   - fee: unsigned int; Base fee per byte.
+ *   - fees: (Optional) Array of unsigned int; Fee estimates for priorities 1–4.
+ *   - quantization_mask: unsigned int; Mask used for fee rounding.
+ */
+export declare const GetFeeEstimateResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    jsonrpc: z.ZodLiteral<"2.0">;
+    result: z.ZodObject<{
+        status: z.ZodString;
+        fee: z.ZodNumber;
+        fees: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        quantization_mask: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type GetFeeEstimateResponse = z.infer<typeof GetFeeEstimateResponseSchema>;
+export declare function parseGetFeeEstimateResponse(data: unknown): GetFeeEstimateResponse | null;
+export type GetFeeEstimateResult = {
+    status: string;
+    fee: number;
+    fees?: number[];
+    quantization_mask: number;
+};
+export type FeeEstimateResponse = {
+    status: string;
+    fee: number;
+    quantization_mask: number;
+    fees?: number[] | undefined;
+};
+export declare function get_fee_estimate(NODE_URL: string): Promise<FeeEstimateResponse>;
+export declare const SendRawTransactionResponseSchema: z.ZodObject<{
+    double_spend: z.ZodBoolean;
+    fee_too_low: z.ZodBoolean;
+    invalid_input: z.ZodBoolean;
+    invalid_output: z.ZodBoolean;
+    low_mixin: z.ZodBoolean;
+    not_rct: z.ZodOptional<z.ZodBoolean>;
+    not_relayed: z.ZodBoolean;
+    overspend: z.ZodBoolean;
+    reason: z.ZodString;
+    status: z.ZodString;
+    too_big: z.ZodBoolean;
+    untrusted: z.ZodBoolean;
+}, z.core.$strip>;
+export type SendRawTransactionResponse = z.infer<typeof SendRawTransactionResponseSchema>;
+export declare function parseSendRawTransactionResponse(data: unknown): SendRawTransactionResponse | null;
+export type SendRawTransactionResult = {
+    double_spend: boolean;
+    fee_too_low: boolean;
+    invalid_input: boolean;
+    invalid_output: boolean;
+    low_mixin: boolean;
+    not_relayed: boolean;
+    overspend: boolean;
+    reason: string;
+    status: string;
+    too_big: boolean;
+    untrusted: boolean;
+    not_rct?: boolean | undefined;
+};
+export declare function send_raw_transaction(NODE_URL: string, tx_as_hex: SignedTransaction, // tx_as_hex - string; Full transaction information as hexadecimal string.
+do_not_relay?: boolean): Promise<SendRawTransactionResult>;
+/**
+ * Response schema for the get_block_headers_range method.
+ *
+ * @property id - The request ID.
+ * @property jsonrpc - The JSON-RPC version.
+ * @property result - The result object containing:
+ * - credits: unsigned int; If payment for RPC is enabled, the number of credits available to the requesting client. Otherwise, 0.
+ * - headers: array of block_header objects, each with:
+ *   - block_size: unsigned int
+ *   - block_weight: unsigned int
+ *   - cumulative_difficulty: unsigned int
+ *   - cumulative_difficulty_top64: unsigned int
+ *   - depth: unsigned int
+ *   - difficulty: unsigned int
+ *   - difficulty_top64: unsigned int
+ *   - hash: string
+ *   - height: unsigned int
+ *   - long_term_weight: unsigned int
+ *   - major_version: unsigned int
+ *   - miner_tx_hash: string
+ *   - minor_version: unsigned int
+ *   - nonce: unsigned int
+ *   - num_txes: unsigned int
+ *   - orphan_status: boolean
+ *   - pow_hash: string (if fill_pow_hash is true)
+ *   - prev_hash: string
+ *   - reward: unsigned int
+ *   - timestamp: unsigned int
+ *   - wide_cumulative_difficulty: string
+ *   - wide_difficulty: string
+ * - status: string; General RPC error code. "OK" means everything looks good.
+ * - top_hash: string; If payment for RPC is enabled, the hash of the highest block in the chain. Otherwise, empty.
+ * - untrusted: boolean; States if the result is obtained using the bootstrap mode (true) or not (false).
+ * @property error - Optional error object if the request failed:
+ * - code: int; Error code.
+ * - message: string; Error message.
+ */
+export declare const GetBlockHeadersRangeResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    jsonrpc: z.ZodLiteral<"2.0">;
+    result: z.ZodOptional<z.ZodObject<{
+        credits: z.ZodNumber;
+        headers: z.ZodArray<z.ZodObject<{
+            block_size: z.ZodNumber;
+            block_weight: z.ZodNumber;
+            cumulative_difficulty: z.ZodNumber;
+            cumulative_difficulty_top64: z.ZodNumber;
+            depth: z.ZodNumber;
+            difficulty: z.ZodNumber;
+            difficulty_top64: z.ZodNumber;
+            hash: z.ZodString;
+            height: z.ZodNumber;
+            long_term_weight: z.ZodNumber;
+            major_version: z.ZodNumber;
+            miner_tx_hash: z.ZodString;
+            minor_version: z.ZodNumber;
+            nonce: z.ZodNumber;
+            num_txes: z.ZodNumber;
+            orphan_status: z.ZodBoolean;
+            pow_hash: z.ZodString;
+            prev_hash: z.ZodString;
+            reward: z.ZodNumber;
+            timestamp: z.ZodNumber;
+            wide_cumulative_difficulty: z.ZodString;
+            wide_difficulty: z.ZodString;
+        }, z.core.$strip>>;
+        status: z.ZodString;
+        top_hash: z.ZodString;
+        untrusted: z.ZodBoolean;
+    }, z.core.$strip>>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodNumber;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type GetBlockHeadersRangeResponse = z.infer<typeof GetBlockHeadersRangeResponseSchema>;
+export type GetBlockHeadersRange = {
+    status: string;
+    credits: number;
+    headers: {
+        block_size: number;
+        block_weight: number;
+        cumulative_difficulty: number;
+        cumulative_difficulty_top64: number;
+        depth: number;
+        difficulty: number;
+        difficulty_top64: number;
+        hash: string;
+        height: number;
+        long_term_weight: number;
+        major_version: number;
+        miner_tx_hash: string;
+        minor_version: number;
+        nonce: number;
+        num_txes: number;
+        orphan_status: boolean;
+        pow_hash: string;
+        prev_hash: string;
+        reward: number;
+        timestamp: number;
+        wide_cumulative_difficulty: string;
+        wide_difficulty: string;
+    }[];
+    top_hash: string;
+    untrusted: boolean;
+};
+export declare function parseGetBlockHeadersRangeResponse(data: unknown): GetBlockHeadersRangeResponse | null;
+/**
+ * Parameters for retrieving block headers in a range.
+ *
+ * @property start_height - unsigned int; The starting block's height.
+ * @property end_height - unsigned int; The ending block's height.
+ * @property fill_pow_hash - (Optional) boolean; Add PoW hash to block_header response. Defaults to false.
+ */
+export type GetBlockHeadersRangeParams = {
+    start_height: number;
+    end_height: number;
+    fill_pow_hash?: boolean;
+};
+export declare const RESTRICTED_BLOCK_HEADER_RANGE = 1000;
+export declare function get_block_headers_range(NODE_URL: string, params: GetBlockHeadersRangeParams): Promise<GetBlockHeadersRange>;