Variable defaultConst

Type declaration

• ConnectionType: typeof ConnectionType

• Filter: typeof default

• GenUtils: typeof GenUtils

• HttpClient: typeof HttpClient

• LibraryUtils: typeof LibraryUtils

• MoneroAccount: typeof MoneroAccount

• MoneroAccountTag: typeof MoneroAccountTag

• MoneroAddressBookEntry: typeof MoneroAddressBookEntry

• MoneroAltChain: typeof MoneroAltChain

• MoneroBan: typeof MoneroBan

• MoneroBlock: typeof MoneroBlock

• MoneroBlockHeader: typeof MoneroBlockHeader

• MoneroBlockTemplate: typeof MoneroBlockTemplate

• MoneroCheck: typeof MoneroCheck

• MoneroCheckReserve: typeof MoneroCheckReserve

• MoneroCheckTx: typeof MoneroCheckTx

• MoneroConnectionManager: typeof MoneroConnectionManager

• MoneroConnectionManagerListener: typeof MoneroConnectionManagerListener

• MoneroConnectionSpan: typeof MoneroConnectionSpan

• MoneroDaemon: typeof MoneroDaemon

• MoneroDaemonConfig: typeof MoneroDaemonConfig

• MoneroDaemonInfo: typeof MoneroDaemonInfo

• MoneroDaemonListener: typeof MoneroDaemonListener

• MoneroDaemonRpc: typeof MoneroDaemonRpc

• MoneroDaemonSyncInfo: typeof MoneroDaemonSyncInfo

• MoneroDaemonUpdateCheckResult: typeof MoneroDaemonUpdateCheckResult

• MoneroDaemonUpdateDownloadResult: typeof MoneroDaemonUpdateDownloadResult

• MoneroDestination: typeof MoneroDestination

• MoneroError: typeof MoneroError

• MoneroFeeEstimate: typeof MoneroFeeEstimate

• MoneroHardForkInfo: typeof MoneroHardForkInfo

• MoneroIncomingTransfer: typeof MoneroIncomingTransfer

• MoneroIntegratedAddress: typeof MoneroIntegratedAddress

• MoneroKeyImage: typeof MoneroKeyImage

• MoneroKeyImageImportResult: typeof MoneroKeyImageImportResult

• MoneroKeyImageSpentStatus: typeof MoneroKeyImageSpentStatus

• MoneroMessageSignatureResult: typeof MoneroMessageSignatureResult

• MoneroMessageSignatureType: typeof MoneroMessageSignatureType

• MoneroMinerTxSum: typeof MoneroMinerTxSum

• MoneroMiningStatus: typeof MoneroMiningStatus

• MoneroMultisigInfo: typeof MoneroMultisigInfo

• MoneroMultisigInitResult: typeof MoneroMultisigInitResult

• MoneroMultisigSignResult: typeof MoneroMultisigSignResult

• MoneroNetworkType: typeof MoneroNetworkType

• MoneroOutgoingTransfer: typeof MoneroOutgoingTransfer

• MoneroOutput: typeof MoneroOutput

• MoneroOutputHistogramEntry: typeof MoneroOutputHistogramEntry

• MoneroOutputQuery: typeof MoneroOutputQuery

• MoneroOutputWallet: typeof MoneroOutputWallet

• MoneroPeer: typeof MoneroPeer

• MoneroPruneResult: typeof MoneroPruneResult

• MoneroRpcConnection: typeof MoneroRpcConnection

• MoneroRpcError: typeof MoneroRpcError

• MoneroSubaddress: typeof MoneroSubaddress

• MoneroSubmitTxResult: typeof MoneroSubmitTxResult

• MoneroSyncResult: typeof MoneroSyncResult

• MoneroTransfer: typeof MoneroTransfer

• MoneroTransferQuery: typeof MoneroTransferQuery

• MoneroTx: typeof MoneroTx

• MoneroTxConfig: typeof MoneroTxConfig

• MoneroTxPoolStats: typeof MoneroTxPoolStats

• MoneroTxPriority: typeof MoneroTxPriority

• MoneroTxQuery: typeof MoneroTxQuery

• MoneroTxSet: typeof MoneroTxSet

• MoneroTxWallet: typeof MoneroTxWallet

• MoneroUtils: typeof MoneroUtils

• MoneroVersion: typeof MoneroVersion

• MoneroWallet: typeof MoneroWallet

• MoneroWalletConfig: typeof MoneroWalletConfig

• MoneroWalletFull: typeof MoneroWalletFull

• MoneroWalletKeys: typeof MoneroWalletKeys

• MoneroWalletListener: typeof MoneroWalletListener

• MoneroWalletRpc: typeof MoneroWalletRpc

• SslOptions: typeof SslOptions

• TaskLooper: typeof TaskLooper

• ThreadPool: typeof ThreadPool

• connectToDaemonRpc: ((uriOrConfig, username?, password?) => Promise<MoneroDaemonRpc>)

  • • (uriOrConfig, username?, password?): Promise<MoneroDaemonRpc>

    • Create a client connected to monerod.

      Examples:

      let daemon = await moneroTs.connectToDaemonRpc("http://localhost:38081");


