cactus-agent/src/api/ws/wallet/index.ts

cactus rpc/websocket client library

import {TDaemon} from "../../../daemon/index";
import {GetMessageType, metrics_service, TConnectionGeneral, wallet_ui_service} from "../../types";
import {int, str, uint32} from "../../cactus/types/_python_types_";
import {TransactionRecord} from "../../cactus/wallet/transaction_record";

export const cactus_wallet_service = "cactus_wallet";
export type cactus_wallet_service = typeof cactus_wallet_service;

export const get_connections_command = "get_connections";
export type get_connections_command = typeof get_connections_command;
export type TGetConnectionsBroadCast = {
  connections: TConnectionGeneral[];
};
export type WsGetConnectionsWalletMessage = GetMessageType<cactus_wallet_service, get_connections_command, TGetConnectionsBroadCast>;
export async function on_get_connections(daemon: TDaemon, callback: (e: WsGetConnectionsWalletMessage) => unknown){
  await daemon.subscribe(wallet_ui_service);
  const messageListener = (e: WsWalletMessage) => {
    if(e.origin === cactus_wallet_service && e.command === get_connections_command){
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}

export const state_changed_command_of_wallet = "state_changed";
export type state_changed_command_of_wallet = typeof state_changed_command_of_wallet;
export type TStateChangedBroadCastOfWallet = {
  state: "add_connection" | "new_block" | "wallet_created"
    | "added_stray_cat" | "offer_added" | "offer_cancelled" | "new_on_chain_notification";
} | {
  state: "coin_removed" | "coin_added" | "pending_transaction" | "did_coin_added" | "nft_coin_added"
    | "nft_coin_removed" | "nft_coin_updated" | "nft_coin_did_set" | "wallet_removed";
  wallet_id: uint32;
} | {
  state: "tx_update";
  wallet_id: uint32;
  additional_data: {transaction: TransactionRecord} | { transaction: TransactionRecord; error: str; status: int};
} | {
  state: "new_derivation_index",
  additional_data: {index: uint32};
};
export type WsStateChangedWalletMessage = GetMessageType<cactus_wallet_service, state_changed_command_of_wallet, TStateChangedBroadCastOfWallet>;
export async function on_state_changed_of_wallet(daemon: TDaemon, callback: (e: WsStateChangedWalletMessage) => unknown){
  await daemon.subscribe(wallet_ui_service);
  const messageListener = (e: WsWalletMessage) => {
    if(e.origin === cactus_wallet_service && e.command === state_changed_command_of_wallet){
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}

// "sync_changed", "coin_added", "add_connection" and "close_connection" below are for metrics services.

export const sync_changed_command = "sync_changed";
export type sync_changed_command = typeof sync_changed_command;
export type TSyncChangedBroadCast = {};
export type WsSyncChangedWalletMessage = GetMessageType<cactus_wallet_service, sync_changed_command, TSyncChangedBroadCast>;
export async function on_sync_changed(daemon: TDaemon, callback: (e: WsSyncChangedWalletMessage) => unknown){
  await daemon.subscribe(metrics_service);
  const messageListener = (e: WsWalletMessage) => {
    if(e.origin === cactus_wallet_service && e.command === sync_changed_command){
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}

export const coin_added_command = "coin_added";
export type coin_added_command = typeof coin_added_command;
export type TCoinAddedBroadCast = {
  state: "coin_added";
  wallet_id: uint32;
};
export type WsCoinAddedMessage = GetMessageType<cactus_wallet_service, coin_added_command, TCoinAddedBroadCast>;
export async function on_coin_added(daemon: TDaemon, callback: (e: WsCoinAddedMessage) => unknown){
  await daemon.subscribe(metrics_service);
  const messageListener = (e: WsWalletMessage) => {
    if(e.origin === cactus_wallet_service && e.command === coin_added_command){
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}

export const add_connection_command = "add_connection";
export type add_connection_command = typeof add_connection_command;
export type TAddConnectionBroadCast = {
  state: "add_connection";
};
export type WsAddConnectionMessage = GetMessageType<cactus_wallet_service, add_connection_command, TAddConnectionBroadCast>;
export async function on_add_connection(daemon: TDaemon, callback: (e: WsAddConnectionMessage) => unknown) {
  await daemon.subscribe(metrics_service);
  const messageListener = (e: WsWalletMessage) => {
    if (e.origin === cactus_wallet_service && e.command === add_connection_command) {
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}

export const close_connection_command = "close_connection";
export type close_connection_command = typeof close_connection_command;
export type TCloseConnectionBroadCast = {
  state: "close_connection";
};
export type WsCloseConnectionMessage = GetMessageType<cactus_wallet_service, close_connection_command, TCloseConnectionBroadCast>;
export async function on_close_connection(daemon: TDaemon, callback: (e: WsCloseConnectionMessage) => unknown) {
  await daemon.subscribe(metrics_service);
  const messageListener = (e: WsWalletMessage) => {
    if (e.origin === cactus_wallet_service && e.command === close_connection_command) {
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}

export type WsWalletMessage = WsGetConnectionsWalletMessage
  | WsSyncChangedWalletMessage
  | WsStateChangedWalletMessage
  | WsCoinAddedMessage
  | WsAddConnectionMessage
  | WsCloseConnectionMessage
;
// Whole commands for the service
export type cactus_wallet_commands =
  get_connections_command
  | sync_changed_command
  | state_changed_command_of_wallet
  | coin_added_command
  | add_connection_command
  | close_connection_command
;
export type TCactusWalletBroadcast =
  TGetConnectionsBroadCast
  | TSyncChangedBroadCast
  | TStateChangedBroadCastOfWallet
  | TCoinAddedBroadCast
  | TAddConnectionBroadCast
  | TCloseConnectionBroadCast
;
export async function on_message_from_wallet(daemon: TDaemon, callback: (e: WsWalletMessage) => unknown){
  await Promise.all([
    daemon.subscribe(wallet_ui_service),
    daemon.subscribe(metrics_service),
  ]);
  const messageListener = (e: WsWalletMessage) => {
    if(e.origin === cactus_wallet_service){
      callback(e);
    }
  };
  return daemon.addMessageListener(cactus_wallet_service, messageListener);
}