R Interface to the 'MultiChain' Blockchain RPC API

---

Documentation for package ‘multichainr’ version 0.1.0

• DESCRIPTION file.
• User guides, package vignettes and other documentation.

Help Pages

H M N P misc

-- H --

hex_to_char

Decode hex string to character

-- M --

mc_add_library_update	Add an update to an existing library
mc_add_library_update_from	Add an update to a library from a specific address
mc_add_multisig_address	Add a multi-signature address
mc_add_node	Add or remove a peer-to-peer connection
mc_append_binary_cache	Append data to a binary cache item
mc_append_raw_change	Add a change output to a raw transaction
mc_append_raw_data	Add metadata to a raw transaction
mc_append_raw_exchange	Add to a raw atomic exchange transaction
mc_append_raw_transaction	Add inputs and outputs to a raw transaction
mc_approve_from	Approve or disapprove an upgrade or filter
mc_backup_wallet	Backup the wallet file
mc_change_wallet_passphrase	Change the wallet passphrase
mc_clear_mempool	Clear the node's memory pool
mc_combine_unspent	Combine unspent outputs (UTXOs)
mc_complete_raw_exchange	Finalize an atomic exchange transaction
mc_connect	Create a MultiChain connection object
mc_create_binary_cache	Create a new binary cache item
mc_create_keypairs	Create new key pairs
mc_create_library	Create a new library
mc_create_multisig	Create multi-signature address (external)
mc_create_raw_exchange	Create a new atomic exchange transaction
mc_create_raw_send_from	Create and fund a raw transaction from a specific address
mc_create_raw_transaction	Create a raw transaction
mc_create_stream	Create a new stream
mc_create_stream_filter	Create a stream filter
mc_create_stream_from	Create a new stream from a specific address
mc_create_tx_filter	Create a transaction filter
mc_create_upgrade	Create a blockchain upgrade
mc_create_variable	Create a new variable
mc_create_variable_from	Create a variable from a specific address
mc_decode_raw_exchange	Decode a raw exchange transaction
mc_decode_raw_transaction	Decode a raw transaction hex
mc_delete_binary_cache	Delete an item from the binary cache
mc_disable_raw_transaction	Disable an offer of exchange
mc_dump_privkey	Dump a private key for an address
mc_dump_wallet	Dump all private keys to a file
mc_encrypt_wallet	Encrypt the wallet
mc_get_added_node_info	Get information about manually added nodes
mc_get_addresses	Get node wallet addresses
mc_get_address_balances	Get asset balances for a specific address
mc_get_address_transaction	Get details of a transaction for a specific address
mc_get_asset_info	Get information about a specific asset
mc_get_asset_transaction	Get a specific transaction involving a subscribed asset
mc_get_block	Get block information
mc_get_blockchain_info	Get general blockchain information
mc_get_blockchain_params	Get blockchain parameters
mc_get_block_hash	Get block hash by height
mc_get_chain_totals	Get counts of blockchain entities
mc_get_chunk_queue_info	Get information about off-chain chunk queue
mc_get_chunk_queue_totals	Get cumulative statistics on off-chain chunk requests
mc_get_config	Get MultiChain configuration
mc_get_filter_code	Get JavaScript code of a filter
mc_get_info	Get general node information
mc_get_init_status	Get node initialization status
mc_get_last_block_info	Get information about the last block
mc_get_library_code	Get JavaScript code for a library
mc_get_mempool_info	Get memory pool information
mc_get_multi_balances	Get balances for multiple addresses and assets
mc_get_network_info	Get information about node's network status
mc_get_new_address	Create new wallet address
mc_get_peer_info	Get information about connected peers
mc_get_raw_mempool	Get list of transaction IDs in mempool
mc_get_raw_transaction	Get a raw transaction from the blockchain
mc_get_runtime_params	Get node runtime parameters
mc_get_stream_info	Get information about a specific stream
mc_get_stream_item	Get a specific item from a stream
mc_get_stream_key_summary	Get summary of JSON objects in a stream for a specific key
mc_get_stream_publisher_summary	Get summary of JSON objects published by a specific address
mc_get_token_balances	Get balances for non-fungible tokens (NFTs)
mc_get_token_info	Get information about a specific token (MultiChain 2.2.1+)
mc_get_total_balances	Get total wallet balances
mc_get_tx_out	Get details about an unspent transaction output
mc_get_tx_out_data	Retrieve full hex data from a transaction output
mc_get_variable_history	List historical values of a variable
mc_get_variable_info	Get information about a variable
mc_get_variable_value	Retrieve the latest value of a variable
mc_get_wallet_info	Get general wallet information
mc_get_wallet_transaction	Get details of a wallet transaction
mc_grant	Grant permissions to an address
mc_grant_from	Grant permissions from a specific address
mc_grant_with_data	Grant permissions with metadata
mc_grant_with_data_from	Grant permissions from a specific address with metadata
mc_help	Get help for MultiChain commands
mc_import_address	Import a watch-only address
mc_import_privkey	Import one or more private keys
mc_import_wallet	Import keys from a wallet dump file
mc_issue	Issue new asset
mc_issue_from	Issue new asset from specific address
mc_issue_more	Issue more of an existing fungible asset
mc_issue_more_from	Issue more of an asset from specific address
mc_issue_token	Issue tokens for a non-fungible asset (NFT)
mc_issue_token_from	Issue tokens from specific address
mc_list_addresses	List addresses in the wallet
mc_list_address_transactions	List transactions for a specific address
mc_list_assets	List blockchain assets
mc_list_asset_issues	List issuance events for an asset
mc_list_asset_transactions	List transactions involving a subscribed asset
mc_list_blocks	List information about specific blocks
mc_list_libraries	List libraries on the blockchain
mc_list_lock_unspent	List locked unspent outputs
mc_list_miners	List miners and their status
mc_list_permissions	List network permissions
mc_list_stored_nodes	List known peer node addresses (MultiChain 2.3+)
mc_list_streams	List streams on the blockchain
mc_list_stream_block_items	List items in a specific block or blocks
mc_list_stream_filters	List stream filters
mc_list_stream_items	List items in a stream (Enhanced version)
mc_list_stream_keys	List unique keys in a stream
mc_list_stream_key_items	List items with a specific key
mc_list_stream_publishers	List publishers who have written to a stream
mc_list_stream_publisher_items	List items published by a specific address
mc_list_stream_query_items	Query items by matching keys and publishers
mc_list_stream_tx_items	List items in stream within a given transaction ID
mc_list_tx_filters	List transaction filters
mc_list_unspent	List unspent transaction outputs
mc_list_upgrades	List upgrades
mc_list_variables	List variables created on the blockchain
mc_list_wallet_transactions	List transactions in the wallet
mc_lock_unspent	Lock or unlock unspent outputs
mc_lock_wallet	Immediately lock the wallet
mc_node_init	Initialize a new MultiChain blockchain
mc_node_start	Start a MultiChain node
mc_node_stop	Stop a MultiChain node
mc_pause	Pause specified node tasks
mc_ping	Ping all connected peers
mc_prepare_lock_unspent	Prepare an unspent transaction output for exchange
mc_prepare_lock_unspent_from	Prepare an unspent output from a specific address
mc_publish	Publish an item to a stream
mc_publish_from	Publish an item to a stream from a specific address
mc_publish_multi	Publish multiple items to a stream in one transaction
mc_publish_multi_from	Publish multiple items from a specific address
mc_resume	Resume specified node tasks
mc_revoke	Revoke permissions from an address
mc_revoke_from	Revoke permissions from a specific address
mc_run_stream_filter	Run an existing stream filter against an item
mc_run_tx_filter	Run an existing transaction filter against a transaction
mc_send	Send payment or assets to an address
mc_send_asset	Send a single asset to an address
mc_send_asset_from	Send a single asset from a specific address
mc_send_from	Send payment from a specific address
mc_send_raw_transaction	Send a signed raw transaction to the network
mc_send_with_data	Send payment with inline metadata
mc_send_with_data_from	Send payment from specific address with metadata
mc_set_last_block	Rewind the node's active chain
mc_set_path	Set path to MultiChain binaries
mc_set_runtime_param	Set node runtime parameter
mc_set_variable_value	Set the value of a variable
mc_set_variable_value_from	Set variable value from specific address
mc_sign_message	Sign a message with a private key
mc_sign_raw_transaction	Sign a raw transaction
mc_store_node	Add an IP address to known peer nodes (MultiChain 2.3+)
mc_subscribe	Subscribe to MultiChain assets or streams
mc_test_library	Manage testing of libraries and updates locally
mc_test_stream_filter	Test a stream filter before creation
mc_test_tx_filter	Test a transaction filter before creation
mc_txout_to_binary_cache	Extract transaction output data to binary cache
mc_unlock_wallet	Unlock the wallet with a passphrase
mc_unsubscribe	Unsubscribe from MultiChain assets or streams
mc_update	Update asset status (open/closed)
mc_update_from	Update asset status from specific address
mc_validate_address	Validate or inspect an address
mc_verify_message	Verify a signed message
mc_verify_permission	Verify if an address has a specific permission
mc_wait_for_confirmation	Wait for transaction confirmation

-- N --

null_default

Null-default operator

-- P --

print.mc_help	Print MultiChain help
print.multichain_conn	Print MultiChain connection

-- misc --

%||%	Null-default operator