mirror of
https://github.com/alexgo-io/electrum-client.git
synced 2026-01-12 16:53:05 +08:00
feat: remove esmodule type
This commit is contained in:
xin
760
src/index.ts
760
src/index.ts
@@ -1,377 +1,395 @@
|
||||
import { Client } from "./lib/client.js";
|
||||
import type {
|
||||
Callbacks,
|
||||
CreateClientParams,
|
||||
ElectrumConfig,
|
||||
ElectrumRequestBatchParams,
|
||||
ElectrumRequestParams,
|
||||
PersistencePolicy,
|
||||
Protocol,
|
||||
Callbacks,
|
||||
CreateClientParams,
|
||||
ElectrumConfig,
|
||||
ElectrumRequestBatchParams,
|
||||
ElectrumRequestParams,
|
||||
PersistencePolicy,
|
||||
Protocol,
|
||||
} from "./types";
|
||||
import type { TransactionVerbose } from "./types/TransactionVerbose.js";
|
||||
import type { MempoolTransaction } from "./types/mempoolTransaction.js";
|
||||
|
||||
export class ElectrumClient extends Client {
|
||||
private readonly onConnectCallback:
|
||||
| ((client: ElectrumClient, versionInfo: [string, string]) => void)
|
||||
| null;
|
||||
private readonly onCloseCallback: ((client: ElectrumClient) => void) | null;
|
||||
private readonly onLogCallback: (str: string) => void;
|
||||
private timeLastCall: number;
|
||||
private persistencePolicy: Required<PersistencePolicy>;
|
||||
private electrumConfig: ElectrumConfig | null;
|
||||
private pingInterval: NodeJS.Timeout | null;
|
||||
versionInfo: [string, string];
|
||||
|
||||
/**
|
||||
* Constructs an instance of ElectrumClient.
|
||||
*
|
||||
* @param {number} port - The port number to connect to.
|
||||
* @param {string} host - The host address to connect to.
|
||||
* @param {Protocol} protocol - The protocol to use for the connection.
|
||||
* @param {Callbacks} [callbacks] - Optional callbacks for connection events.
|
||||
*/
|
||||
constructor(
|
||||
port: number,
|
||||
host: string,
|
||||
protocol: Protocol,
|
||||
callbacks?: Callbacks,
|
||||
) {
|
||||
super(port, host, protocol, callbacks);
|
||||
|
||||
this.onConnectCallback = callbacks?.onConnect ?? null;
|
||||
this.onCloseCallback = callbacks?.onClose ?? null;
|
||||
this.onLogCallback = callbacks?.onLog
|
||||
? callbacks.onLog
|
||||
: (str: string) => {
|
||||
console.log(str);
|
||||
};
|
||||
|
||||
this.timeLastCall = 0;
|
||||
|
||||
this.persistencePolicy = {
|
||||
retryPeriod: 10000,
|
||||
maxRetry: 1000,
|
||||
pingPeriod: 120000,
|
||||
callback: null,
|
||||
};
|
||||
this.electrumConfig = null;
|
||||
this.pingInterval = null;
|
||||
this.versionInfo = ["", ""];
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an instance of ElectrumClient and initializes it with the provided configuration.
|
||||
*
|
||||
* @param {CreateClientParams} params - The parameters required to create and initialize the client.
|
||||
* @param {number} params.port - The port number to connect to.
|
||||
* @param {string} params.host - The host address to connect to.
|
||||
* @param {Protocol} params.protocol - The protocol to use for the connection.
|
||||
* @param {Callbacks} [params.callbacks] - Optional callbacks for connection events.
|
||||
* @param {ElectrumConfig} params.electrumConfig - The Electrum configuration to use.
|
||||
* @param {PersistencePolicy} [params.persistencePolicy] - Optional persistence policy for the client.
|
||||
*
|
||||
* @returns {Promise<ElectrumClient>} A promise that resolves to an initialized ElectrumClient instance.
|
||||
*/
|
||||
static createClient(params: CreateClientParams): Promise<ElectrumClient> {
|
||||
const client = new ElectrumClient(
|
||||
params.port,
|
||||
params.host,
|
||||
params.protocol,
|
||||
params.callbacks,
|
||||
);
|
||||
|
||||
return client.initElectrum(params.electrumConfig, params.persistencePolicy);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the Electrum client with the provided configuration and persistence policy.
|
||||
*
|
||||
* @param {ElectrumConfig} electrumConfig - The Electrum configuration to use.
|
||||
* @param {PersistencePolicy} [persistencePolicy] - Optional persistence policy for the client.
|
||||
* @returns {Promise<ElectrumClient>} A promise that resolves to the initialized ElectrumClient instance.
|
||||
*/
|
||||
async initElectrum(
|
||||
electrumConfig: ElectrumConfig,
|
||||
persistencePolicy?: PersistencePolicy,
|
||||
): Promise<ElectrumClient> {
|
||||
this.persistencePolicy = {
|
||||
...this.persistencePolicy,
|
||||
...persistencePolicy,
|
||||
};
|
||||
this.electrumConfig = electrumConfig;
|
||||
this.timeLastCall = 0;
|
||||
|
||||
await this.connect();
|
||||
|
||||
this.versionInfo = (await this.server_version(
|
||||
electrumConfig.client,
|
||||
electrumConfig.version,
|
||||
)) as [string, string];
|
||||
|
||||
if (this.onConnectCallback != null) {
|
||||
this.onConnectCallback(this, this.versionInfo);
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
protected async request<T>(method: string, params: ElectrumRequestParams<T>) {
|
||||
this.timeLastCall = Date.now();
|
||||
|
||||
const response = await super.request<T>(method, params);
|
||||
|
||||
this.keepAlive();
|
||||
|
||||
return response;
|
||||
}
|
||||
|
||||
protected async requestBatch<T>(
|
||||
method: string,
|
||||
params: ElectrumRequestParams<T>,
|
||||
secondParam?: ElectrumRequestBatchParams,
|
||||
) {
|
||||
this.timeLastCall = Date.now();
|
||||
|
||||
const response = await super.requestBatch<T>(method, params, secondParam);
|
||||
|
||||
this.keepAlive();
|
||||
|
||||
return response;
|
||||
}
|
||||
|
||||
protected onClose(): void {
|
||||
super.onClose();
|
||||
|
||||
const list = [
|
||||
"server.peers.subscribe",
|
||||
"blockchain.numblocks.subscribe",
|
||||
"blockchain.headers.subscribe",
|
||||
"blockchain.address.subscribe",
|
||||
];
|
||||
|
||||
for (const event of list) this.subscribe.removeAllListeners(event);
|
||||
|
||||
let retryPeriod = 10000;
|
||||
if (this.persistencePolicy.retryPeriod > 0) {
|
||||
retryPeriod = this.persistencePolicy.retryPeriod;
|
||||
}
|
||||
|
||||
if (this.onCloseCallback != null) {
|
||||
this.onCloseCallback(this);
|
||||
}
|
||||
|
||||
setTimeout(() => {
|
||||
if (this.persistencePolicy.maxRetry > 0) {
|
||||
this.reconnect().catch((error) => {
|
||||
this.onError(error);
|
||||
});
|
||||
|
||||
this.persistencePolicy.maxRetry -= 1;
|
||||
} else if (this.persistencePolicy.callback != null) {
|
||||
this.persistencePolicy.callback();
|
||||
}
|
||||
}, retryPeriod);
|
||||
}
|
||||
|
||||
private keepAlive(): void {
|
||||
if (this.pingInterval != null) {
|
||||
clearInterval(this.pingInterval);
|
||||
}
|
||||
|
||||
let pingPeriod = 120000;
|
||||
if (this.persistencePolicy.pingPeriod > 0) {
|
||||
pingPeriod = this.persistencePolicy.pingPeriod;
|
||||
}
|
||||
|
||||
this.pingInterval = setInterval(() => {
|
||||
if (
|
||||
this.timeLastCall !== 0 &&
|
||||
Date.now() > this.timeLastCall + pingPeriod
|
||||
) {
|
||||
this.server_ping().catch((error) => {
|
||||
this.log(`Keep-Alive ping failed: ${error}`);
|
||||
});
|
||||
}
|
||||
}, pingPeriod);
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the Electrum client connection and stops the keep-alive ping interval.
|
||||
*
|
||||
* @returns {void}
|
||||
*/
|
||||
close(): void {
|
||||
super.close();
|
||||
|
||||
if (this.pingInterval != null) {
|
||||
clearInterval(this.pingInterval);
|
||||
}
|
||||
|
||||
this.reconnect =
|
||||
this.reconnect =
|
||||
this.onClose =
|
||||
this.keepAlive =
|
||||
() => Promise.resolve(this); // dirty hack to make it stop reconnecting
|
||||
}
|
||||
|
||||
private reconnect(): Promise<ElectrumClient> {
|
||||
this.log("Electrum attempting reconnect...");
|
||||
|
||||
this.initSocket();
|
||||
|
||||
return this.persistencePolicy == null
|
||||
? // biome-ignore lint/style/noNonNullAssertion:
|
||||
this.initElectrum(this.electrumConfig!)
|
||||
: // biome-ignore lint/style/noNonNullAssertion:
|
||||
this.initElectrum(this.electrumConfig!, this.persistencePolicy);
|
||||
}
|
||||
|
||||
private log(str: string): void {
|
||||
this.onLogCallback(str);
|
||||
}
|
||||
|
||||
// ElectrumX API
|
||||
server_version(
|
||||
client_name: string,
|
||||
protocol_version: string | [string, string],
|
||||
) {
|
||||
return this.request("server.version", [client_name, protocol_version]);
|
||||
}
|
||||
|
||||
server_banner() {
|
||||
return this.request("server.banner", []);
|
||||
}
|
||||
|
||||
server_features() {
|
||||
return this.request("server.features", []);
|
||||
}
|
||||
|
||||
server_ping() {
|
||||
return this.request("server.ping", []);
|
||||
}
|
||||
|
||||
server_addPeer(features: any) {
|
||||
return this.request("server.add_peer", [features]);
|
||||
}
|
||||
|
||||
serverDonation_address() {
|
||||
return this.request("server.donation_address", []);
|
||||
}
|
||||
|
||||
serverPeers_subscribe() {
|
||||
return this.request("server.peers.subscribe", []);
|
||||
}
|
||||
|
||||
blockchainAddress_getProof(address: string) {
|
||||
return this.request("blockchain.address.get_proof", [address]);
|
||||
}
|
||||
|
||||
blockchainScripthash_getBalance(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.get_balance", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_getBalanceBatch(scripthashes: string[]) {
|
||||
return this.requestBatch("blockchain.scripthash.get_balance", scripthashes);
|
||||
}
|
||||
|
||||
blockchainScripthash_listunspentBatch(scripthashes: string[]) {
|
||||
return this.requestBatch("blockchain.scripthash.listunspent", scripthashes);
|
||||
}
|
||||
|
||||
blockchainScripthash_getHistory(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.get_history", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_getHistoryBatch(scripthashes: string[]) {
|
||||
return this.requestBatch("blockchain.scripthash.get_history", scripthashes);
|
||||
}
|
||||
|
||||
blockchainScripthash_getMempool(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.get_mempool", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_listunspent(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.listunspent", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_subscribe(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.subscribe", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainBlock_getHeader(height: number) {
|
||||
return this.request("blockchain.block.get_header", [height]);
|
||||
}
|
||||
|
||||
blockchainBlock_headers(start_height: number, count: number) {
|
||||
return this.request("blockchain.block.headers", [start_height, count]);
|
||||
}
|
||||
|
||||
blockchainEstimatefee(number: number) {
|
||||
return this.request("blockchain.estimatefee", [number]);
|
||||
}
|
||||
|
||||
blockchainHeaders_subscribe() {
|
||||
return this.request("blockchain.headers.subscribe", []);
|
||||
}
|
||||
|
||||
blockchain_relayfee() {
|
||||
return this.request("blockchain.relayfee", []);
|
||||
}
|
||||
|
||||
blockchainTransaction_broadcast(rawtx: string) {
|
||||
return this.request("blockchain.transaction.broadcast", [rawtx]);
|
||||
}
|
||||
|
||||
blockchainTransaction_get(tx_hash: string, verbose = false) {
|
||||
return this.request("blockchain.transaction.get", [tx_hash, verbose]);
|
||||
}
|
||||
|
||||
blockchainTransaction_getBatch(tx_hashes: string[], verbose = false) {
|
||||
return this.requestBatch("blockchain.transaction.get", tx_hashes, verbose);
|
||||
}
|
||||
|
||||
blockchainTransaction_getMerkle(tx_hash: string, height: number) {
|
||||
return this.request("blockchain.transaction.get_merkle", [tx_hash, height]);
|
||||
}
|
||||
|
||||
mempool_getFeeHistogram() {
|
||||
return this.request("mempool.get_fee_histogram", []);
|
||||
}
|
||||
|
||||
// ---------------------------------
|
||||
// protocol 1.1 deprecated method
|
||||
// ---------------------------------
|
||||
blockchainUtxo_getAddress(tx_hash: string, index: number) {
|
||||
return this.request("blockchain.utxo.get_address", [tx_hash, index]);
|
||||
}
|
||||
|
||||
blockchainNumblocks_subscribe() {
|
||||
return this.request("blockchain.numblocks.subscribe", []);
|
||||
}
|
||||
|
||||
// ---------------------------------
|
||||
// protocol 1.2 deprecated method
|
||||
// ---------------------------------
|
||||
blockchainBlock_getChunk(index: number) {
|
||||
return this.request("blockchain.block.get_chunk", [index]);
|
||||
}
|
||||
|
||||
blockchainAddress_getBalance(address: string) {
|
||||
return this.request("blockchain.address.get_balance", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_getHistory(address: string) {
|
||||
return this.request("blockchain.address.get_history", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_getMempool(address: string) {
|
||||
return this.request("blockchain.address.get_mempool", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_listunspent(address: string) {
|
||||
return this.request("blockchain.address.listunspent", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_subscribe(address: string) {
|
||||
return this.request("blockchain.address.subscribe", [address]);
|
||||
}
|
||||
private readonly onConnectCallback:
|
||||
| ((client: ElectrumClient, versionInfo: [string, string]) => void)
|
||||
| null;
|
||||
private readonly onCloseCallback: ((client: ElectrumClient) => void) | null;
|
||||
private readonly onLogCallback: (str: string) => void;
|
||||
private timeLastCall: number;
|
||||
private persistencePolicy: Required<PersistencePolicy>;
|
||||
private electrumConfig: ElectrumConfig | null;
|
||||
private pingInterval: NodeJS.Timeout | null;
|
||||
versionInfo: [string, string];
|
||||
|
||||
/**
|
||||
* Constructs an instance of ElectrumClient.
|
||||
*
|
||||
* @param {number} port - The port number to connect to.
|
||||
* @param {string} host - The host address to connect to.
|
||||
* @param {Protocol} protocol - The protocol to use for the connection.
|
||||
* @param {Callbacks} [callbacks] - Optional callbacks for connection events.
|
||||
*/
|
||||
constructor(
|
||||
port: number,
|
||||
host: string,
|
||||
protocol: Protocol,
|
||||
callbacks?: Callbacks
|
||||
) {
|
||||
super(port, host, protocol, callbacks);
|
||||
|
||||
this.onConnectCallback = callbacks?.onConnect ?? null;
|
||||
this.onCloseCallback = callbacks?.onClose ?? null;
|
||||
this.onLogCallback = callbacks?.onLog
|
||||
? callbacks.onLog
|
||||
: (str: string) => {
|
||||
console.log(str);
|
||||
};
|
||||
|
||||
this.timeLastCall = 0;
|
||||
|
||||
this.persistencePolicy = {
|
||||
retryPeriod: 10000,
|
||||
maxRetry: 1000,
|
||||
pingPeriod: 120000,
|
||||
callback: null,
|
||||
};
|
||||
this.electrumConfig = null;
|
||||
this.pingInterval = null;
|
||||
this.versionInfo = ["", ""];
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an instance of ElectrumClient and initializes it with the provided configuration.
|
||||
*
|
||||
* @param {CreateClientParams} params - The parameters required to create and initialize the client.
|
||||
* @param {number} params.port - The port number to connect to.
|
||||
* @param {string} params.host - The host address to connect to.
|
||||
* @param {Protocol} params.protocol - The protocol to use for the connection.
|
||||
* @param {Callbacks} [params.callbacks] - Optional callbacks for connection events.
|
||||
* @param {ElectrumConfig} params.electrumConfig - The Electrum configuration to use.
|
||||
* @param {PersistencePolicy} [params.persistencePolicy] - Optional persistence policy for the client.
|
||||
*
|
||||
* @returns {Promise<ElectrumClient>} A promise that resolves to an initialized ElectrumClient instance.
|
||||
*/
|
||||
static createClient(params: CreateClientParams): Promise<ElectrumClient> {
|
||||
const client = new ElectrumClient(
|
||||
params.port,
|
||||
params.host,
|
||||
params.protocol,
|
||||
params.callbacks
|
||||
);
|
||||
|
||||
return client.initElectrum(params.electrumConfig, params.persistencePolicy);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes the Electrum client with the provided configuration and persistence policy.
|
||||
*
|
||||
* @param {ElectrumConfig} electrumConfig - The Electrum configuration to use.
|
||||
* @param {PersistencePolicy} [persistencePolicy] - Optional persistence policy for the client.
|
||||
* @returns {Promise<ElectrumClient>} A promise that resolves to the initialized ElectrumClient instance.
|
||||
*/
|
||||
async initElectrum(
|
||||
electrumConfig: ElectrumConfig,
|
||||
persistencePolicy?: PersistencePolicy
|
||||
): Promise<ElectrumClient> {
|
||||
this.persistencePolicy = {
|
||||
...this.persistencePolicy,
|
||||
...persistencePolicy,
|
||||
};
|
||||
this.electrumConfig = electrumConfig;
|
||||
this.timeLastCall = 0;
|
||||
|
||||
await this.connect();
|
||||
|
||||
this.versionInfo = (await this.server_version(
|
||||
electrumConfig.client,
|
||||
electrumConfig.version
|
||||
)) as [string, string];
|
||||
|
||||
if (this.onConnectCallback != null) {
|
||||
this.onConnectCallback(this, this.versionInfo);
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
protected async request<T>(method: string, params: ElectrumRequestParams<T>) {
|
||||
this.timeLastCall = Date.now();
|
||||
|
||||
const response = await super.request<T>(method, params);
|
||||
|
||||
this.keepAlive();
|
||||
|
||||
return response;
|
||||
}
|
||||
|
||||
protected async requestBatch<T>(
|
||||
method: string,
|
||||
params: ElectrumRequestParams<T>,
|
||||
secondParam?: ElectrumRequestBatchParams
|
||||
) {
|
||||
this.timeLastCall = Date.now();
|
||||
|
||||
const response = await super.requestBatch<T>(method, params, secondParam);
|
||||
|
||||
this.keepAlive();
|
||||
|
||||
return response;
|
||||
}
|
||||
|
||||
protected onClose(): void {
|
||||
super.onClose();
|
||||
|
||||
const list = [
|
||||
"server.peers.subscribe",
|
||||
"blockchain.numblocks.subscribe",
|
||||
"blockchain.headers.subscribe",
|
||||
"blockchain.address.subscribe",
|
||||
];
|
||||
|
||||
for (const event of list) this.subscribe.removeAllListeners(event);
|
||||
|
||||
let retryPeriod = 10000;
|
||||
if (this.persistencePolicy.retryPeriod > 0) {
|
||||
retryPeriod = this.persistencePolicy.retryPeriod;
|
||||
}
|
||||
|
||||
if (this.onCloseCallback != null) {
|
||||
this.onCloseCallback(this);
|
||||
}
|
||||
|
||||
setTimeout(() => {
|
||||
if (this.persistencePolicy.maxRetry > 0) {
|
||||
this.reconnect().catch((error) => {
|
||||
this.onError(error);
|
||||
});
|
||||
|
||||
this.persistencePolicy.maxRetry -= 1;
|
||||
} else if (this.persistencePolicy.callback != null) {
|
||||
this.persistencePolicy.callback();
|
||||
}
|
||||
}, retryPeriod);
|
||||
}
|
||||
|
||||
private keepAlive(): void {
|
||||
if (this.pingInterval != null) {
|
||||
clearInterval(this.pingInterval);
|
||||
}
|
||||
|
||||
let pingPeriod = 120000;
|
||||
if (this.persistencePolicy.pingPeriod > 0) {
|
||||
pingPeriod = this.persistencePolicy.pingPeriod;
|
||||
}
|
||||
|
||||
this.pingInterval = setInterval(() => {
|
||||
if (
|
||||
this.timeLastCall !== 0 &&
|
||||
Date.now() > this.timeLastCall + pingPeriod
|
||||
) {
|
||||
this.server_ping().catch((error) => {
|
||||
this.log(`Keep-Alive ping failed: ${error}`);
|
||||
});
|
||||
}
|
||||
}, pingPeriod);
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the Electrum client connection and stops the keep-alive ping interval.
|
||||
*
|
||||
* @returns {void}
|
||||
*/
|
||||
close(): void {
|
||||
super.close();
|
||||
|
||||
if (this.pingInterval != null) {
|
||||
clearInterval(this.pingInterval);
|
||||
}
|
||||
|
||||
this.reconnect =
|
||||
this.reconnect =
|
||||
this.onClose =
|
||||
this.keepAlive =
|
||||
() => Promise.resolve(this); // dirty hack to make it stop reconnecting
|
||||
}
|
||||
|
||||
private reconnect(): Promise<ElectrumClient> {
|
||||
this.log("Electrum attempting reconnect...");
|
||||
|
||||
this.initSocket();
|
||||
|
||||
return this.persistencePolicy == null
|
||||
? // biome-ignore lint/style/noNonNullAssertion:
|
||||
this.initElectrum(this.electrumConfig!)
|
||||
: // biome-ignore lint/style/noNonNullAssertion:
|
||||
this.initElectrum(this.electrumConfig!, this.persistencePolicy);
|
||||
}
|
||||
|
||||
private log(str: string): void {
|
||||
this.onLogCallback(str);
|
||||
}
|
||||
|
||||
// ElectrumX API
|
||||
server_version(
|
||||
client_name: string,
|
||||
protocol_version: string | [string, string]
|
||||
) {
|
||||
return this.request("server.version", [client_name, protocol_version]);
|
||||
}
|
||||
|
||||
server_banner() {
|
||||
return this.request("server.banner", []);
|
||||
}
|
||||
|
||||
server_features() {
|
||||
return this.request("server.features", []);
|
||||
}
|
||||
|
||||
server_ping() {
|
||||
return this.request("server.ping", []);
|
||||
}
|
||||
|
||||
server_addPeer(features: any) {
|
||||
return this.request("server.add_peer", [features]);
|
||||
}
|
||||
|
||||
serverDonation_address() {
|
||||
return this.request("server.donation_address", []);
|
||||
}
|
||||
|
||||
serverPeers_subscribe() {
|
||||
return this.request("server.peers.subscribe", []);
|
||||
}
|
||||
|
||||
blockchainAddress_getProof(address: string) {
|
||||
return this.request("blockchain.address.get_proof", [address]);
|
||||
}
|
||||
|
||||
blockchainScripthash_getBalance(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.get_balance", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_getBalanceBatch(scripthashes: string[]) {
|
||||
return this.requestBatch("blockchain.scripthash.get_balance", scripthashes);
|
||||
}
|
||||
|
||||
blockchainScripthash_listunspentBatch(scripthashes: string[]) {
|
||||
return this.requestBatch("blockchain.scripthash.listunspent", scripthashes);
|
||||
}
|
||||
|
||||
blockchainScripthash_getHistory(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.get_history", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_getHistoryBatch(scripthashes: string[]) {
|
||||
return this.requestBatch("blockchain.scripthash.get_history", scripthashes);
|
||||
}
|
||||
|
||||
blockchainScripthash_getMempool(
|
||||
scripthash: string
|
||||
): Promise<MempoolTransaction[]> {
|
||||
return this.request("blockchain.scripthash.get_mempool", [
|
||||
scripthash,
|
||||
]) as Promise<MempoolTransaction[]>;
|
||||
}
|
||||
|
||||
blockchainScripthash_listunspent(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.listunspent", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainScripthash_subscribe(scripthash: string) {
|
||||
return this.request("blockchain.scripthash.subscribe", [scripthash]);
|
||||
}
|
||||
|
||||
blockchainBlock_getHeader(height: number) {
|
||||
return this.request("blockchain.block.get_header", [height]);
|
||||
}
|
||||
|
||||
blockchainBlock_headers(start_height: number, count: number) {
|
||||
return this.request("blockchain.block.headers", [start_height, count]);
|
||||
}
|
||||
|
||||
blockchainEstimatefee(number: number) {
|
||||
return this.request("blockchain.estimatefee", [number]);
|
||||
}
|
||||
|
||||
blockchainHeaders_subscribe() {
|
||||
return this.request("blockchain.headers.subscribe", []);
|
||||
}
|
||||
|
||||
blockchain_relayfee() {
|
||||
return this.request("blockchain.relayfee", []);
|
||||
}
|
||||
|
||||
blockchainTransaction_broadcast(rawtx: string) {
|
||||
return this.request("blockchain.transaction.broadcast", [rawtx]);
|
||||
}
|
||||
|
||||
blockchainTransaction_get_raw(tx_hash: string): Promise<string> {
|
||||
return this.request("blockchain.transaction.get", [
|
||||
tx_hash,
|
||||
false,
|
||||
]) as Promise<string>;
|
||||
}
|
||||
|
||||
blockchainTransaction_getVerbose(
|
||||
tx_hash: string
|
||||
): Promise<TransactionVerbose> {
|
||||
return this.request("blockchain.transaction.get", [
|
||||
tx_hash,
|
||||
true,
|
||||
]) as Promise<TransactionVerbose>;
|
||||
}
|
||||
|
||||
blockchainTransaction_getBatch(tx_hashes: string[], verbose = false) {
|
||||
return this.requestBatch("blockchain.transaction.get", tx_hashes, verbose);
|
||||
}
|
||||
|
||||
blockchainTransaction_getMerkle(tx_hash: string, height: number) {
|
||||
return this.request("blockchain.transaction.get_merkle", [tx_hash, height]);
|
||||
}
|
||||
|
||||
mempool_getFeeHistogram() {
|
||||
return this.request("mempool.get_fee_histogram", []);
|
||||
}
|
||||
|
||||
// ---------------------------------
|
||||
// protocol 1.1 deprecated method
|
||||
// ---------------------------------
|
||||
blockchainUtxo_getAddress(tx_hash: string, index: number) {
|
||||
return this.request("blockchain.utxo.get_address", [tx_hash, index]);
|
||||
}
|
||||
|
||||
blockchainNumblocks_subscribe() {
|
||||
return this.request("blockchain.numblocks.subscribe", []);
|
||||
}
|
||||
|
||||
// ---------------------------------
|
||||
// protocol 1.2 deprecated method
|
||||
// ---------------------------------
|
||||
blockchainBlock_getChunk(index: number) {
|
||||
return this.request("blockchain.block.get_chunk", [index]);
|
||||
}
|
||||
|
||||
blockchainAddress_getBalance(address: string) {
|
||||
return this.request("blockchain.address.get_balance", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_getHistory(address: string) {
|
||||
return this.request("blockchain.address.get_history", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_getMempool(address: string) {
|
||||
return this.request("blockchain.address.get_mempool", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_listunspent(address: string) {
|
||||
return this.request("blockchain.address.listunspent", [address]);
|
||||
}
|
||||
|
||||
blockchainAddress_subscribe(address: string) {
|
||||
return this.request("blockchain.address.subscribe", [address]);
|
||||
}
|
||||
}
|
||||
|
||||
42
src/types/TransactionVerbose.ts
Normal file
42
src/types/TransactionVerbose.ts
Normal file
@@ -0,0 +1,42 @@
|
||||
export type ScriptSig = {
|
||||
asm: string;
|
||||
hex: string;
|
||||
};
|
||||
|
||||
export type Vin = {
|
||||
txid: string;
|
||||
vout: number;
|
||||
scriptSig: ScriptSig;
|
||||
sequence: number;
|
||||
};
|
||||
|
||||
export type ScriptPubKey = {
|
||||
asm: string;
|
||||
desc: string;
|
||||
hex: string;
|
||||
address: string;
|
||||
type: string;
|
||||
};
|
||||
|
||||
export type Vout = {
|
||||
value: number;
|
||||
n: number;
|
||||
scriptPubKey: ScriptPubKey;
|
||||
};
|
||||
|
||||
export type TransactionVerbose = {
|
||||
txid: string;
|
||||
hash: string;
|
||||
version: number;
|
||||
size: number;
|
||||
vsize: number;
|
||||
weight: number;
|
||||
locktime: number;
|
||||
vin: Vin[];
|
||||
vout: Vout[];
|
||||
hex: string;
|
||||
blockhash: string;
|
||||
confirmations: number;
|
||||
time: number;
|
||||
blocktime: number;
|
||||
};
|
||||
5
src/types/mempoolTransaction.ts
Normal file
5
src/types/mempoolTransaction.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
export type MempoolTransaction = {
|
||||
tx_hash: string;
|
||||
height: number;
|
||||
fee: number;
|
||||
};
|
||||
Reference in New Issue
Block a user