Struct ckb_sdk::tx_builder::cheque::ChequeWithdrawBuilder

pub struct ChequeWithdrawBuilder {
    pub out_points: Vec<OutPoint>,
    pub sender_lock_script: Script,
    pub acp_script_id: Option<ScriptId>,
}

Fields

out_points: Vec<OutPoint>

The cheque cells to withdraw, all cells must have same lock script and same type script and cell data length is equals to 16.

sender_lock_script: Script

Sender’s lock script, must be a sighash address, and the script hash must match the cheque cell’s lock script args.

acp_script_id: Option<ScriptId>

If acp_script_id provided, will withdraw to anyone-can-pay address

Implementations

impl ChequeWithdrawBuilder

pub fn new(
    out_points: Vec<OutPoint>,
    sender_lock_script: Script,
    acp_script_id: Option<ScriptId>
) -> ChequeWithdrawBuilder

Trait Implementations

impl TxBuilder for ChequeWithdrawBuilder

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.