let daemon = await moneroTs.connectToDaemonRpc({
   uri: "http://localhost:38081",
   username: "superuser",
   password: "abctesting123"
});

// start monerod as an internal process
let daemon = await moneroTs.connectToDaemonRpc({
   cmd: ["path/to/monerod", ...params...],
});

      Parameters

      • uriOrConfig: string | string[] | Partial<MoneroRpcConnection> | Partial<MoneroDaemonConfig>

        uri or rpc connection or config or terminal parameters to connect to monerod

      • Optional username: string

        username to authenticate with monerod

      • Optional password: string

        password to authenticate with monerod

      Returns Promise<MoneroDaemonRpc>

      the daemon RPC client

• connectToWalletRpc: ((uriOrConfig, username?, password?) => Promise<MoneroWalletRpc>)

  • • (uriOrConfig, username?, password?): Promise<MoneroWalletRpc>

    • Create a client connected to monero-wallet-rpc.

      Examples:

      let walletRpc = await moneroTs.connectToWalletRpc({
   uri: "http://localhost:38081",
   username: "superuser",
   password: "abctesting123",
   rejectUnauthorized: false // e.g. local development
});


// connect to monero-wallet-rpc running as internal process
let walletRpc = await moneroTs.connectToWalletRpc({cmd: [
   "/path/to/monero-wallet-rpc",
   "--stagenet",
   "--daemon-address", "http://localhost:38081",
   "--daemon-login", "superuser:abctesting123",
   "--rpc-bind-port", "38085",
   "--rpc-login", "rpc_user:abc123",
   "--wallet-dir", "/path/to/wallets", // defaults to monero-wallet-rpc directory
   "--rpc-access-control-origins", "http://localhost:8080"
 ]});

      Parameters

      • uriOrConfig: string | string[] | Partial<MoneroRpcConnection> | Partial<MoneroWalletConfig>

        uri or rpc connection or config or terminal parameters to connect to monero-wallet-rpc

      • Optional username: string

        username to authenticate with monero-wallet-rpc

      • Optional password: string

        password to authenticate with monero-wallet-rpc

      Returns Promise<MoneroWalletRpc>

      the wallet RPC client

• createWalletFull: ((config) => Promise<MoneroWalletFull>)

  • • (config): Promise<MoneroWalletFull>

    • Create a Monero wallet using client-side WebAssembly bindings to monero-project's wallet2 in C++.

      Example:

      const wallet = await moneroTs.createWalletFull({
   path: "./test_wallets/wallet1", // leave blank for in-memory wallet
   password: "supersecretpassword",
   networkType: moneroTs.MoneroNetworkType.STAGENET,
   seed: "coexist igloo pamphlet lagoon...",
   restoreHeight: 1543218,
   server: "http://localhost:38081"
});

const wallet = await moneroTs.createWalletFull({
   path: "./test_wallets/wallet1", // leave blank for in-memory wallet
   password: "supersecretpassword",
   networkType: moneroTs.MoneroNetworkType.STAGENET,
   seed: "coexist igloo pamphlet lagoon...",
   restoreHeight: 1543218,
   proxyToWorker: false, // override default
   server: {
     uri: "http://localhost:38081",
     username: "daemon_user",
     password: "daemon_password_123"
   }
});

      Parameters

      • config: Partial<MoneroWalletConfig>

        MoneroWalletConfig or equivalent config object

      Returns Promise<MoneroWalletFull>

      the created wallet

• createWalletKeys: ((config) => Promise<MoneroWalletKeys>)

  • • (config): Promise<MoneroWalletKeys>

    • Create a wallet using WebAssembly bindings to monero-project.

      Example:

      const wallet = await moneroTs.createWalletKeys({
   password: "abc123",
   networkType: moneroTs.MoneroNetworkType.STAGENET,
   seed: "coexist igloo pamphlet lagoon..."
});

      Parameters

      • config: Partial<MoneroWalletConfig>

        MoneroWalletConfig or equivalent config object

      Returns Promise<MoneroWalletKeys>

      the created wallet

• getVersion: (() => string)

  • • (): string

    • Get the version of the monero-ts library.

      Returns string

      the version of this monero-ts library

• openWalletFull: ((config) => Promise<MoneroWalletFull>)

  • • (config): Promise<MoneroWalletFull>

    • Open an existing Monero wallet using client-side WebAssembly bindings to monero-project's wallet2 in C++.

      Example:

      const wallet = await moneroTs.openWalletFull({
   path: "./wallets/wallet1",
   password: "supersecretpassword",
   networkType: moneroTs.MoneroNetworkType.STAGENET,
   server: { // daemon configuration
     uri: "http://localhost:38081",
     username: "superuser",
     password: "abctesting123"
   }
});

      Parameters

      • config: Partial<MoneroWalletConfig>

        config to open a full wallet

      Returns Promise<MoneroWalletFull>

      the opened wallet

• shutdown: (() => Promise<void>)

  • • (): Promise<void>

    • Shut down the monero-ts library, terminating any running workers.

      Returns Promise<void>

      promise that resolves when the library has shut down