Struct liquid_rpc::Client

pub struct Client(pub Client);

A Liquid RPC client.

This type implements both the bitcoincore_rpc::RpcApi trait as the [liquid_rpc::LiquidRpcApi] trait. Methods that are shared between Liquid and Bitcoin Core can be used from the former and changed or new methods are provided by the latter.

Implementations

impl Client

pub fn new(url: String, auth: Auth) -> Result<Self>

Creates a client to a liquidd JSON-RPC server.

pub fn from_jsonrpc(client: Client) -> Self

Create a new Client.

Trait Implementations

impl LiquidRpcApi for Client

fn call<T: for<'a> Deserialize<'a>>(
    &self,
    cmd: &str,
    args: &[Value]
) -> Result<T>

fn get_block_header_raw(&self, hash: &Hash) -> Result<BlockHeader>

fn get_block_header_verbose(&self, hash: &Hash) -> Result<GetBlockHeaderResult>

fn get_blockchain_info(&self) -> Result<GetBlockchainInfoResult>

Returns a data structure containing various state info regarding blockchain processing.

fn get_raw_transaction(
    &self,
    txid: &Hash,
    block_hash: Option<&Hash>
) -> Result<Transaction>

fn get_raw_transaction_verbose(
    &self,
    txid: &Hash,
    block_hash: Option<&Hash>
) -> Result<GetRawTransactionResult>

fn send_to_address(
    &self,
    address: &str,
    amount: f64,
    comment: Option<&str>,
    comment_to: Option<&str>,
    substract_fee: Option<bool>,
    replaceable: Option<bool>,
    confirmation_target: Option<u32>,
    estimate_mode: Option<EstimateMode>,
    asset_label: Option<&str>,
    ignore_blind_fail: Option<bool>
) -> Result<Hash>

fn create_raw_transaction_hex(
    &self,
    utxos: &[CreateRawTransactionInput],
    outs: &HashMap<String, f64>,
    locktime: Option<i64>,
    replaceable: Option<bool>,
    assets: Option<&HashMap<String, AssetId>>
) -> Result<String>

fn create_raw_transaction(
    &self,
    utxos: &[CreateRawTransactionInput],
    outs: &HashMap<String, f64>,
    locktime: Option<i64>,
    replaceable: Option<bool>,
    assets: Option<&HashMap<String, AssetId>>
) -> Result<Transaction>

fn fund_raw_transaction<R: RawTx>(
    &self,
    tx: R,
    options: Option<&FundRawTransactionOptions>,
    is_witness: Option<bool>
) -> Result<FundRawTransactionResult>

