Struct ckb_sdk::tx_builder::transfer::CapacityTransferBuilder

pub struct CapacityTransferBuilder {
    pub outputs: Vec<(CellOutput, Bytes)>,
}

A builder to build a transaction simply transfer capcity to an address. It will resolve the type script’s cell_dep if given.

Fields

outputs: Vec<(CellOutput, Bytes)>

Implementations

impl CapacityTransferBuilder

pub fn new(outputs: Vec<(CellOutput, Bytes)>) -> CapacityTransferBuilder

Trait Implementations

impl TxBuilder for CapacityTransferBuilder

fn build_base(
    &self,
    _cell_collector: &mut dyn CellCollector,
    cell_dep_resolver: &dyn CellDepResolver,
    _header_dep_resolver: &dyn HeaderDepResolver,
    _tx_dep_provider: &dyn TransactionDependencyProvider
) -> Result<TransactionView, TxBuilderError>

Build base transaction

fn build_balanced(
    &self,
    cell_collector: &mut dyn CellCollector,
    cell_dep_resolver: &dyn CellDepResolver,
    header_dep_resolver: &dyn HeaderDepResolver,
    tx_dep_provider: &dyn TransactionDependencyProvider,
    balancer: &CapacityBalancer,
    unlockers: &HashMap<ScriptId, Box<dyn ScriptUnlocker>>
) -> Result<TransactionView, TxBuilderError>

Build balanced transaction that ready to sign:

fn build_unlocked(
    &self,
    cell_collector: &mut dyn CellCollector,
    cell_dep_resolver: &dyn CellDepResolver,
    header_dep_resolver: &dyn HeaderDepResolver,
    tx_dep_provider: &dyn TransactionDependencyProvider,
    balancer: &CapacityBalancer,
    unlockers: &HashMap<ScriptId, Box<dyn ScriptUnlocker>>
) -> Result<(TransactionView, Vec<ScriptGroup>), TxBuilderError>

Build unlocked transaction that ready to send or for further unlock:

fn build_balance_unlocked(
    &self,
    cell_collector: &mut dyn CellCollector,
    cell_dep_resolver: &dyn CellDepResolver,
    header_dep_resolver: &dyn HeaderDepResolver,
    tx_dep_provider: &dyn TransactionDependencyProvider,
    balancer: &CapacityBalancer,
    unlockers: &HashMap<ScriptId, Box<dyn ScriptUnlocker>>
) -> Result<(TransactionView, Vec<ScriptGroup>), TxBuilderError>

Build unlocked transaction that ready to send or for further unlock, it’s similar to build_unlocked, except it will try to check the consumed cycles limitation: If all input unlocked, and transaction fee can not meet the required transaction fee rate because of a big estimated cycles, it will tweak the change cell capacity or collect more cells to balance the transaction.