Package 'multichainr'

Description

Converts a hexadecimal encoded string back into its original character representation. This is primarily used for reading human-readable data published to MultiChain streams.

Usage

hex_to_char(hex_str)

Arguments

Details

The function performs a basic validation to ensure the string is a valid hexadecimal representation (even length and containing only hex characters) before attempting to convert.

Value

A decoded character string. If the input is not a valid hex string or an error occurs during decoding, the original hex_str is returned.

Examples

hex_to_char("48656c6c6f")  # Returns "Hello"

Description

Adds a new version (update) to an existing library. The update mechanism depends on the library's updatemode.

Usage

mc_add_library_update(conn, library, updatename, js_code)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_create_library, mc_add_library_update_from

Other libraries: mc_add_library_update_from(), mc_create_library(), mc_get_library_code(), mc_list_libraries(), mc_test_library()

Examples

## Not run: 
mc_add_library_update(conn, "math", "v2", "function add(a, b) { return a + b + 1; }")

## End(Not run)

Description

Similar to mc_add_library_update, but allows specifying the sending address.

Usage

mc_add_library_update_from(conn, from_address, library, updatename, js_code)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

Other libraries: mc_add_library_update(), mc_create_library(), mc_get_library_code(), mc_list_libraries(), mc_test_library()

Examples

## Not run: 
mc_add_library_update_from(conn, "1A...", "math", "v2", "function add(a, b) { return a + b; }")

## End(Not run)

Description

Creates a multi-signature address and adds it to the node's wallet. The address is a Pay‑to‑Script‑Hash (P2SH) address that requires a specified number of signatures from the provided keys.

Usage

mc_add_multisig_address(conn, n_required, keys)

Arguments

Value

A character string containing the multi-signature address.

See Also

mc_create_multisig to create a multisig address without adding it to the wallet.

Other addresses: mc_create_keypairs(), mc_create_multisig(), mc_get_addresses(), mc_get_new_address(), mc_import_address(), mc_list_addresses(), mc_validate_address()

Examples

## Not run: 
# Assume connection 'conn' is already established
addr <- mc_add_multisig_address(conn, n_required = 2,
                                keys = c("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
                                         "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2"))

## End(Not run)

Description

Manages the node's peer connections. Can add a node to the connection queue, remove an existing connection, or attempt a one‑time connection.

Usage

mc_add_node(conn, node, command = c("add", "remove", "onetry"))

Arguments

Value

Invisibly returns the RPC result (typically NULL) on success; throws an error if the command fails.

See Also

mc_get_added_node_info to list added nodes, mc_get_peer_info for connected peers.

Other networking: mc_get_added_node_info(), mc_get_network_info(), mc_get_peer_info(), mc_list_stored_nodes(), mc_ping(), mc_store_node()

Examples

## Not run: 
# Add a peer
mc_add_node(conn, "192.168.1.10:8571", command = "add")

# Remove a peer
mc_add_node(conn, "192.168.1.10:8571", command = "remove")

## End(Not run)

Description

Appends data to an existing binary cache item. If data = "" (the default), the RPC call returns the current size without adding new data.

Usage

mc_append_binary_cache(conn, identifier, data = "")

Arguments

Value

Integer. The resulting size of the cache item in bytes after appending (or the current size if data = "").

See Also

Other binary cache: mc_create_binary_cache(), mc_delete_binary_cache(), mc_txout_to_binary_cache()

Description

Appends a change output to a raw transaction. This is useful when the transaction inputs exceed the required output amounts; the change is sent back to the specified address.

Usage

mc_append_raw_change(conn, tx_hex, address, native_fee = NULL)

Arguments

Value

A character string containing the updated raw transaction hex.

See Also

mc_append_raw_data, mc_append_raw_transaction

Other raw transactions: mc_append_raw_data(), mc_append_raw_transaction(), mc_create_raw_send_from(), mc_create_raw_transaction(), mc_decode_raw_transaction(), mc_send_raw_transaction(), mc_sign_raw_transaction()

Examples

## Not run: 
# Add change to a raw transaction
updated_hex <- mc_append_raw_change(conn, tx_hex, "1A...")

## End(Not run)

Description

Appends arbitrary data (metadata) to a raw transaction. The data is embedded in an output with zero native value.

Usage

mc_append_raw_data(conn, tx_hex, data)

Arguments

Value

A character string containing the updated raw transaction hex.

See Also

mc_append_raw_change, mc_append_raw_transaction

Other raw transactions: mc_append_raw_change(), mc_append_raw_transaction(), mc_create_raw_send_from(), mc_create_raw_transaction(), mc_decode_raw_transaction(), mc_send_raw_transaction(), mc_sign_raw_transaction()

Examples

## Not run: 
# Add a text note
updated_hex <- mc_append_raw_data(conn, tx_hex, "This is a note.")

# Add JSON metadata
updated_hex <- mc_append_raw_data(conn, tx_hex, list(tag = "invoice", id = 123))

## End(Not run)

Description

Appends a new input–output pair to a partially constructed atomic exchange transaction. This function is used when multiple parties are contributing to the exchange, each adding their own locked output and specifying what they want in return.

Usage

mc_append_raw_exchange(conn, tx_hex, txid, vout, amounts)

Arguments

Value

A list with two elements:

See Also

mc_create_raw_exchange, mc_complete_raw_exchange

Other atomic exchange: mc_complete_raw_exchange(), mc_create_raw_exchange(), mc_decode_raw_exchange(), mc_disable_raw_transaction(), mc_prepare_lock_unspent(), mc_prepare_lock_unspent_from()

Examples

## Not run: 
# Assume 'partial_hex' is a partial exchange from a previous step
new <- mc_append_raw_exchange(conn, partial_hex,
                              txid = "abc...", vout = 0,
                              amounts = list(myasset = 10))

## End(Not run)

Description

Appends additional inputs and outputs to an existing raw transaction. This is useful for building multi‑party transactions or adding extra components after creation.

Usage

mc_append_raw_transaction(conn, tx_hex, inputs = list(), outputs = list())

Arguments

Value

A character string containing the updated raw transaction hex.

See Also

mc_create_raw_transaction, mc_append_raw_change

Other raw transactions: mc_append_raw_change(), mc_append_raw_data(), mc_create_raw_send_from(), mc_create_raw_transaction(), mc_decode_raw_transaction(), mc_send_raw_transaction(), mc_sign_raw_transaction()

Examples

## Not run: 
# Add another input and output
new_input <- list(list(txid = "def...", vout = 1))
new_output <- list("1C..." = 0.2)
updated_hex <- mc_append_raw_transaction(conn, tx_hex,
                                         inputs = new_input,
                                         outputs = new_output)

## End(Not run)

Description

Sends an approval or disapproval transaction from a specific address (must have admin permissions). This is used to vote on upgrades or to approve/disapprove filters.

Usage

mc_approve_from(conn, from_address, entity, approve)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_create_upgrade, mc_create_stream_filter