fn sign_raw_transaction_with_wallet<R: RawTx>(
    &self,
    tx: R,
    utxos: Option<&[SignRawTransactionInput]>,
    sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult>

fn sign_raw_transaction_with_key<R: RawTx>(
    &self,
    tx: R,
    privkeys: &[PrivateKey],
    prevtxs: Option<&[SignRawTransactionInput]>,
    sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult>

We use [bitcoin::PrivateKey] because the keys need to be WIF-encoded. Use [bitcoin::Network::Bitcoin] for Liquid and [bitcoin::Network::Regtest] for Elements Regtest.

fn send_raw_transaction<R: RawTx>(&self, tx: R) -> Result<Hash>

fn list_unspent(
    &self,
    minconf: Option<usize>,
    maxconf: Option<usize>,
    addresses: Option<&[&str]>,
    include_unsafe: Option<bool>,
    query_options: Option<&ListUnspentQueryOptions>
) -> Result<Vec<ListUnspentResultEntry>>

fn list_transactions(
    &self,
    count: Option<usize>,
    skip: Option<usize>,
    include_watch_only: Option<bool>
) -> Result<Vec<ListTransactionsResultEntry>>

fn list_since_block(
    &self,
    block_hash: Option<&Hash>,
    target_confirmations: Option<u32>,
    include_watch_only: Option<bool>,
    include_removed: Option<bool>
) -> Result<ListSinceBlockResult>

fn get_new_address(
    &self,
    label: Option<&str>,
    address_type: Option<AddressType>
) -> Result<String>

fn get_raw_change_address(
    &self,
    address_type: Option<AddressType>
) -> Result<String>

fn validate_address(&self, address: &str) -> Result<ValidateAddressResult>

fn get_address_info(&self, address: &str) -> Result<GetAddressInfoResult>

fn get_tx_out(
    &self,
    txid: &Hash,
    vout: u32,
    include_mempool: Option<bool>
) -> Result<Option<GetTxOutResult>>

fn get_balance(
    &self,
    min_confirmations: Option<u32>,
    include_watch_only: Option<bool>
) -> Result<HashMap<String, Amount>>

fn get_balance_asset(
    &self,
    asset_label: &str,
    min_confirmations: Option<u32>,
    include_watch_only: Option<bool>
) -> Result<Amount>

fn get_unconfirmed_balance(&self) -> Result<HashMap<String, Amount>>

fn get_received_by_address(
    &self,
    address: &str,
    min_confirmations: Option<u32>
) -> Result<HashMap<String, Amount>>

fn get_received_by_address_asset(
    &self,
    address: &str,
    asset_label: &str,
    min_confirmations: Option<u32>
) -> Result<Amount>

fn get_sidechain_info(&self) -> Result<GetSidechainInfoResult>

fn get_pegin_address(&self) -> Result<GetPeginAddressResult>

fn create_raw_pegin<R: RawTx, B: AsRef<[u8]>>(
    &self,
    raw_bitcoin_tx: R,
    txout_proof: B,
    claim_script: Option<&Script>
) -> Result<CreateRawPeginResult>

fn claim_pegin<R: RawTx, B: AsRef<[u8]>>(
    &self,
    raw_bitcoin_tx: R,
    txout_proof: B,
    claim_script: Option<&Script>
) -> Result<Hash>

fn init_pegout_wallet(
    &self,
    bitcoin_descriptor: &ExtendedPubKey,
    bip32_counter: Option<ChildNumber>,
    liquid_pak: Option<&str>
) -> Result<InitPegoutWalletResult>

fn send_to_main_chain(
    &self,
    amount: Amount,
    subtract_fee_from_amount: Option<bool>
) -> Result<SendToMainChainResult>

fn get_wallet_pak_info(&self) -> Result<GetWalletPakInfoResult>

fn get_pak_info(&self) -> Result<GetPakInfoResult>

fn tweak_fedpeg_script(
    &self,
    claim_script: &Script
) -> Result<TweakFedpegScriptResult>

fn list_issuances(
    &self,
    asset: Option<AssetId>
) -> Result<Vec<ListIssuancesResult>>

fn issue_asset(
    &self,
    asset_amount: Amount,
    token_amount: Amount,
    blind: Option<bool>
) -> Result<IssueAssetResult>

fn reissue_asset(
    &self,
    asset: AssetId,
    asset_amount: Amount
) -> Result<ReissueAssetResult>

fn raw_issue_asset<R: RawTx>(
    &self,
    raw_tx: R,
    issuances: &[RawIssuanceDetails]
) -> Result<IssueAssetResult>

fn raw_reissue_asset<R: RawTx>(
    &self,
    raw_tx: R,
    issuances: &[RawReissuanceDetails]
) -> Result<RawReissueAssetResult>

fn dump_asset_labels(&self) -> Result<HashMap<String, AssetId>>

fn destroy_amount(
    &self,
    asset: AssetId,
    amount: Amount,
    comment: Option<&str>
) -> Result<Hash>

fn blind_raw_transaction<R: RawTx, B: AsRef<[u8]>>(
    &self,
    raw_tx: R,
    ignore_blind_fail: Option<bool>,
    asset_commitments: Option<&[B]>,
    blind_issuances: Option<bool>
) -> Result<Transaction>

fn unblind_raw_transaction<R: RawTx>(
    &self,
    raw_tx: R
) -> Result<UnblindRawTransactionResult>

fn raw_blind_raw_transaction<R: RawTx, B: AsRef<[u8]>>(
    &self,
    raw_tx: R,
    input_amount_blinding_factors: &[B],
    input_amounts: &[Amount],
    input_assets: &[AssetId],
    input_asset_blinding_factors: &[B],
    ignore_blind_fail: Option<bool>
) -> Result<Transaction>

fn create_blinded_address(
    &self,
    address: &str,
    blinding_pubkey: &PublicKey
) -> Result<String>

fn dump_blinding_key(&self, address: &str) -> Result<SecretKey>

fn import_blinding_key(
    &self,
    address: &str,
    blinding_key: &SecretKey
) -> Result<()>

fn dump_master_blinding_key(&self) -> Result<SecretKey>

fn import_master_blinding_key(
    &self,
    master_blinding_key: &SecretKey
) -> Result<()>

fn dump_issuance_blinding_key(&self, txid: &Hash, vin: u32) -> Result<SecretKey>

fn import_issuance_blinding_key(
    &self,
    txid: &Hash,
    vin: u32,
    blinding_key: &SecretKey
) -> Result<()>

fn get_new_block(&self, min_tx_age_secs: Option<usize>) -> Result<Block>

fn sign_block(&self, block: &Block) -> Result<Vec<SignedBlockSignature>>

fn combine_block_signatures(
    &self,
    block: &Block,
    signatures: &[SignedBlockSignature]
) -> Result<CombineBlockSigsResult>

fn test_proposed_block(
    &self,
    block: &Block,
    accept_non_standard: Option<bool>
) -> Result<()>

fn submit_block(&self, block: &Block) -> Result<String>

impl RpcApi for Client

fn call<T: for<'a> Deserialize<'a>>(
    &self,
    cmd: &str,
    args: &[Value]
) -> Result<T>

Call a cmd rpc with given args list

fn get_by_id<T>(&self, id: &<T as Queryable<Self>>::Id) -> Result<T, Error> where
    T: Queryable<Self>, 

Query an object implementing Querable type

fn get_network_info(&self) -> Result<GetNetworkInfoResult, Error>

fn version(&self) -> Result<usize, Error>

fn add_multisig_address(
    &self,
    nrequired: usize,
    keys: &[PubKeyOrAddress],
    label: Option<&str>,
    address_type: Option<AddressType>
) -> Result<AddMultiSigAddressResult, Error>

fn load_wallet(&self, wallet: &str) -> Result<LoadWalletResult, Error>

fn unload_wallet(&self, wallet: Option<&str>) -> Result<(), Error>

fn create_wallet(
    &self,
    wallet: &str,
    disable_private_keys: Option<bool>
) -> Result<LoadWalletResult, Error>

fn backup_wallet(&self, destination: Option<&str>) -> Result<(), Error>

fn dump_private_key(&self, address: &Address) -> Result<PrivateKey, Error>

fn encrypt_wallet(&self, passphrase: &str) -> Result<(), Error>

fn get_difficulty(&self) -> Result<f64, Error>

fn get_connection_count(&self) -> Result<usize, Error>

fn get_block(&self, hash: &BlockHash) -> Result<Block, Error>

fn get_block_hex(&self, hash: &BlockHash) -> Result<String, Error>

fn get_block_info(&self, hash: &BlockHash) -> Result<GetBlockResult, Error>

fn get_block_header(&self, hash: &BlockHash) -> Result<BlockHeader, Error>

fn get_block_header_info(
    &self,
    hash: &BlockHash
) -> Result<GetBlockHeaderResult, Error>

fn get_mining_info(&self) -> Result<GetMiningInfoResult, Error>

fn get_blockchain_info(&self) -> Result<GetBlockchainInfoResult, Error>

Returns a data structure containing various state info regarding blockchain processing.

fn get_block_count(&self) -> Result<u64, Error>

Returns the numbers of block in the longest chain.

fn get_best_block_hash(&self) -> Result<BlockHash, Error>

Returns the hash of the best (tip) block in the longest blockchain.

fn get_block_hash(&self, height: u64) -> Result<BlockHash, Error>

Get block hash at a given height

fn get_raw_transaction(
    &self,
    txid: &Txid,
    block_hash: Option<&BlockHash>
) -> Result<Transaction, Error>

fn get_raw_transaction_hex(
    &self,
    txid: &Txid,
    block_hash: Option<&BlockHash>
) -> Result<String, Error>

fn get_raw_transaction_info(
    &self,
    txid: &Txid,
    block_hash: Option<&BlockHash>
) -> Result<GetRawTransactionResult, Error>

fn get_block_filter(
    &self,
    block_hash: &BlockHash
) -> Result<GetBlockFilterResult, Error>

fn get_balance(
    &self,
    minconf: Option<usize>,
    include_watchonly: Option<bool>
) -> Result<Amount, Error>

fn get_received_by_address(
    &self,
    address: &Address,
    minconf: Option<u32>
) -> Result<Amount, Error>

fn get_transaction(
    &self,
    txid: &Txid,
    include_watchonly: Option<bool>
) -> Result<GetTransactionResult, Error>

fn list_transactions(
    &self,
    label: Option<&str>,
    count: Option<usize>,
    skip: Option<usize>,
    include_watchonly: Option<bool>
) -> Result<Vec<ListTransactionResult>, Error>

fn get_tx_out(
    &self,
    txid: &Txid,
    vout: u32,
    include_mempool: Option<bool>
) -> Result<Option<GetTxOutResult>, Error>

fn get_tx_out_proof(
    &self,
    txids: &[Txid],
    block_hash: Option<&BlockHash>
) -> Result<Vec<u8>, Error>

fn import_public_key(
    &self,
    pubkey: &PublicKey,
    label: Option<&str>,
    rescan: Option<bool>
) -> Result<(), Error>

fn import_private_key(
    &self,
    privkey: &PrivateKey,
    label: Option<&str>,
    rescan: Option<bool>
) -> Result<(), Error>

fn import_address(
    &self,
    address: &Address,
    label: Option<&str>,
    rescan: Option<bool>
) -> Result<(), Error>

fn import_address_script(
    &self,
    script: &Script,
    label: Option<&str>,
    rescan: Option<bool>,
    p2sh: Option<bool>
) -> Result<(), Error>

fn import_multi(
    &self,
    requests: &[ImportMultiRequest],
    options: Option<&ImportMultiOptions>
) -> Result<Vec<ImportMultiResult>, Error>

fn set_label(&self, address: &Address, label: &str) -> Result<(), Error>

fn key_pool_refill(&self, new_size: Option<usize>) -> Result<(), Error>

fn list_unspent(
    &self,
    minconf: Option<usize>,
    maxconf: Option<usize>,
    addresses: Option<&[&Address]>,
    include_unsafe: Option<bool>,
    query_options: Option<ListUnspentQueryOptions>
) -> Result<Vec<ListUnspentResultEntry>, Error>

fn lock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error>

To unlock, use [unlock_unspent].

fn unlock_unspent(&self, outputs: &[OutPoint]) -> Result<bool, Error>

fn list_received_by_address(
    &self,
    address_filter: Option<&Address>,
    minconf: Option<u32>,
    include_empty: Option<bool>,
    include_watchonly: Option<bool>
) -> Result<Vec<ListReceivedByAddressResult>, Error>

fn create_raw_transaction_hex(
    &self,
    utxos: &[CreateRawTransactionInput],
    outs: &HashMap<String, Amount, RandomState>,
    locktime: Option<i64>,
    replaceable: Option<bool>
) -> Result<String, Error>

fn create_raw_transaction(
    &self,
    utxos: &[CreateRawTransactionInput],
    outs: &HashMap<String, Amount, RandomState>,
    locktime: Option<i64>,
    replaceable: Option<bool>
) -> Result<Transaction, Error>

fn fund_raw_transaction<R>(
    &self,
    tx: R,
    options: Option<&FundRawTransactionOptions>,
    is_witness: Option<bool>
) -> Result<FundRawTransactionResult, Error> where
    R: RawTx, 

fn sign_raw_transaction<R>(
    &self,
    tx: R,
    utxos: Option<&[SignRawTransactionInput]>,
    private_keys: Option<&[PrivateKey]>,
    sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
    R: RawTx, 

👎 Deprecated

fn sign_raw_transaction_with_wallet<R>(
    &self,
    tx: R,
    utxos: Option<&[SignRawTransactionInput]>,
    sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
    R: RawTx, 

fn sign_raw_transaction_with_key<R>(
    &self,
    tx: R,
    privkeys: &[PrivateKey],
    prevtxs: Option<&[SignRawTransactionInput]>,
    sighash_type: Option<SigHashType>
) -> Result<SignRawTransactionResult, Error> where
    R: RawTx, 

fn test_mempool_accept<R>(
    &self,
    rawtxs: &[R]
) -> Result<Vec<TestMempoolAcceptResult>, Error> where
    R: RawTx, 

fn stop(&self) -> Result<String, Error>

fn verify_message(
    &self,
    address: &Address,
    signature: &Signature,
    message: &str
) -> Result<bool, Error>

fn get_new_address(
    &self,
    label: Option<&str>,
    address_type: Option<AddressType>
) -> Result<Address, Error>

Generate new address under own control

fn get_address_info(
    &self,
    address: &Address
) -> Result<GetAddressInfoResult, Error>

fn generate_to_address(
    &self,
    block_num: u64,
    address: &Address
) -> Result<Vec<BlockHash>, Error>

Mine block_num blocks and pay coinbase to address

fn generate(
    &self,
    block_num: u64,
    maxtries: Option<u64>
) -> Result<Vec<BlockHash>, Error>

Mine up to block_num blocks immediately (before the RPC call returns) to an address in the wallet.

fn invalidate_block(&self, block_hash: &BlockHash) -> Result<(), Error>

Mark a block as invalid by block_hash

fn reconsider_block(&self, block_hash: &BlockHash) -> Result<(), Error>

Mark a block as valid by block_hash

fn get_raw_mempool(&self) -> Result<Vec<Txid>, Error>

Get txids of all transactions in a memory pool

fn send_to_address(
    &self,
    address: &Address,
    amount: Amount,
    comment: Option<&str>,
    comment_to: Option<&str>,
    subtract_fee: Option<bool>,
    replaceable: Option<bool>,
    confirmation_target: Option<u32>,
    estimate_mode: Option<EstimateMode>
) -> Result<Txid, Error>

fn get_peer_info(&self) -> Result<Vec<GetPeerInfoResult>, Error>

Returns data about each connected network node as an array of [PeerInfo][]

fn ping(&self) -> Result<(), Error>

Requests that a ping be sent to all other nodes, to measure ping time.

fn send_raw_transaction<R>(&self, tx: R) -> Result<Txid, Error> where
    R: RawTx, 

fn estimate_smart_fee(
    &self,
    conf_target: u16,
    estimate_mode: Option<EstimateMode>
) -> Result<EstimateSmartFeeResult, Error>

fn wait_for_new_block(&self, timeout: u64) -> Result<BlockRef, Error>

Waits for a specific new block and returns useful info about it. Returns the current block on timeout or exit.

fn wait_for_block(
    &self,
    blockhash: &BlockHash,
    timeout: u64
) -> Result<BlockRef, Error>

Waits for a specific new block and returns useful info about it. Returns the current block on timeout or exit.

fn wallet_create_funded_psbt(
    &self,
    inputs: &[CreateRawTransactionInput],
    outputs: &HashMap<String, Amount, RandomState>,
    locktime: Option<i64>,
    options: Option<WalletCreateFundedPsbtOptions>,
    bip32derivs: Option<bool>
) -> Result<WalletCreateFundedPsbtResult, Error>

fn get_descriptor_info(
    &self,
    desc: &str
) -> Result<GetDescriptorInfoResult, Error>

fn combine_psbt(&self, psbts: &[String]) -> Result<String, Error>

fn finalize_psbt(
    &self,
    psbt: &str,
    extract: Option<bool>
) -> Result<FinalizePsbtResult, Error>

fn derive_addresses(
    &self,
    descriptor: &str,
    range: Option<[u32; 2]>
) -> Result<Vec<Address>, Error>

fn rescan_blockchain(
    &self,
    start_from: Option<usize>,
    stop_height: Option<usize>
) -> Result<(usize, Option<usize>), Error>