Other filters: mc_create_stream_filter(), mc_create_tx_filter(), mc_create_upgrade(), mc_get_filter_code(), mc_list_stream_filters(), mc_list_tx_filters(), mc_list_upgrades(), mc_run_stream_filter(), mc_run_tx_filter(), mc_test_stream_filter(), mc_test_tx_filter()

Examples

## Not run: 
# Approve a global upgrade
mc_approve_from(conn, "admin_address", "speedup", approve = TRUE)

# Approve a stream filter for a specific stream
mc_approve_from(conn, "admin_address", "myfilter",
                approve = list("for" = "mystream", approve = TRUE))

## End(Not run)

Description

Safely copies the wallet.dat file to a specified destination.

Usage

mc_backup_wallet(conn, filename)

Arguments

Value

Invisibly returns the RPC result (typically NULL) on success.

See Also

Other wallet: mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_privkey(), mc_dump_wallet(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Changes the encryption password of the wallet.

Usage

mc_change_wallet_passphrase(conn, old_passphrase, new_passphrase)

Arguments

Value

Invisibly returns the RPC result (typically NULL) on success.

See Also

Other wallet: mc_backup_wallet(), mc_combine_unspent(), mc_dump_privkey(), mc_dump_wallet(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Removes all unconfirmed transactions from the node's memory pool (mempool). This function is typically used after pausing incoming and mining tasks to reset the mempool state. It requires the node to be paused first with mc_pause(conn, "incoming,mining").

Usage

mc_clear_mempool(conn)

Arguments

Value

Invisibly returns the RPC result (typically NULL) on success.

See Also

mc_pause, mc_resume, mc_get_mempool_info to inspect mempool state.

Examples

## Not run: 
# Pause the node before clearing the mempool
mc_pause(conn, "incoming,mining")
mc_clear_mempool(conn)
mc_resume(conn, "incoming,mining")

## End(Not run)

Description

Sends transactions to combine many small unspent transaction outputs (UTXOs) into a single output. This is used to improve wallet performance and reduce the size of the wallet's UTXO set.

Usage

mc_combine_unspent(
  conn,
  addresses = "*",
  minconf = 1,
  maxcombines = 100,
  mininputs = 2,
  maxinputs = 100,
  maxtime = 15
)

Arguments

Value

A character vector of the transaction IDs (txids) created.

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_dump_privkey(), mc_dump_wallet(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Completes a multi-party atomic exchange by adding the final input–output pair. After this step, the transaction is fully built and ready to be broadcast.

Usage

mc_complete_raw_exchange(conn, tx_hex, txid, vout, amounts, data = NULL)

Arguments

Value

Character string. Raw transaction hex ready for sending via mc_send_raw_transaction.

See Also

mc_create_raw_exchange, mc_append_raw_exchange

Other atomic exchange: mc_append_raw_exchange(), mc_create_raw_exchange(), mc_decode_raw_exchange(), mc_disable_raw_transaction(), mc_prepare_lock_unspent(), mc_prepare_lock_unspent_from()

Examples

## Not run: 
final <- mc_complete_raw_exchange(conn, partial_hex,
                                  txid = "def...", vout = 1,
                                  amounts = list(ETH = 5),
                                  data = "exchange complete")

## End(Not run)

Description

Establishes a connection to a MultiChain node by constructing an RPC endpoint. The function accepts either explicit parameters (host, port, user, password) or a configuration list (typically obtained from mc_get_config).

Usage

mc_connect(host = "127.0.0.1", port = NULL, user = NULL, password = NULL)

Arguments

Value

An object of class "multichain_conn" containing the RPC URL, username, and password (the password is stored but hidden in printing).

See Also

mc_get_config to obtain a configuration list, print.multichain_conn for printing connections.

Examples

## Not run: 
# Using explicit parameters
conn <- mc_connect(host = "127.0.0.1", port = 8570,
                   user = "multichainrpc", password = "mysecret")

# Using a configuration object from mc_get_config
config <- mc_get_config("my_chain")
conn <- mc_connect(config)

## End(Not run)

Description

Creates an empty item (file) in the node's binary cache and returns its unique identifier. Binary cache items are temporary storage for binary data that can be used in transactions or passed between nodes.

Usage

mc_create_binary_cache(conn)

Arguments

Value

A character string identifier (filename) for the newly created cache item.

See Also

mc_append_binary_cache to add data, mc_delete_binary_cache to remove.

Other binary cache: mc_append_binary_cache(), mc_delete_binary_cache(), mc_txout_to_binary_cache()

Examples

## Not run: 
id <- mc_create_binary_cache(conn)

## End(Not run)

Description

Generates one or more public/private key pairs. These keys are not stored in the node's wallet, so they must be kept secure by the user.

Usage

mc_create_keypairs(conn, count = 1)

Arguments

Value

A data frame with three columns:

See Also

mc_get_new_address to create an address stored in the wallet.

Other addresses: mc_add_multisig_address(), mc_create_multisig(), mc_get_addresses(), mc_get_new_address(), mc_import_address(), mc_list_addresses(), mc_validate_address()

Examples

## Not run: 
# Generate a single key pair
keys <- mc_create_keypairs(conn)
print(keys)

# Generate 5 key pairs
keys5 <- mc_create_keypairs(conn, count = 5)

## End(Not run)

Description

Creates a JavaScript library on the blockchain. Libraries contain reusable code that can be imported by filters.

Usage

mc_create_library(
  conn,
  name,
  updatemode = c("none", "instant", "approve"),
  js_code
)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_add_library_update, mc_list_libraries

Other libraries: mc_add_library_update(), mc_add_library_update_from(), mc_get_library_code(), mc_list_libraries(), mc_test_library()

Examples

## Not run: 
js_code <- "function add(a, b) { return a + b; }"
mc_create_library(conn, "math", updatemode = "none", js_code)

## End(Not run)

Description

Creates a Pay‑to‑Script‑Hash (P2SH) multi-signature address without adding it to the wallet. The address can be used in transactions that require multiple signatures, but the node cannot spend funds from it unless the private keys are also imported.

Usage

mc_create_multisig(conn, n_required, keys)

Arguments

Value

A list with two components:

See Also

mc_add_multisig_address to create and add the address to the wallet.

Other addresses: mc_add_multisig_address(), mc_create_keypairs(), mc_get_addresses(), mc_get_new_address(), mc_import_address(), mc_list_addresses(), mc_validate_address()

Examples

## Not run: 
multisig <- mc_create_multisig(conn, n_required = 2,
                               keys = c("pubkey1", "pubkey2", "pubkey3"))
cat("Multisig address:", multisig$address)

## End(Not run)

Description

Initialises a partial atomic exchange transaction by specifying the first locked output and the desired assets/currency in return. This is the first step in constructing a multi‑party atomic exchange.

Usage

mc_create_raw_exchange(conn, txid, vout, amounts)

Arguments

Value

Character string. Raw partial transaction in hexadecimal.

See Also

mc_prepare_lock_unspent, mc_append_raw_exchange

Other atomic exchange: mc_append_raw_exchange(), mc_complete_raw_exchange(), mc_decode_raw_exchange(), mc_disable_raw_transaction(), mc_prepare_lock_unspent(), mc_prepare_lock_unspent_from()

Examples

## Not run: 
# First, lock some output
locked <- mc_prepare_lock_unspent(conn, amounts = list(myasset = 10))
# Create the exchange offer
offer <- mc_create_raw_exchange(conn, locked$txid, locked$vout,
                                amounts = list(otherasset = 5))

## End(Not run)

Description

Creates a raw transaction that is automatically funded from a specified address. This is a convenience function that selects UTXOs from the given address and builds the transaction.

Usage

mc_create_raw_send_from(
  conn,
  from_address,
  to_amounts,
  data = list(),
  action = ""
)

Arguments

Value

A character string (raw transaction hex) or a list with hex and complete if signing is requested.

See Also

mc_create_raw_transaction

Other raw transactions: mc_append_raw_change(), mc_append_raw_data(), mc_append_raw_transaction(), mc_create_raw_transaction(), mc_decode_raw_transaction(), mc_send_raw_transaction(), mc_sign_raw_transaction()

Examples

## Not run: 
# Send 1.0 native coin to address
tx_hex <- mc_create_raw_send_from(conn, "1A...", list("1B..." = 1.0))

# Send asset and metadata
tx_hex <- mc_create_raw_send_from(conn, "1A...",
                                  list("1B..." = list(myasset = 50)),
                                  data = list("payment", list(ref = 123)))

## End(Not run)

Description

Creates a raw (unsigned) transaction from a list of inputs and outputs. This is the first step in building a custom transaction before signing and broadcasting.

Usage

mc_create_raw_transaction(conn, inputs, outputs, data = list(), action = "")

Arguments

Value

A character string containing the raw transaction hex (if no action) or a list with hex and complete if action includes signing.

See Also

mc_sign_raw_transaction, mc_send_raw_transaction

Other raw transactions: mc_append_raw_change(), mc_append_raw_data(), mc_append_raw_transaction(), mc_create_raw_send_from(), mc_decode_raw_transaction(), mc_send_raw_transaction(), mc_sign_raw_transaction()

Examples

## Not run: 
# Build a simple transaction
inputs <- list(list(txid = "abc...", vout = 0))
outputs <- list("1A..." = 1.0)
tx_hex <- mc_create_raw_transaction(conn, inputs, outputs)

# With metadata
tx_hex <- mc_create_raw_transaction(conn, inputs, outputs,
                                    data = list("Hello", list(key = "value")))

## End(Not run)

Description

Creates a new stream on the blockchain. Streams are ordered collections of key‑value items that can be used for data storage, messaging, or other applications. The stream can be open (anyone can write) or restricted.

Usage

mc_create_stream(conn, name, open = TRUE, custom_fields = NULL)

Arguments

Value

A character string containing the transaction ID (txid) of the stream creation.

See Also

mc_create_stream_from to specify the creator address, mc_get_stream_info to query stream details.

Other streams: mc_create_stream_from(), mc_get_stream_info(), mc_get_stream_item(), mc_get_stream_key_summary(), mc_get_stream_publisher_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_key_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

## Not run: 
# Create an open stream
txid <- mc_create_stream(conn, "mystream", open = TRUE)

# Create a restricted stream with custom fields
txid <- mc_create_stream(conn, "private", open = list(restrict = "write"),
                         custom_fields = list(owner = "admin"))

## End(Not run)

Description

Creates a new stream filter on the blockchain. Stream filters are JavaScript programs that can be attached to streams to validate or transform items.

Usage

mc_create_stream_filter(conn, name, options, js_code)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_create_tx_filter, mc_list_stream_filters

Other filters: mc_approve_from(), mc_create_tx_filter(), mc_create_upgrade(), mc_get_filter_code(), mc_list_stream_filters(), mc_list_tx_filters(), mc_list_upgrades(), mc_run_stream_filter(), mc_run_tx_filter(), mc_test_stream_filter(), mc_test_tx_filter()

Examples

## Not run: 
js_code <- "function filter(stream, item) { return true; }"
mc_create_stream_filter(conn, "myfilter", list(libraries = list()), js_code)

## End(Not run)

Description

Creates a stream from a specified address (the address pays for the transaction). This is useful when the node has multiple addresses and you want to control which address appears as the creator.

Usage

mc_create_stream_from(
  conn,
  from_address,
  name,
  open = TRUE,
  custom_fields = NULL
)

Arguments

Value

A character string containing the transaction ID.

See Also

mc_create_stream

Other streams: mc_create_stream(), mc_get_stream_info(), mc_get_stream_item(), mc_get_stream_key_summary(), mc_get_stream_publisher_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_key_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

## Not run: 
txid <- mc_create_stream_from(conn, "1A...", "mystream", open = TRUE)

## End(Not run)

Description

Creates a new transaction filter on the blockchain. Transaction filters are JavaScript programs that validate or transform transactions.

Usage

mc_create_tx_filter(conn, name, options, js_code)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_create_stream_filter, mc_list_tx_filters

Other filters: mc_approve_from(), mc_create_stream_filter(), mc_create_upgrade(), mc_get_filter_code(), mc_list_stream_filters(), mc_list_tx_filters(), mc_list_upgrades(), mc_run_stream_filter(), mc_run_tx_filter(), mc_test_stream_filter(), mc_test_tx_filter()

Examples

## Not run: 
js_code <- "function filter(tx) { return tx.vin.length > 0; }"
mc_create_tx_filter(conn, "myfilter", list("for" = "asset1"), js_code)

## End(Not run)

Description

Creates a new upgrade proposal to change blockchain parameters (e.g., target block time, maximum block size). Upgrades require admin approval.

Usage

mc_create_upgrade(conn, name, params)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_approve_from to approve an upgrade.

Other filters: mc_approve_from(), mc_create_stream_filter(), mc_create_tx_filter(), mc_get_filter_code(), mc_list_stream_filters(), mc_list_tx_filters(), mc_list_upgrades(), mc_run_stream_filter(), mc_run_tx_filter(), mc_test_stream_filter(), mc_test_tx_filter()

Examples

## Not run: 
mc_create_upgrade(conn, "speedup", list("target-block-time" = 20))

## End(Not run)

Description

Creates a global variable on the blockchain. Variables are key‑value stores that can be read by filters and transactions.

Usage

mc_create_variable(conn, name, open = TRUE, value = NULL)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

mc_set_variable_value, mc_get_variable_value

Other variables: mc_create_variable_from(), mc_get_variable_history(), mc_get_variable_info(), mc_get_variable_value(), mc_list_variables(), mc_set_variable_value(), mc_set_variable_value_from()

Examples

## Not run: 
mc_create_variable(conn, "myvar", open = TRUE, value = list(key = "value"))

## End(Not run)

Description

Creates a global variable, specifying the address that issues the transaction.

Usage

mc_create_variable_from(conn, from_address, name, open = TRUE, value = NULL)

Arguments

Value

A list containing the result of the RPC call (usually transaction ID).

See Also

Other variables: mc_create_variable(), mc_get_variable_history(), mc_get_variable_info(), mc_get_variable_value(), mc_list_variables(), mc_set_variable_value(), mc_set_variable_value_from()

Examples

## Not run: 
mc_create_variable_from(conn, "1A...", "myvar", open = TRUE, value = 42)

## End(Not run)

Description

Parses a raw atomic exchange transaction (partial or complete) and returns a human‑readable representation of its structure, including the involved inputs, outputs, and the assets being exchanged.

Usage

mc_decode_raw_exchange(conn, tx_hex, verbose = FALSE)

Arguments

Value

A list (or a data frame if verbose) containing the decoded exchange details.

See Also

mc_create_raw_exchange

Other atomic exchange: mc_append_raw_exchange(), mc_complete_raw_exchange(), mc_create_raw_exchange(), mc_disable_raw_transaction(), mc_prepare_lock_unspent(), mc_prepare_lock_unspent_from()

Examples

## Not run: 
decoded <- mc_decode_raw_exchange(conn, my_tx_hex)
print(decoded)

## End(Not run)

Description

Parses a raw transaction hex string into a human‑readable structure, showing inputs, outputs, amounts, metadata, and other transaction details.

Usage

mc_decode_raw_transaction(conn, tx_hex)

Arguments

Value

A list with decoded transaction information (inputs, outputs, etc.).

See Also

mc_get_raw_transaction

Other raw transactions: mc_append_raw_change(), mc_append_raw_data(), mc_append_raw_transaction(), mc_create_raw_send_from(), mc_create_raw_transaction(), mc_send_raw_transaction(), mc_sign_raw_transaction()

Examples

## Not run: 
decoded <- mc_decode_raw_transaction(conn, tx_hex)
print(decoded$vin)

## End(Not run)

Description

Removes a previously created binary cache item. Once deleted, the identifier becomes invalid and cannot be used further.

Usage

mc_delete_binary_cache(conn, identifier)

Arguments

Value

Invisibly returns NULL on success; throws an error if the item does not exist or cannot be deleted.

See Also

mc_create_binary_cache, mc_append_binary_cache

Other binary cache: mc_append_binary_cache(), mc_create_binary_cache(), mc_txout_to_binary_cache()

Examples

## Not run: 
id <- mc_create_binary_cache(conn)
# ... use the cache item ...
mc_delete_binary_cache(conn, id)

## End(Not run)

Description

Invalidates a previously created partial exchange transaction, preventing it from being completed. The transaction is replaced with a disabling transaction that spends the locked output(s) back to the original owner(s).

Usage

mc_disable_raw_transaction(conn, tx_hex)

Arguments

Value

Character string. Transaction ID of the disabling transaction.

See Also

mc_prepare_lock_unspent

Other atomic exchange: mc_append_raw_exchange(), mc_complete_raw_exchange(), mc_create_raw_exchange(), mc_decode_raw_exchange(), mc_prepare_lock_unspent(), mc_prepare_lock_unspent_from()

Examples

## Not run: 
# After creating an offer, but before completion, you may decide to cancel
disable_txid <- mc_disable_raw_transaction(conn, offer_hex)

## End(Not run)

Description

Dump a private key for an address

Usage

mc_dump_privkey(conn, address)

Arguments

Value

Character. The private key in Wallet Import Format (WIF).

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_wallet(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Exports all wallet private keys into a human-readable text file.

Usage

mc_dump_wallet(conn, filename)

Arguments

Value

Invisibly returns the RPC result (typically NULL) on success.

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_privkey(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Encrypts the wallet with a passphrase for the first time.

Usage

mc_encrypt_wallet(conn, passphrase)

Arguments

Value

Invisibly returns the RPC result (a message indicating the node is shutting down).

Warning

MultiChain will shut down after this command is successful. You must manually restart the node to continue operations.

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_privkey(), mc_dump_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Returns details about nodes that were added via mc_add_node. Can return either a list of node addresses or detailed information.

Usage

mc_get_added_node_info(conn, verbose = FALSE, node = NULL)

Arguments

Value

If verbose = FALSE: a character vector of node addresses. If verbose = TRUE: a data frame (via rpc_res_to_df) with node details.

See Also

mc_add_node, mc_get_peer_info

Other networking: mc_add_node(), mc_get_network_info(), mc_get_peer_info(), mc_list_stored_nodes(), mc_ping(), mc_store_node()

Examples

## Not run: 
# List all added nodes (addresses only)
nodes <- mc_get_added_node_info(conn)

# Get detailed information for a specific node
details <- mc_get_added_node_info(conn, verbose = TRUE, node = "192.168.1.10:8571")

## End(Not run)

Description

Returns a list of all asset balances for a given address in the node's wallet.

Usage

mc_get_address_balances(conn, address, minconf = 1, include_locked = FALSE)

Arguments

Value

A data frame containing asset names, amounts, and other balance details.

See Also

Other transactions: mc_get_address_transaction(), mc_get_multi_balances(), mc_get_token_balances(), mc_get_total_balances(), mc_get_tx_out_data(), mc_get_wallet_transaction(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Provides information about a specific transaction, but only if it involves the specified address.

Usage

mc_get_address_transaction(conn, address, txid, verbose = FALSE)

Arguments

Value

A list containing transaction details.

See Also

Other transactions: mc_get_address_balances(), mc_get_multi_balances(), mc_get_token_balances(), mc_get_total_balances(), mc_get_tx_out_data(), mc_get_wallet_transaction(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Returns all addresses owned by the current node. If verbose = TRUE, detailed information (including balances and transactions) is returned.

Usage

mc_get_addresses(conn, verbose = FALSE)

Arguments

Value

If verbose = FALSE: a character vector of addresses. If verbose = TRUE: a list (or data frame) with details.

See Also

mc_list_addresses for more flexible listing options.

Other addresses: mc_add_multisig_address(), mc_create_keypairs(), mc_create_multisig(), mc_get_new_address(), mc_import_address(), mc_list_addresses(), mc_validate_address()

Examples

## Not run: 
# Get all addresses (simple list)
addresses <- mc_get_addresses(conn)

# Get detailed information
details <- mc_get_addresses(conn, verbose = TRUE)

## End(Not run)

Description

Retrieves details about an asset on the MultiChain blockchain. The asset can be identified by its name, reference, or issuance transaction ID.

Usage

mc_get_asset_info(conn, asset, verbose = FALSE)

Arguments

Value

A list (or data frame, depending on verbosity) containing asset information such as name, type, total quantity, units, etc.

See Also

mc_list_assets to list all assets, mc_list_asset_issues to list issuances.

Other assets: mc_get_token_info(), mc_issue(), mc_issue_from(), mc_issue_more(), mc_issue_more_from(), mc_issue_token(), mc_issue_token_from(), mc_list_asset_issues(), mc_list_assets(), mc_update(), mc_update_from()

Examples

## Not run: 
# Get basic info about an asset named "mycoin"
info <- mc_get_asset_info(conn, "mycoin")
print(info$name)

# Get verbose info with issuance details
info_verbose <- mc_get_asset_info(conn, "mycoin", verbose = TRUE)

## End(Not run)

Description

Returns details of a single transaction that affects a subscribed asset.

Usage

mc_get_asset_transaction(conn, asset, txid, verbose = FALSE)

Arguments

Value

A list (or data frame) with transaction details, including inputs, outputs, and asset movements.

See Also

mc_list_asset_transactions to list multiple transactions.

Other asset transactions: mc_list_asset_transactions()

Examples

## Not run: 
# Get details of a specific transaction
tx <- mc_get_asset_transaction(conn, "mycoin", "txid...")

## End(Not run)

Description

Retrieves detailed information about a specific block. The block can be identified either by its hash (string) or height (integer). The verbosity level controls how much detail is returned.

Usage

mc_get_block(conn, hash_or_height, verbose = 1)

Arguments

Value

Depends on verbose:

• If verbose = 0: a character string with the block hash.

• If verbose >= 1: a list containing block details (height, time, transactions, etc.).

See Also

mc_get_block_hash to obtain a block hash from height, mc_list_blocks to list multiple blocks.

Other blockchain information: mc_get_block_hash(), mc_get_blockchain_info(), mc_get_chain_totals(), mc_get_last_block_info(), mc_list_blocks(), mc_list_miners()

Examples

## Not run: 
# Get block by height
block <- mc_get_block(conn, 123456)

# Get block by hash with full transaction details
block <- mc_get_block(conn, "0000...", verbose = 2)

## End(Not run)

Description

Returns the hash of a block at a given height.

Usage

mc_get_block_hash(conn, height)

Arguments

Value

A character string containing the block hash.

See Also

mc_get_block to retrieve block details.

Other blockchain information: mc_get_block(), mc_get_blockchain_info(), mc_get_chain_totals(), mc_get_last_block_info(), mc_list_blocks(), mc_list_miners()

Examples

## Not run: 
hash <- mc_get_block_hash(conn, 0)  # genesis block hash

## End(Not run)

Description

Returns global information about the blockchain, such as the current block height, chain name, protocol version, difficulty, and consensus status.

Usage

mc_get_blockchain_info(conn)

Arguments

Value

A list with blockchain metadata. Typical fields:

See Also

mc_get_chain_totals for counts of entities, mc_get_last_block_info for the most recent block.

Other blockchain information: mc_get_block(), mc_get_block_hash(), mc_get_chain_totals(), mc_get_last_block_info(), mc_list_blocks(), mc_list_miners()

Examples

## Not run: 
info <- mc_get_blockchain_info(conn)
print(info$blocks)

## End(Not run)

Description

Returns the parameters that were used to initialize this blockchain. These are fixed at chain creation and cannot be changed later.

Usage

mc_get_blockchain_params(conn)

Arguments

Value

A list containing blockchain configuration parameters, such as:

See Also

mc_get_runtime_params for modifiable parameters.

Other node configuration: mc_get_runtime_params(), mc_set_runtime_param()

Examples

## Not run: 
params <- mc_get_blockchain_params(conn)
print(params$targetblocktime)

## End(Not run)

Description

Returns the total number of various objects in the blockchain, such as addresses, transactions, assets, streams, and permissions.

Usage

mc_get_chain_totals(conn)

Arguments

Value

A list with counts, typically containing:

See Also

mc_get_blockchain_info for global blockchain stats.

Other blockchain information: mc_get_block(), mc_get_block_hash(), mc_get_blockchain_info(), mc_get_last_block_info(), mc_list_blocks(), mc_list_miners()

Examples

## Not run: 
totals <- mc_get_chain_totals(conn)
print(totals$transactions)

## End(Not run)

Description

Returns details about the node's off‑chain chunk queue, which handles the transmission of large data items that are split into chunks.

Usage

mc_get_chunk_queue_info(conn)

Arguments

Value

A list containing:

See Also

mc_get_chunk_queue_totals for cumulative statistics.

Other off-chain data: mc_get_chunk_queue_totals()

Examples

## Not run: 
queue_info <- mc_get_chunk_queue_info(conn)
cat("Chunks pending:", queue_info$chunk_count)

## End(Not run)

Description

Returns total counts of chunk deliveries, failures, and timeouts since the node started.

Usage

mc_get_chunk_queue_totals(conn)

Arguments

Value

A list with cumulative statistics:

See Also

mc_get_chunk_queue_info for current queue state.

Other off-chain data: mc_get_chunk_queue_info()

Examples

## Not run: 
totals <- mc_get_chunk_queue_totals(conn)
print(totals)

## End(Not run)

Description

Reads the configuration parameters (RPC user, password, port) for a given blockchain from the MultiChain data directory. The function automatically determines the platform‑specific base directory, but a custom base can be supplied for testing.

Usage

mc_get_config(chain_name, base_dir = NULL)

Arguments

Value

A list with four components:

See Also

mc_connect to create a connection object using the returned configuration.

Examples

## Not run: 
# Get configuration for a chain called "my_chain"
config <- mc_get_config("my_chain")
print(config)

## End(Not run)

Description

Retrieves the JavaScript code (and associated metadata) of an existing stream or transaction filter.

Usage

mc_get_filter_code(conn, filter)

Arguments

Value

A list containing the filter's code and details.

See Also

mc_get_library_code for libraries.

Other filters: mc_approve_from(), mc_create_stream_filter(), mc_create_tx_filter(), mc_create_upgrade(), mc_list_stream_filters(), mc_list_tx_filters(), mc_list_upgrades(), mc_run_stream_filter(), mc_run_tx_filter(), mc_test_stream_filter(), mc_test_tx_filter()

Examples

## Not run: 
code_info <- mc_get_filter_code(conn, "myfilter")
print(code_info$code)

## End(Not run)

Description

Returns comprehensive information about the node's status, including version, protocol, network connections, balance, and mining status.

Usage

mc_get_info(conn)

Arguments

Value

A list with node information, typically including:

See Also

mc_get_blockchain_info for blockchain-level info, mc_get_runtime_params for runtime settings.

Other node information: mc_get_init_status()

Examples

## Not run: 
info <- mc_get_info(conn)
cat("Balance:", info$balance, "\n")
cat("Blocks:", info$blocks, "\n")

## End(Not run)

Description

Returns information about the node's initialization progress, especially useful during startup when the node is still syncing or loading the wallet.

Usage

mc_get_init_status(conn)

Arguments

Value

A list with:

See Also

mc_get_info for general node status.

Other node information: mc_get_info()

Examples

## Not run: 
init <- mc_get_init_status(conn)
while (init$progress < 1) {
  cat("Init progress:", init$progress, "\n")
  Sys.sleep(5)
  init <- mc_get_init_status(conn)
}

## End(Not run)

Description

Retrieves details of the most recent block, optionally skipping back by a number of blocks.

Usage

mc_get_last_block_info(conn, skip = 0)

Arguments

Value

A list with block information (similar to mc_get_block).

See Also

mc_get_block for general block retrieval.

Other blockchain information: mc_get_block(), mc_get_block_hash(), mc_get_blockchain_info(), mc_get_chain_totals(), mc_list_blocks(), mc_list_miners()

Examples

## Not run: 
latest <- mc_get_last_block_info(conn)
previous <- mc_get_last_block_info(conn, skip = 1)

## End(Not run)

Description

Retrieves the JavaScript code of a library. By default, returns the active code. If updatename is provided, returns the code of that specific update (or the initial code if updatename = "").

Usage

mc_get_library_code(conn, library, updatename = NULL)

Arguments

Value

A list containing the library code and metadata.

See Also

mc_get_filter_code for filters.

Other libraries: mc_add_library_update(), mc_add_library_update_from(), mc_create_library(), mc_list_libraries(), mc_test_library()

Examples

## Not run: 
active_code <- mc_get_library_code(conn, "math")
initial_code <- mc_get_library_code(conn, "math", updatename = "")

## End(Not run)

Description

Returns information about the node's memory pool (mempool), which holds unconfirmed transactions awaiting inclusion in a block.

Usage

mc_get_mempool_info(conn)

Arguments

Value

A list with mempool statistics:

See Also

mc_get_raw_mempool for the list of transaction IDs.

Other mempool & transactions: mc_get_raw_mempool(), mc_get_raw_transaction(), mc_get_tx_out()

Examples

## Not run: 
mempool <- mc_get_mempool_info(conn)
print(paste("Pending transactions:", mempool$size))

## End(Not run)

Description

Returns a breakdown of balances across a set of addresses and/or assets.

Usage

mc_get_multi_balances(
  conn,
  addresses = "*",
  assets = "*",
  minconf = 1,
  include_watch_only = FALSE,
  include_locked = FALSE
)

Arguments

Value

A list or data frame of balances, indexed by address and asset.

See Also

Other transactions: mc_get_address_balances(), mc_get_address_transaction(), mc_get_token_balances(), mc_get_total_balances(), mc_get_tx_out_data(), mc_get_wallet_transaction(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Returns details about the node's network configuration, including listening port, local addresses, and network‑related flags.

Usage

mc_get_network_info(conn)

Arguments

Value

A list containing network information, typically:

See Also

mc_get_peer_info for peer details.

Other networking: mc_add_node(), mc_get_added_node_info(), mc_get_peer_info(), mc_list_stored_nodes(), mc_ping(), mc_store_node()

Examples

## Not run: 
net_info <- mc_get_network_info(conn)
cat("Listening port:", net_info$localaddresses[[1]]$port)

## End(Not run)

Description

Generates a new address (with a private key) and adds it to the node's wallet.

Usage

mc_get_new_address(conn)

Arguments

Value

A character string with the newly created address.

See Also

mc_create_keypairs to generate key pairs not stored in the wallet.

Other addresses: mc_add_multisig_address(), mc_create_keypairs(), mc_create_multisig(), mc_get_addresses(), mc_import_address(), mc_list_addresses(), mc_validate_address()

Examples

## Not run: 
new_addr <- mc_get_new_address(conn)
print(new_addr)

## End(Not run)

Description

Returns detailed information about each peer currently connected to the node.

Usage

mc_get_peer_info(conn)

Arguments

Value

A data frame (via rpc_res_to_df) with one row per peer. Common columns include:

See Also

mc_ping to measure latency, mc_get_network_info for node network status.

Other networking: mc_add_node(), mc_get_added_node_info(), mc_get_network_info(), mc_list_stored_nodes(), mc_ping(), mc_store_node()

Examples

## Not run: 
peers <- mc_get_peer_info(conn)
print(head(peers))

## End(Not run)

Description

Returns a character vector of transaction IDs currently in the node's memory pool.

Usage

mc_get_raw_mempool(conn)

Arguments

Value

A character vector of transaction IDs (txids).

See Also

mc_get_mempool_info for mempool statistics.

Other mempool & transactions: mc_get_mempool_info(), mc_get_raw_transaction(), mc_get_tx_out()

Examples

## Not run: 
pending <- mc_get_raw_mempool(conn)
length(pending)  # number of pending transactions

## End(Not run)

Description

Retrieves a transaction from the blockchain by its transaction ID. If verbose = TRUE, returns a detailed decoded transaction; if FALSE (default), returns the raw transaction in hexadecimal.

Usage

mc_get_raw_transaction(conn, txid, verbose = FALSE)

Arguments

Value

If verbose = FALSE, a character string (hex). If verbose = TRUE, a list with transaction details.

See Also

mc_get_tx_out to inspect a specific output.

Other mempool & transactions: mc_get_mempool_info(), mc_get_raw_mempool(), mc_get_tx_out()

Examples

## Not run: 
# Get raw hex of a transaction
raw <- mc_get_raw_transaction(conn, "abc...")

# Get decoded transaction
tx <- mc_get_raw_transaction(conn, "abc...", verbose = TRUE)

## End(Not run)

Description

Returns the current runtime parameters of the node. These can be changed while the node is running (see mc_set_runtime_param).

Usage

mc_get_runtime_params(conn)

Arguments

Value

A list of runtime parameters, e.g.:

See Also

mc_set_runtime_param to modify parameters, mc_get_blockchain_params for fixed chain parameters.

Other node configuration: mc_get_blockchain_params(), mc_set_runtime_param()

Examples

## Not run: 
runtime <- mc_get_runtime_params(conn)
print(runtime$mining)

## End(Not run)

Description

Returns metadata about a stream, including its creation transaction, open/restricted status, and optionally the creator address.

Usage

mc_get_stream_info(conn, stream, verbose = FALSE)

Arguments

Value

A list with stream details (name, ref, open, txid, etc.).

See Also

mc_list_streams to list all streams.

Other streams: mc_create_stream(), mc_create_stream_from(), mc_get_stream_item(), mc_get_stream_key_summary(), mc_get_stream_publisher_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_key_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

## Not run: 
info <- mc_get_stream_info(conn, "mystream")
print(info$open)

## End(Not run)

Description

Retrieves a single stream item by its transaction ID.

Usage

mc_get_stream_item(conn, stream, txid, verbose = FALSE)

Arguments

Value

A list with item details (key, data, publisher, etc.).

See Also

mc_list_stream_items to list items.

Other streams: mc_create_stream(), mc_create_stream_from(), mc_get_stream_info(), mc_get_stream_key_summary(), mc_get_stream_publisher_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_key_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

## Not run: 
item <- mc_get_stream_item(conn, "mystream", "txid...")
print(item$data)

## End(Not run)

Description

Aggregates JSON objects published under a specific key, merging them according to the specified mode.

Usage

mc_get_stream_key_summary(conn, stream, key, mode = "jsonobjectmerge")

Arguments

Value

A JSON object (list) representing the merged summary.

See Also

mc_get_stream_publisher_summary

Other streams: mc_create_stream(), mc_create_stream_from(), mc_get_stream_info(), mc_get_stream_item(), mc_get_stream_publisher_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_key_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

## Not run: 
summary <- mc_get_stream_key_summary(conn, "mystream", "key", mode = "jsonobjectmerge")

## End(Not run)

Description

Aggregates JSON objects published by a given address in a stream.

Usage

mc_get_stream_publisher_summary(
  conn,
  stream,
  address,
  mode = "jsonobjectmerge"
)

Arguments

Value

A JSON object (list) representing the merged summary.

See Also

Other streams: mc_create_stream(), mc_create_stream_from(), mc_get_stream_info(), mc_get_stream_item(), mc_get_stream_key_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_key_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

## Not run: 
summary <- mc_get_stream_publisher_summary(conn, "mystream", "1A...")

## End(Not run)

Description

Specifically retrieves balances for tokens (sub-assets or individual units) associated with a parent asset.

Usage

mc_get_token_balances(
  conn,
  addresses = "*",
  assets = "*",
  minconf = 1,
  include_watch_only = FALSE,
  include_locked = FALSE
)

Arguments

Value

A data frame containing token-level balance details.

See Also

Other transactions: mc_get_address_balances(), mc_get_address_transaction(), mc_get_multi_balances(), mc_get_total_balances(), mc_get_tx_out_data(), mc_get_wallet_transaction(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Retrieves details about a token (non‑fungible) within a parent asset. This function requires MultiChain version 2.2.1 or later.

Usage

mc_get_token_info(conn, asset, token, verbose = FALSE)

Arguments

Value

A list with token information, such as name, quantity, and (if verbose) custom fields.

See Also

mc_issue_token to issue tokens, mc_list_assets to list parent assets.

Other assets: mc_get_asset_info(), mc_issue(), mc_issue_from(), mc_issue_more(), mc_issue_more_from(), mc_issue_token(), mc_issue_token_from(), mc_list_asset_issues(), mc_list_assets(), mc_update(), mc_update_from()

Examples

## Not run: 
# Get basic info about token "nft1" in asset "art"
token_info <- mc_get_token_info(conn, "art", "nft1")

## End(Not run)

Description

Returns the total balance of all assets across all addresses in the wallet.

Usage

mc_get_total_balances(
  conn,
  minconf = 1,
  include_watch_only = FALSE,
  include_locked = FALSE
)

Arguments

Value

A data frame summarizing total balances for each asset.

See Also

Other transactions: mc_get_address_balances(), mc_get_address_transaction(), mc_get_multi_balances(), mc_get_token_balances(), mc_get_tx_out_data(), mc_get_wallet_transaction(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Returns information about a specific unspent transaction output (UTXO). This can be useful for building transactions or checking balances.

Usage

mc_get_tx_out(conn, txid, vout, unconfirmed = FALSE)

Arguments

Value

A list with output details, including:

Returns NULL if the output does not exist or is spent.

See Also

mc_get_raw_transaction for full transaction details.

Other mempool & transactions: mc_get_mempool_info(), mc_get_raw_mempool(), mc_get_raw_transaction()

Examples

## Not run: 
# Check an output from a confirmed transaction
out <- mc_get_tx_out(conn, "abc...", vout = 0)
if (!is.null(out)) print(out$value)

## End(Not run)

Description

This function is used to retrieve large data payloads (like stream data) that may have been truncated in standard transaction calls.

Usage

mc_get_tx_out_data(conn, txid, vout, count_bytes = NULL, start_byte = 0)

Arguments

Value

A list or string containing the hex data from the transaction output.

See Also

Other transactions: mc_get_address_balances(), mc_get_address_transaction(), mc_get_multi_balances(), mc_get_token_balances(), mc_get_total_balances(), mc_get_wallet_transaction(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Retrieves the update history of a variable, showing previous values and their transaction IDs.

Usage

mc_get_variable_history(
  conn,
  variable,
  verbose = FALSE,
  count = 10,
  start = NULL
)

Arguments

Value

A data frame (via rpc_res_to_df) with history entries.

See Also

Other variables: mc_create_variable(), mc_create_variable_from(), mc_get_variable_info(), mc_get_variable_value(), mc_list_variables(), mc_set_variable_value(), mc_set_variable_value_from()

Examples

## Not run: 
history <- mc_get_variable_history(conn, "myvar", count = 5)

## End(Not run)

Description

Returns metadata about a variable, such as creator, open status, creation time.

Usage

mc_get_variable_info(conn, variable, verbose = FALSE)

Arguments

Value

A list with variable information.

See Also

Other variables: mc_create_variable(), mc_create_variable_from(), mc_get_variable_history(), mc_get_variable_value(), mc_list_variables(), mc_set_variable_value(), mc_set_variable_value_from()

Examples

## Not run: 
info <- mc_get_variable_info(conn, "myvar")
print(info$open)

## End(Not run)

Description

Returns the current value of a variable.

Usage

mc_get_variable_value(conn, variable)

Arguments

Value

The current value (any JSON type).

See Also

mc_get_variable_info, mc_get_variable_history

Other variables: mc_create_variable(), mc_create_variable_from(), mc_get_variable_history(), mc_get_variable_info(), mc_list_variables(), mc_set_variable_value(), mc_set_variable_value_from()

Examples

## Not run: 
val <- mc_get_variable_value(conn, "myvar")

## End(Not run)

Description

Returns metadata about the wallet, such as version, balance, and encryption status.

Usage

mc_get_wallet_info(conn)

Arguments

Value

A list of wallet information.

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_privkey(), mc_dump_wallet(), mc_encrypt_wallet(), mc_import_privkey(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Retrieves detailed information about a transaction in the node's wallet.

Usage

mc_get_wallet_transaction(
  conn,
  txid,
  include_watch_only = FALSE,
  verbose = FALSE
)

Arguments

Value

A list containing detailed transaction data.

See Also

Other transactions: mc_get_address_balances(), mc_get_address_transaction(), mc_get_multi_balances(), mc_get_token_balances(), mc_get_total_balances(), mc_get_tx_out_data(), mc_list_address_transactions(), mc_list_wallet_transactions(), mc_send(), mc_send_asset(), mc_send_asset_from(), mc_send_from(), mc_send_with_data(), mc_send_with_data_from()

Description

Grants one or more permissions to a wallet address. Permissions control what actions an address can perform on the blockchain (e.g., connect, send, receive, mine, admin, etc.).

Usage

mc_grant(conn, address, permissions)

Arguments

Value

A character string containing the transaction ID (txid) of the grant.

See Also

mc_grant_from to specify the grantor, mc_revoke to revoke permissions, mc_list_permissions to view permissions.

Other permissions: mc_grant_from(), mc_grant_with_data(), mc_grant_with_data_from(), mc_list_permissions(), mc_revoke(), mc_revoke_from(), mc_verify_permission()

Examples

## Not run: 
# Grant connect and send permissions to an address
txid <- mc_grant(conn, "1A...", "connect,send")

## End(Not run)

Description

Grants permissions from a specified address (which must have admin or grant rights). This allows controlling which address pays for the transaction and acts as the grantor.

Usage

mc_grant_from(
  conn,
  from_address,
  to_address,
  permissions,
  native_amount = 0,
  start_block = NULL,
  end_block = NULL
)

Arguments

Value

A character string containing the transaction ID.

See Also

mc_grant, mc_revoke_from.

Other permissions: mc_grant(), mc_grant_with_data(), mc_grant_with_data_from(), mc_list_permissions(), mc_revoke(), mc_revoke_from(), mc_verify_permission()

Examples

## Not run: 
# Grant permissions from a specific admin address
txid <- mc_grant_from(conn, "admin1...", "user1...", "send,receive")

# Grant with a validity window
txid <- mc_grant_from(conn, "admin1...", "user1...", "mine",
                      start_block = 1000, end_block = 2000)

## End(Not run)

Description

Grants permissions and attaches arbitrary data (metadata) to the transaction. The data can be text, JSON, or any hex‑encoded value.

Usage

mc_grant_with_data(conn, to_address, permissions, data, native_amount = 0)

Arguments

Value

A character string containing the transaction ID.

See Also

mc_grant_with_data_from to specify the grantor.

Other permissions: mc_grant(), mc_grant_from(), mc_grant_with_data_from(), mc_list_permissions(), mc_revoke(), mc_revoke_from(), mc_verify_permission()

Examples

## Not run: 
# Grant with a text note
txid <- mc_grant_with_data(conn, "1A...", "send",
                           data = "Welcome to the network!")

# Grant with JSON metadata
metadata <- list(reason = "partnership", level = "full")
txid <- mc_grant_with_data(conn, "1A...", "connect,send",
                           data = metadata, native_amount = 0.1)

## End(Not run)

Description

Grants permissions from a specified address and includes metadata. Combines the capabilities of mc_grant_from and mc_grant_with_data.

Usage

mc_grant_with_data_from(
  conn,
  from_address,
  to_address,
  permissions,
  data,
  native_amount = 0
)

Arguments

Value

A character string containing the transaction ID.

See Also

mc_grant_with_data, mc_grant_from.

Other permissions: mc_grant(), mc_grant_from(), mc_grant_with_data(), mc_list_permissions(), mc_revoke(), mc_revoke_from(), mc_verify_permission()

Examples

## Not run: 
# Grant from a specific admin with metadata
txid <- mc_grant_with_data_from(conn, "admin1...", "user1...",
                                "send,receive",
                                data = list(note = "temporary access"),
                                native_amount = 0.01)

## End(Not run)

Description

Returns a list of all available RPC commands, or detailed help for a specific command. The result is printed in a human‑readable format.

Usage

mc_help(conn, command = NULL)

Arguments

Value

An object of class "mc_help" (inheriting from "character") that contains the help text and prints nicely via print.mc_help.

Examples

## Not run: 
# List all available commands
mc_help(conn)

# Get detailed help for the "getinfo" command
mc_help(conn, "getinfo")

## End(Not run)

Description

Adds an address (without a private key) to the node's wallet for monitoring. The node will be able to see transactions involving this address, but cannot spend funds from it.

Usage

mc_import_address(conn, address, label = "", rescan = TRUE)

Arguments

Value

Invisibly returns the RPC result (typically NULL) on success; throws an error if the import fails.

See Also

mc_validate_address to check address validity.

Other addresses: mc_add_multisig_address(), mc_create_keypairs(), mc_create_multisig(), mc_get_addresses(), mc_get_new_address(), mc_list_addresses(), mc_validate_address()

Examples

## Not run: 
mc_import_address(conn, "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
                  label = "donation", rescan = TRUE)

## End(Not run)

Description

Adds private keys to the node's wallet.

Usage

mc_import_privkey(conn, privkeys, label = "", rescan = TRUE)

Arguments

Value

Returns NULL on success.

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_privkey(), mc_dump_wallet(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_wallet(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Import keys from a wallet dump file

Usage

mc_import_wallet(conn, filename, rescan = 0)

Arguments

Value

Returns NULL on success.

See Also

Other wallet: mc_backup_wallet(), mc_change_wallet_passphrase(), mc_combine_unspent(), mc_dump_privkey(), mc_dump_wallet(), mc_encrypt_wallet(), mc_get_wallet_info(), mc_import_privkey(), mc_list_lock_unspent(), mc_list_unspent(), mc_lock_unspent(), mc_lock_wallet(), mc_unlock_wallet()

Description

Creates a new asset on the MultiChain blockchain. The asset can be fungible or non‑fungible, and its properties (e.g., open/restricted, divisible) are specified via the name parameter.

Usage

mc_issue(
  conn,
  address,
  name,
  quantity,
  units = 1,
  native_amount = NULL,
  custom_fields = NULL
)

Arguments

Value

A character string containing the transaction ID of the issuance.

See Also

mc_issue_from to issue from a specific address, mc_issue_more to increase supply of a fungible asset.

Other assets: mc_get_asset_info(), mc_get_token_info(), mc_issue_from(), mc_issue_more(), mc_issue_more_from(), mc_issue_token(), mc_issue_token_from(), mc_list_asset_issues(), mc_list_assets(), mc_update(), mc_update_from()

Examples

## Not run: 
# Issue a simple fungible asset
txid <- mc_issue(conn, "1A...", "mycoin", quantity = 1000, units = 0.01)

# Issue a restricted, non‑fungible asset with custom fields
params <- list(name = "artwork", open = FALSE, restrict = TRUE)
txid <- mc_issue(conn, "1A...", params, quantity = 1, units = 1,
                 custom_fields = list(author = "Picasso"))

## End(Not run)

Description

Issues a new asset, but allows specifying the sender address (which must have sufficient native currency to pay for the transaction). This is useful when the node has multiple addresses.

Usage

mc_issue_from(
  conn,
  from_address,
  to_address,
  name,
  quantity,
  units = 1,
  native_amount = NULL,
  custom_fields = NULL
)

Arguments

Value

A character string containing the transaction ID.

See Also

mc_issue for simpler issuance, mc_issue_more_from to increase supply.

Other assets: mc_get_asset_info(), mc_get_token_info(), mc_issue(), mc_issue_more(), mc_issue_more_from(), mc_issue_token(), mc_issue_token_from(), mc_list_asset_issues(), mc_list_assets(), mc_update(), mc_update_from()

Examples

## Not run: 
# Issue from a specific address to the same address
txid <- mc_issue_from(conn, from_address = "1A...", to_address = "1A...",
                      name = "myasset", quantity = 100)

## End(Not run)

Description

Increases the supply of a previously issued fungible asset. The asset must be open for further issuances (i.e., its open property must be TRUE).

Usage

mc_issue_more(
  conn,
  address,
  asset,
  quantity,
  native_amount = NULL,
  custom_fields = NULL
)

Arguments

Value

A character string containing the transaction ID.

See Also

mc_issue for initial issuance, mc_issue_more_from to issue from a specific address.

Other assets: mc_get_asset_info(), mc_get_token_info(), mc_issue(), mc_issue_from(), mc_issue_more_from(), mc_issue_token(), mc_issue_token_from(), mc_list_asset_issues(), mc_list_assets(), mc_update(), mc_update_from()

Examples

## Not run: 
# Increase supply of "mycoin" by 500 units
txid <- mc_issue_more(conn, "1A...", "mycoin", quantity = 500)

## End(Not run)

Description

Increases the supply of a fungible asset, specifying the address that pays for and initiates the transaction.

Usage

mc_issue_more_from(
  conn,
  from_address,
  to_address,
  asset,
  quantity,
  native_amount = NULL,
  custom_fields = NULL
)

Arguments