pub struct MinOutputAdaCalculator { /* private fields */ }Implementations§
source§impl MinOutputAdaCalculator
impl MinOutputAdaCalculator
sourcepub fn new(output: &TransactionOutput, data_cost: &DataCost) -> Self
pub fn new(output: &TransactionOutput, data_cost: &DataCost) -> Self
sourcepub fn new_empty(
data_cost: &DataCost
) -> Result<MinOutputAdaCalculator, JsError>
pub fn new_empty(
data_cost: &DataCost
) -> Result<MinOutputAdaCalculator, JsError>
Examples found in repository?
src/utils.rs (line 1442)
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
pub fn min_ada_required(
assets: &Value,
has_data_hash: bool, // whether the output includes a data hash
coins_per_utxo_word: &BigNum, // protocol parameter (in lovelace)
) -> Result<BigNum, JsError> {
let data_cost = DataCost::new_coins_per_word(coins_per_utxo_word);
let mut calc = MinOutputAdaCalculator::new_empty(&data_cost)?;
calc.set_amount(assets);
if has_data_hash {
calc.set_data_hash(&fake_data_hash(0));
}
calc.calculate_ada()
}More examples
src/tx_builder.rs (line 1391)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
pub fn add_change_if_needed(&mut self, address: &Address) -> Result<bool, JsError> {
let fee = match &self.fee {
None => self.min_fee(),
// generating the change output involves changing the fee
Some(_x) => {
return Err(JsError::from_str(
"Cannot calculate change if fee was explicitly specified",
))
}
}?;
// note: can't add plutus data or data hash and script to change
// because we don't know how many change outputs will need to be created
let plutus_data: Option<DataOption> = None;
let script_ref: Option<ScriptRef> = None;
let input_total = self.get_total_input()?;
let output_total = self.get_total_output()?;
let shortage = get_input_shortage(&input_total, &output_total, &fee)?;
if let Some(shortage) = shortage {
return Err(JsError::from_str(&format!("Insufficient input in transaction. {}", shortage)));
}
use std::cmp::Ordering;
match &input_total.partial_cmp(&output_total.checked_add(&Value::new(&fee))?) {
Some(Ordering::Equal) => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&input_total.checked_sub(&output_total)?.coin());
Ok(false)
}
Some(Ordering::Less) => Err(JsError::from_str("Insufficient input in transaction")),
Some(Ordering::Greater) => {
fn has_assets(ma: Option<MultiAsset>) -> bool {
ma.map(|assets| assets.len() > 0).unwrap_or(false)
}
let change_estimator = input_total.checked_sub(&output_total)?;
if has_assets(change_estimator.multiasset()) {
fn will_adding_asset_make_output_overflow(
output: &TransactionOutput,
current_assets: &Assets,
asset_to_add: (PolicyID, AssetName, BigNum),
max_value_size: u32,
data_cost: &DataCost,
) -> Result<bool, JsError> {
let (policy, asset_name, value) = asset_to_add;
let mut current_assets_clone = current_assets.clone();
current_assets_clone.insert(&asset_name, &value);
let mut amount_clone = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut ma = MultiAsset::new();
ma.insert(&policy, ¤t_assets_clone);
val.set_multiasset(&ma);
amount_clone = amount_clone.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
Ok(amount_clone.to_bytes().len() > max_value_size as usize)
}
fn pack_nfts_for_change(
max_value_size: u32,
data_cost: &DataCost,
change_address: &Address,
change_estimator: &Value,
plutus_data: &Option<DataOption>,
script_ref: &Option<ScriptRef>,
) -> Result<Vec<MultiAsset>, JsError> {
// we insert the entire available ADA temporarily here since that could potentially impact the size
// as it could be 1, 2 3 or 4 bytes for Coin.
let mut change_assets: Vec<MultiAsset> = Vec::new();
let mut base_coin = Value::new(&change_estimator.coin());
base_coin.set_multiasset(&MultiAsset::new());
let mut output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// If this becomes slow on large TXs we can optimize it like the following
// to avoid cloning + reserializing the entire output.
// This would probably be more relevant if we use a smarter packing algorithm
// which might need to compare more size differences than greedy
//let mut bytes_used = output.to_bytes().len();
// a greedy packing is done here to avoid an exponential bin-packing
// which in most cases likely shouldn't be the difference between
// having an extra change output or not unless there are gigantic
// differences in NFT policy sizes
for (policy, assets) in change_estimator.multiasset().unwrap().0.iter() {
// for simplicity we also don't split assets within a single policy since
// you would need to have a very high amoun of assets (which add 1-36 bytes each)
// in a single policy to make a difference. In the future if this becomes an issue
// we can change that here.
// this is the other part of the optimization but we need to take into account
// the difference between CBOR encoding which can change which happens in two places:
// a) length within assets of one policy id
// b) length of the entire multiasset
// so for simplicity we will just do it the safe, naive way unless
// performance becomes an issue.
//let extra_bytes = policy.to_bytes().len() + assets.to_bytes().len() + 2 + cbor_len_diff;
//if bytes_used + extra_bytes <= max_value_size as usize {
let mut old_amount = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut next_nft = MultiAsset::new();
let asset_names = assets.keys();
let mut rebuilt_assets = Assets::new();
for n in 0..asset_names.len() {
let asset_name = asset_names.get(n);
let value = assets.get(&asset_name).unwrap();
if will_adding_asset_make_output_overflow(
&output,
&rebuilt_assets,
(policy.clone(), asset_name.clone(), value),
max_value_size,
data_cost,
)? {
// if we got here, this means we will run into a overflow error,
// so we want to split into multiple outputs, for that we...
// 1. insert the current assets as they are, as this won't overflow
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
change_assets.push(output.amount.multiasset().unwrap());
// 2. create a new output with the base coin value as zero
base_coin = Value::new(&Coin::zero());
base_coin.set_multiasset(&MultiAsset::new());
output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// 3. continue building the new output from the asset we stopped
old_amount = output.amount.clone();
val = Value::new(&Coin::zero());
next_nft = MultiAsset::new();
rebuilt_assets = Assets::new();
}
rebuilt_assets.insert(&asset_name, &value);
}
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut amount_clone = output.amount.clone();
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
if amount_clone.to_bytes().len() > max_value_size as usize {
output.amount = old_amount;
break;
}
}
change_assets.push(output.amount.multiasset().unwrap());
Ok(change_assets)
}
let mut change_left = input_total.checked_sub(&output_total)?;
let mut new_fee = fee.clone();
// we might need multiple change outputs for cases where the change has many asset types
// which surpass the max UTXO size limit
let utxo_cost = self.config.utxo_cost();
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let minimum_utxo_val = calc.calculate_ada()?;
while let Some(Ordering::Greater) = change_left
.multiasset
.as_ref()
.map_or_else(|| None, |ma| ma.partial_cmp(&MultiAsset::new()))
{
let nft_changes = pack_nfts_for_change(
self.config.max_value_size,
&utxo_cost,
address,
&change_left,
&plutus_data.clone(),
&script_ref.clone(),
)?;
if nft_changes.len() == 0 {
// this likely should never happen
return Err(JsError::from_str("NFTs too large for change output"));
}
// we only add the minimum needed (for now) to cover this output
let mut change_value = Value::new(&Coin::zero());
for nft_change in nft_changes.iter() {
change_value.set_multiasset(&nft_change);
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
//TODO add precise calculation
let mut fake_change = change_value.clone();
fake_change.set_coin(&change_left.coin);
calc.set_amount(&fake_change);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => {
calc.set_data_hash(data_hash)
}
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
change_value.set_coin(&min_ada);
let change_output = TransactionOutput {
address: address.clone(),
amount: change_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// increase fee
let fee_for_change = self.fee_for_output(&change_output)?;
new_fee = new_fee.checked_add(&fee_for_change)?;
if change_left.coin() < min_ada.checked_add(&new_fee)? {
return Err(JsError::from_str("Not enough ADA leftover to include non-ADA assets in a change address"));
}
change_left = change_left.checked_sub(&change_value)?;
self.add_output(&change_output)?;
}
}
change_left = change_left.checked_sub(&Value::new(&new_fee))?;
// add potentially a separate pure ADA change output
let left_above_minimum = change_left.coin.compare(&minimum_utxo_val) > 0;
if self.config.prefer_pure_change && left_above_minimum {
let pure_output = TransactionOutput {
address: address.clone(),
amount: change_left.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
let additional_fee = self.fee_for_output(&pure_output)?;
let potential_pure_value =
change_left.checked_sub(&Value::new(&additional_fee))?;
let potential_pure_above_minimum =
potential_pure_value.coin.compare(&minimum_utxo_val) > 0;
if potential_pure_above_minimum {
new_fee = new_fee.checked_add(&additional_fee)?;
change_left = Value::zero();
self.add_output(&TransactionOutput {
address: address.clone(),
amount: potential_pure_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
}
}
self.set_fee(&new_fee);
// add in the rest of the ADA
if !change_left.is_zero() {
self.outputs.0.last_mut().unwrap().amount = self
.outputs
.0
.last()
.unwrap()
.amount
.checked_add(&change_left)?;
}
Ok(true)
} else {
let mut calc = MinOutputAdaCalculator::new_empty(&self.config.utxo_cost())?;
calc.set_amount(&change_estimator);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
// no-asset case so we have no problem burning the rest if there is no other option
fn burn_extra(
builder: &mut TransactionBuilder,
burn_amount: &BigNum,
) -> Result<bool, JsError> {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
builder.set_fee(burn_amount);
Ok(false) // not enough input to covert the extra fee from adding an output so we just burn whatever is left
}
match change_estimator.coin() >= min_ada {
false => burn_extra(self, &change_estimator.coin()),
true => {
// check how much the fee would increase if we added a change output
let fee_for_change = self.fee_for_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
let new_fee = fee.checked_add(&fee_for_change)?;
match change_estimator.coin()
>= min_ada.checked_add(&Value::new(&new_fee).coin())?
{
false => burn_extra(self, &change_estimator.coin()),
true => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&new_fee);
self.add_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator
.checked_sub(&Value::new(&new_fee.clone()))?,
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
Ok(true)
}
}
}
}
}
}
None => Err(JsError::from_str(
"missing input or output for some native asset",
)),
}
}src/output_builder.rs (line 117)
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn with_asset_and_min_required_coin_by_utxo_cost(
&self,
multiasset: &MultiAsset,
data_cost: &DataCost,
) -> Result<TransactionOutputAmountBuilder, JsError> {
// TODO: double ada calculation needs to check if it redundant
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let min_possible_coin = calc.calculate_ada()?;
let mut value = Value::new(&min_possible_coin);
value.set_multiasset(multiasset);
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&value);
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let required_coin = calc.calculate_ada()?;
Ok(self.with_coin_and_asset(&required_coin, &multiasset))
}pub fn set_address(&mut self, address: &Address)
sourcepub fn set_plutus_data(&mut self, data: &PlutusData)
pub fn set_plutus_data(&mut self, data: &PlutusData)
Examples found in repository?
src/output_builder.rs (line 121)
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn with_asset_and_min_required_coin_by_utxo_cost(
&self,
multiasset: &MultiAsset,
data_cost: &DataCost,
) -> Result<TransactionOutputAmountBuilder, JsError> {
// TODO: double ada calculation needs to check if it redundant
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let min_possible_coin = calc.calculate_ada()?;
let mut value = Value::new(&min_possible_coin);
value.set_multiasset(multiasset);
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&value);
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let required_coin = calc.calculate_ada()?;
Ok(self.with_coin_and_asset(&required_coin, &multiasset))
}More examples
src/tx_builder.rs (line 1517)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
pub fn add_change_if_needed(&mut self, address: &Address) -> Result<bool, JsError> {
let fee = match &self.fee {
None => self.min_fee(),
// generating the change output involves changing the fee
Some(_x) => {
return Err(JsError::from_str(
"Cannot calculate change if fee was explicitly specified",
))
}
}?;
// note: can't add plutus data or data hash and script to change
// because we don't know how many change outputs will need to be created
let plutus_data: Option<DataOption> = None;
let script_ref: Option<ScriptRef> = None;
let input_total = self.get_total_input()?;
let output_total = self.get_total_output()?;
let shortage = get_input_shortage(&input_total, &output_total, &fee)?;
if let Some(shortage) = shortage {
return Err(JsError::from_str(&format!("Insufficient input in transaction. {}", shortage)));
}
use std::cmp::Ordering;
match &input_total.partial_cmp(&output_total.checked_add(&Value::new(&fee))?) {
Some(Ordering::Equal) => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&input_total.checked_sub(&output_total)?.coin());
Ok(false)
}
Some(Ordering::Less) => Err(JsError::from_str("Insufficient input in transaction")),
Some(Ordering::Greater) => {
fn has_assets(ma: Option<MultiAsset>) -> bool {
ma.map(|assets| assets.len() > 0).unwrap_or(false)
}
let change_estimator = input_total.checked_sub(&output_total)?;
if has_assets(change_estimator.multiasset()) {
fn will_adding_asset_make_output_overflow(
output: &TransactionOutput,
current_assets: &Assets,
asset_to_add: (PolicyID, AssetName, BigNum),
max_value_size: u32,
data_cost: &DataCost,
) -> Result<bool, JsError> {
let (policy, asset_name, value) = asset_to_add;
let mut current_assets_clone = current_assets.clone();
current_assets_clone.insert(&asset_name, &value);
let mut amount_clone = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut ma = MultiAsset::new();
ma.insert(&policy, ¤t_assets_clone);
val.set_multiasset(&ma);
amount_clone = amount_clone.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
Ok(amount_clone.to_bytes().len() > max_value_size as usize)
}
fn pack_nfts_for_change(
max_value_size: u32,
data_cost: &DataCost,
change_address: &Address,
change_estimator: &Value,
plutus_data: &Option<DataOption>,
script_ref: &Option<ScriptRef>,
) -> Result<Vec<MultiAsset>, JsError> {
// we insert the entire available ADA temporarily here since that could potentially impact the size
// as it could be 1, 2 3 or 4 bytes for Coin.
let mut change_assets: Vec<MultiAsset> = Vec::new();
let mut base_coin = Value::new(&change_estimator.coin());
base_coin.set_multiasset(&MultiAsset::new());
let mut output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// If this becomes slow on large TXs we can optimize it like the following
// to avoid cloning + reserializing the entire output.
// This would probably be more relevant if we use a smarter packing algorithm
// which might need to compare more size differences than greedy
//let mut bytes_used = output.to_bytes().len();
// a greedy packing is done here to avoid an exponential bin-packing
// which in most cases likely shouldn't be the difference between
// having an extra change output or not unless there are gigantic
// differences in NFT policy sizes
for (policy, assets) in change_estimator.multiasset().unwrap().0.iter() {
// for simplicity we also don't split assets within a single policy since
// you would need to have a very high amoun of assets (which add 1-36 bytes each)
// in a single policy to make a difference. In the future if this becomes an issue
// we can change that here.
// this is the other part of the optimization but we need to take into account
// the difference between CBOR encoding which can change which happens in two places:
// a) length within assets of one policy id
// b) length of the entire multiasset
// so for simplicity we will just do it the safe, naive way unless
// performance becomes an issue.
//let extra_bytes = policy.to_bytes().len() + assets.to_bytes().len() + 2 + cbor_len_diff;
//if bytes_used + extra_bytes <= max_value_size as usize {
let mut old_amount = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut next_nft = MultiAsset::new();
let asset_names = assets.keys();
let mut rebuilt_assets = Assets::new();
for n in 0..asset_names.len() {
let asset_name = asset_names.get(n);
let value = assets.get(&asset_name).unwrap();
if will_adding_asset_make_output_overflow(
&output,
&rebuilt_assets,
(policy.clone(), asset_name.clone(), value),
max_value_size,
data_cost,
)? {
// if we got here, this means we will run into a overflow error,
// so we want to split into multiple outputs, for that we...
// 1. insert the current assets as they are, as this won't overflow
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
change_assets.push(output.amount.multiasset().unwrap());
// 2. create a new output with the base coin value as zero
base_coin = Value::new(&Coin::zero());
base_coin.set_multiasset(&MultiAsset::new());
output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// 3. continue building the new output from the asset we stopped
old_amount = output.amount.clone();
val = Value::new(&Coin::zero());
next_nft = MultiAsset::new();
rebuilt_assets = Assets::new();
}
rebuilt_assets.insert(&asset_name, &value);
}
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut amount_clone = output.amount.clone();
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
if amount_clone.to_bytes().len() > max_value_size as usize {
output.amount = old_amount;
break;
}
}
change_assets.push(output.amount.multiasset().unwrap());
Ok(change_assets)
}
let mut change_left = input_total.checked_sub(&output_total)?;
let mut new_fee = fee.clone();
// we might need multiple change outputs for cases where the change has many asset types
// which surpass the max UTXO size limit
let utxo_cost = self.config.utxo_cost();
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let minimum_utxo_val = calc.calculate_ada()?;
while let Some(Ordering::Greater) = change_left
.multiasset
.as_ref()
.map_or_else(|| None, |ma| ma.partial_cmp(&MultiAsset::new()))
{
let nft_changes = pack_nfts_for_change(
self.config.max_value_size,
&utxo_cost,
address,
&change_left,
&plutus_data.clone(),
&script_ref.clone(),
)?;
if nft_changes.len() == 0 {
// this likely should never happen
return Err(JsError::from_str("NFTs too large for change output"));
}
// we only add the minimum needed (for now) to cover this output
let mut change_value = Value::new(&Coin::zero());
for nft_change in nft_changes.iter() {
change_value.set_multiasset(&nft_change);
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
//TODO add precise calculation
let mut fake_change = change_value.clone();
fake_change.set_coin(&change_left.coin);
calc.set_amount(&fake_change);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => {
calc.set_data_hash(data_hash)
}
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
change_value.set_coin(&min_ada);
let change_output = TransactionOutput {
address: address.clone(),
amount: change_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// increase fee
let fee_for_change = self.fee_for_output(&change_output)?;
new_fee = new_fee.checked_add(&fee_for_change)?;
if change_left.coin() < min_ada.checked_add(&new_fee)? {
return Err(JsError::from_str("Not enough ADA leftover to include non-ADA assets in a change address"));
}
change_left = change_left.checked_sub(&change_value)?;
self.add_output(&change_output)?;
}
}
change_left = change_left.checked_sub(&Value::new(&new_fee))?;
// add potentially a separate pure ADA change output
let left_above_minimum = change_left.coin.compare(&minimum_utxo_val) > 0;
if self.config.prefer_pure_change && left_above_minimum {
let pure_output = TransactionOutput {
address: address.clone(),
amount: change_left.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
let additional_fee = self.fee_for_output(&pure_output)?;
let potential_pure_value =
change_left.checked_sub(&Value::new(&additional_fee))?;
let potential_pure_above_minimum =
potential_pure_value.coin.compare(&minimum_utxo_val) > 0;
if potential_pure_above_minimum {
new_fee = new_fee.checked_add(&additional_fee)?;
change_left = Value::zero();
self.add_output(&TransactionOutput {
address: address.clone(),
amount: potential_pure_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
}
}
self.set_fee(&new_fee);
// add in the rest of the ADA
if !change_left.is_zero() {
self.outputs.0.last_mut().unwrap().amount = self
.outputs
.0
.last()
.unwrap()
.amount
.checked_add(&change_left)?;
}
Ok(true)
} else {
let mut calc = MinOutputAdaCalculator::new_empty(&self.config.utxo_cost())?;
calc.set_amount(&change_estimator);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
// no-asset case so we have no problem burning the rest if there is no other option
fn burn_extra(
builder: &mut TransactionBuilder,
burn_amount: &BigNum,
) -> Result<bool, JsError> {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
builder.set_fee(burn_amount);
Ok(false) // not enough input to covert the extra fee from adding an output so we just burn whatever is left
}
match change_estimator.coin() >= min_ada {
false => burn_extra(self, &change_estimator.coin()),
true => {
// check how much the fee would increase if we added a change output
let fee_for_change = self.fee_for_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
let new_fee = fee.checked_add(&fee_for_change)?;
match change_estimator.coin()
>= min_ada.checked_add(&Value::new(&new_fee).coin())?
{
false => burn_extra(self, &change_estimator.coin()),
true => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&new_fee);
self.add_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator
.checked_sub(&Value::new(&new_fee.clone()))?,
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
Ok(true)
}
}
}
}
}
}
None => Err(JsError::from_str(
"missing input or output for some native asset",
)),
}
}sourcepub fn set_data_hash(&mut self, data_hash: &DataHash)
pub fn set_data_hash(&mut self, data_hash: &DataHash)
Examples found in repository?
src/utils.rs (line 1445)
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
pub fn min_ada_required(
assets: &Value,
has_data_hash: bool, // whether the output includes a data hash
coins_per_utxo_word: &BigNum, // protocol parameter (in lovelace)
) -> Result<BigNum, JsError> {
let data_cost = DataCost::new_coins_per_word(coins_per_utxo_word);
let mut calc = MinOutputAdaCalculator::new_empty(&data_cost)?;
calc.set_amount(assets);
if has_data_hash {
calc.set_data_hash(&fake_data_hash(0));
}
calc.calculate_ada()
}More examples
src/output_builder.rs (line 120)
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn with_asset_and_min_required_coin_by_utxo_cost(
&self,
multiasset: &MultiAsset,
data_cost: &DataCost,
) -> Result<TransactionOutputAmountBuilder, JsError> {
// TODO: double ada calculation needs to check if it redundant
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let min_possible_coin = calc.calculate_ada()?;
let mut value = Value::new(&min_possible_coin);
value.set_multiasset(multiasset);
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&value);
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let required_coin = calc.calculate_ada()?;
Ok(self.with_coin_and_asset(&required_coin, &multiasset))
}src/tx_builder.rs (line 1516)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
pub fn add_change_if_needed(&mut self, address: &Address) -> Result<bool, JsError> {
let fee = match &self.fee {
None => self.min_fee(),
// generating the change output involves changing the fee
Some(_x) => {
return Err(JsError::from_str(
"Cannot calculate change if fee was explicitly specified",
))
}
}?;
// note: can't add plutus data or data hash and script to change
// because we don't know how many change outputs will need to be created
let plutus_data: Option<DataOption> = None;
let script_ref: Option<ScriptRef> = None;
let input_total = self.get_total_input()?;
let output_total = self.get_total_output()?;
let shortage = get_input_shortage(&input_total, &output_total, &fee)?;
if let Some(shortage) = shortage {
return Err(JsError::from_str(&format!("Insufficient input in transaction. {}", shortage)));
}
use std::cmp::Ordering;
match &input_total.partial_cmp(&output_total.checked_add(&Value::new(&fee))?) {
Some(Ordering::Equal) => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&input_total.checked_sub(&output_total)?.coin());
Ok(false)
}
Some(Ordering::Less) => Err(JsError::from_str("Insufficient input in transaction")),
Some(Ordering::Greater) => {
fn has_assets(ma: Option<MultiAsset>) -> bool {
ma.map(|assets| assets.len() > 0).unwrap_or(false)
}
let change_estimator = input_total.checked_sub(&output_total)?;
if has_assets(change_estimator.multiasset()) {
fn will_adding_asset_make_output_overflow(
output: &TransactionOutput,
current_assets: &Assets,
asset_to_add: (PolicyID, AssetName, BigNum),
max_value_size: u32,
data_cost: &DataCost,
) -> Result<bool, JsError> {
let (policy, asset_name, value) = asset_to_add;
let mut current_assets_clone = current_assets.clone();
current_assets_clone.insert(&asset_name, &value);
let mut amount_clone = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut ma = MultiAsset::new();
ma.insert(&policy, ¤t_assets_clone);
val.set_multiasset(&ma);
amount_clone = amount_clone.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
Ok(amount_clone.to_bytes().len() > max_value_size as usize)
}
fn pack_nfts_for_change(
max_value_size: u32,
data_cost: &DataCost,
change_address: &Address,
change_estimator: &Value,
plutus_data: &Option<DataOption>,
script_ref: &Option<ScriptRef>,
) -> Result<Vec<MultiAsset>, JsError> {
// we insert the entire available ADA temporarily here since that could potentially impact the size
// as it could be 1, 2 3 or 4 bytes for Coin.
let mut change_assets: Vec<MultiAsset> = Vec::new();
let mut base_coin = Value::new(&change_estimator.coin());
base_coin.set_multiasset(&MultiAsset::new());
let mut output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// If this becomes slow on large TXs we can optimize it like the following
// to avoid cloning + reserializing the entire output.
// This would probably be more relevant if we use a smarter packing algorithm
// which might need to compare more size differences than greedy
//let mut bytes_used = output.to_bytes().len();
// a greedy packing is done here to avoid an exponential bin-packing
// which in most cases likely shouldn't be the difference between
// having an extra change output or not unless there are gigantic
// differences in NFT policy sizes
for (policy, assets) in change_estimator.multiasset().unwrap().0.iter() {
// for simplicity we also don't split assets within a single policy since
// you would need to have a very high amoun of assets (which add 1-36 bytes each)
// in a single policy to make a difference. In the future if this becomes an issue
// we can change that here.
// this is the other part of the optimization but we need to take into account
// the difference between CBOR encoding which can change which happens in two places:
// a) length within assets of one policy id
// b) length of the entire multiasset
// so for simplicity we will just do it the safe, naive way unless
// performance becomes an issue.
//let extra_bytes = policy.to_bytes().len() + assets.to_bytes().len() + 2 + cbor_len_diff;
//if bytes_used + extra_bytes <= max_value_size as usize {
let mut old_amount = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut next_nft = MultiAsset::new();
let asset_names = assets.keys();
let mut rebuilt_assets = Assets::new();
for n in 0..asset_names.len() {
let asset_name = asset_names.get(n);
let value = assets.get(&asset_name).unwrap();
if will_adding_asset_make_output_overflow(
&output,
&rebuilt_assets,
(policy.clone(), asset_name.clone(), value),
max_value_size,
data_cost,
)? {
// if we got here, this means we will run into a overflow error,
// so we want to split into multiple outputs, for that we...
// 1. insert the current assets as they are, as this won't overflow
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
change_assets.push(output.amount.multiasset().unwrap());
// 2. create a new output with the base coin value as zero
base_coin = Value::new(&Coin::zero());
base_coin.set_multiasset(&MultiAsset::new());
output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// 3. continue building the new output from the asset we stopped
old_amount = output.amount.clone();
val = Value::new(&Coin::zero());
next_nft = MultiAsset::new();
rebuilt_assets = Assets::new();
}
rebuilt_assets.insert(&asset_name, &value);
}
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut amount_clone = output.amount.clone();
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
if amount_clone.to_bytes().len() > max_value_size as usize {
output.amount = old_amount;
break;
}
}
change_assets.push(output.amount.multiasset().unwrap());
Ok(change_assets)
}
let mut change_left = input_total.checked_sub(&output_total)?;
let mut new_fee = fee.clone();
// we might need multiple change outputs for cases where the change has many asset types
// which surpass the max UTXO size limit
let utxo_cost = self.config.utxo_cost();
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let minimum_utxo_val = calc.calculate_ada()?;
while let Some(Ordering::Greater) = change_left
.multiasset
.as_ref()
.map_or_else(|| None, |ma| ma.partial_cmp(&MultiAsset::new()))
{
let nft_changes = pack_nfts_for_change(
self.config.max_value_size,
&utxo_cost,
address,
&change_left,
&plutus_data.clone(),
&script_ref.clone(),
)?;
if nft_changes.len() == 0 {
// this likely should never happen
return Err(JsError::from_str("NFTs too large for change output"));
}
// we only add the minimum needed (for now) to cover this output
let mut change_value = Value::new(&Coin::zero());
for nft_change in nft_changes.iter() {
change_value.set_multiasset(&nft_change);
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
//TODO add precise calculation
let mut fake_change = change_value.clone();
fake_change.set_coin(&change_left.coin);
calc.set_amount(&fake_change);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => {
calc.set_data_hash(data_hash)
}
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
change_value.set_coin(&min_ada);
let change_output = TransactionOutput {
address: address.clone(),
amount: change_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// increase fee
let fee_for_change = self.fee_for_output(&change_output)?;
new_fee = new_fee.checked_add(&fee_for_change)?;
if change_left.coin() < min_ada.checked_add(&new_fee)? {
return Err(JsError::from_str("Not enough ADA leftover to include non-ADA assets in a change address"));
}
change_left = change_left.checked_sub(&change_value)?;
self.add_output(&change_output)?;
}
}
change_left = change_left.checked_sub(&Value::new(&new_fee))?;
// add potentially a separate pure ADA change output
let left_above_minimum = change_left.coin.compare(&minimum_utxo_val) > 0;
if self.config.prefer_pure_change && left_above_minimum {
let pure_output = TransactionOutput {
address: address.clone(),
amount: change_left.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
let additional_fee = self.fee_for_output(&pure_output)?;
let potential_pure_value =
change_left.checked_sub(&Value::new(&additional_fee))?;
let potential_pure_above_minimum =
potential_pure_value.coin.compare(&minimum_utxo_val) > 0;
if potential_pure_above_minimum {
new_fee = new_fee.checked_add(&additional_fee)?;
change_left = Value::zero();
self.add_output(&TransactionOutput {
address: address.clone(),
amount: potential_pure_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
}
}
self.set_fee(&new_fee);
// add in the rest of the ADA
if !change_left.is_zero() {
self.outputs.0.last_mut().unwrap().amount = self
.outputs
.0
.last()
.unwrap()
.amount
.checked_add(&change_left)?;
}
Ok(true)
} else {
let mut calc = MinOutputAdaCalculator::new_empty(&self.config.utxo_cost())?;
calc.set_amount(&change_estimator);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
// no-asset case so we have no problem burning the rest if there is no other option
fn burn_extra(
builder: &mut TransactionBuilder,
burn_amount: &BigNum,
) -> Result<bool, JsError> {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
builder.set_fee(burn_amount);
Ok(false) // not enough input to covert the extra fee from adding an output so we just burn whatever is left
}
match change_estimator.coin() >= min_ada {
false => burn_extra(self, &change_estimator.coin()),
true => {
// check how much the fee would increase if we added a change output
let fee_for_change = self.fee_for_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
let new_fee = fee.checked_add(&fee_for_change)?;
match change_estimator.coin()
>= min_ada.checked_add(&Value::new(&new_fee).coin())?
{
false => burn_extra(self, &change_estimator.coin()),
true => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&new_fee);
self.add_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator
.checked_sub(&Value::new(&new_fee.clone()))?,
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
Ok(true)
}
}
}
}
}
}
None => Err(JsError::from_str(
"missing input or output for some native asset",
)),
}
}sourcepub fn set_amount(&mut self, amount: &Value)
pub fn set_amount(&mut self, amount: &Value)
Examples found in repository?
src/utils.rs (line 1443)
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
pub fn min_ada_required(
assets: &Value,
has_data_hash: bool, // whether the output includes a data hash
coins_per_utxo_word: &BigNum, // protocol parameter (in lovelace)
) -> Result<BigNum, JsError> {
let data_cost = DataCost::new_coins_per_word(coins_per_utxo_word);
let mut calc = MinOutputAdaCalculator::new_empty(&data_cost)?;
calc.set_amount(assets);
if has_data_hash {
calc.set_data_hash(&fake_data_hash(0));
}
calc.calculate_ada()
}More examples
src/tx_builder.rs (line 1392)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
pub fn add_change_if_needed(&mut self, address: &Address) -> Result<bool, JsError> {
let fee = match &self.fee {
None => self.min_fee(),
// generating the change output involves changing the fee
Some(_x) => {
return Err(JsError::from_str(
"Cannot calculate change if fee was explicitly specified",
))
}
}?;
// note: can't add plutus data or data hash and script to change
// because we don't know how many change outputs will need to be created
let plutus_data: Option<DataOption> = None;
let script_ref: Option<ScriptRef> = None;
let input_total = self.get_total_input()?;
let output_total = self.get_total_output()?;
let shortage = get_input_shortage(&input_total, &output_total, &fee)?;
if let Some(shortage) = shortage {
return Err(JsError::from_str(&format!("Insufficient input in transaction. {}", shortage)));
}
use std::cmp::Ordering;
match &input_total.partial_cmp(&output_total.checked_add(&Value::new(&fee))?) {
Some(Ordering::Equal) => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&input_total.checked_sub(&output_total)?.coin());
Ok(false)
}
Some(Ordering::Less) => Err(JsError::from_str("Insufficient input in transaction")),
Some(Ordering::Greater) => {
fn has_assets(ma: Option<MultiAsset>) -> bool {
ma.map(|assets| assets.len() > 0).unwrap_or(false)
}
let change_estimator = input_total.checked_sub(&output_total)?;
if has_assets(change_estimator.multiasset()) {
fn will_adding_asset_make_output_overflow(
output: &TransactionOutput,
current_assets: &Assets,
asset_to_add: (PolicyID, AssetName, BigNum),
max_value_size: u32,
data_cost: &DataCost,
) -> Result<bool, JsError> {
let (policy, asset_name, value) = asset_to_add;
let mut current_assets_clone = current_assets.clone();
current_assets_clone.insert(&asset_name, &value);
let mut amount_clone = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut ma = MultiAsset::new();
ma.insert(&policy, ¤t_assets_clone);
val.set_multiasset(&ma);
amount_clone = amount_clone.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
Ok(amount_clone.to_bytes().len() > max_value_size as usize)
}
fn pack_nfts_for_change(
max_value_size: u32,
data_cost: &DataCost,
change_address: &Address,
change_estimator: &Value,
plutus_data: &Option<DataOption>,
script_ref: &Option<ScriptRef>,
) -> Result<Vec<MultiAsset>, JsError> {
// we insert the entire available ADA temporarily here since that could potentially impact the size
// as it could be 1, 2 3 or 4 bytes for Coin.
let mut change_assets: Vec<MultiAsset> = Vec::new();
let mut base_coin = Value::new(&change_estimator.coin());
base_coin.set_multiasset(&MultiAsset::new());
let mut output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// If this becomes slow on large TXs we can optimize it like the following
// to avoid cloning + reserializing the entire output.
// This would probably be more relevant if we use a smarter packing algorithm
// which might need to compare more size differences than greedy
//let mut bytes_used = output.to_bytes().len();
// a greedy packing is done here to avoid an exponential bin-packing
// which in most cases likely shouldn't be the difference between
// having an extra change output or not unless there are gigantic
// differences in NFT policy sizes
for (policy, assets) in change_estimator.multiasset().unwrap().0.iter() {
// for simplicity we also don't split assets within a single policy since
// you would need to have a very high amoun of assets (which add 1-36 bytes each)
// in a single policy to make a difference. In the future if this becomes an issue
// we can change that here.
// this is the other part of the optimization but we need to take into account
// the difference between CBOR encoding which can change which happens in two places:
// a) length within assets of one policy id
// b) length of the entire multiasset
// so for simplicity we will just do it the safe, naive way unless
// performance becomes an issue.
//let extra_bytes = policy.to_bytes().len() + assets.to_bytes().len() + 2 + cbor_len_diff;
//if bytes_used + extra_bytes <= max_value_size as usize {
let mut old_amount = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut next_nft = MultiAsset::new();
let asset_names = assets.keys();
let mut rebuilt_assets = Assets::new();
for n in 0..asset_names.len() {
let asset_name = asset_names.get(n);
let value = assets.get(&asset_name).unwrap();
if will_adding_asset_make_output_overflow(
&output,
&rebuilt_assets,
(policy.clone(), asset_name.clone(), value),
max_value_size,
data_cost,
)? {
// if we got here, this means we will run into a overflow error,
// so we want to split into multiple outputs, for that we...
// 1. insert the current assets as they are, as this won't overflow
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
change_assets.push(output.amount.multiasset().unwrap());
// 2. create a new output with the base coin value as zero
base_coin = Value::new(&Coin::zero());
base_coin.set_multiasset(&MultiAsset::new());
output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// 3. continue building the new output from the asset we stopped
old_amount = output.amount.clone();
val = Value::new(&Coin::zero());
next_nft = MultiAsset::new();
rebuilt_assets = Assets::new();
}
rebuilt_assets.insert(&asset_name, &value);
}
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut amount_clone = output.amount.clone();
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
if amount_clone.to_bytes().len() > max_value_size as usize {
output.amount = old_amount;
break;
}
}
change_assets.push(output.amount.multiasset().unwrap());
Ok(change_assets)
}
let mut change_left = input_total.checked_sub(&output_total)?;
let mut new_fee = fee.clone();
// we might need multiple change outputs for cases where the change has many asset types
// which surpass the max UTXO size limit
let utxo_cost = self.config.utxo_cost();
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let minimum_utxo_val = calc.calculate_ada()?;
while let Some(Ordering::Greater) = change_left
.multiasset
.as_ref()
.map_or_else(|| None, |ma| ma.partial_cmp(&MultiAsset::new()))
{
let nft_changes = pack_nfts_for_change(
self.config.max_value_size,
&utxo_cost,
address,
&change_left,
&plutus_data.clone(),
&script_ref.clone(),
)?;
if nft_changes.len() == 0 {
// this likely should never happen
return Err(JsError::from_str("NFTs too large for change output"));
}
// we only add the minimum needed (for now) to cover this output
let mut change_value = Value::new(&Coin::zero());
for nft_change in nft_changes.iter() {
change_value.set_multiasset(&nft_change);
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
//TODO add precise calculation
let mut fake_change = change_value.clone();
fake_change.set_coin(&change_left.coin);
calc.set_amount(&fake_change);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => {
calc.set_data_hash(data_hash)
}
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
change_value.set_coin(&min_ada);
let change_output = TransactionOutput {
address: address.clone(),
amount: change_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// increase fee
let fee_for_change = self.fee_for_output(&change_output)?;
new_fee = new_fee.checked_add(&fee_for_change)?;
if change_left.coin() < min_ada.checked_add(&new_fee)? {
return Err(JsError::from_str("Not enough ADA leftover to include non-ADA assets in a change address"));
}
change_left = change_left.checked_sub(&change_value)?;
self.add_output(&change_output)?;
}
}
change_left = change_left.checked_sub(&Value::new(&new_fee))?;
// add potentially a separate pure ADA change output
let left_above_minimum = change_left.coin.compare(&minimum_utxo_val) > 0;
if self.config.prefer_pure_change && left_above_minimum {
let pure_output = TransactionOutput {
address: address.clone(),
amount: change_left.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
let additional_fee = self.fee_for_output(&pure_output)?;
let potential_pure_value =
change_left.checked_sub(&Value::new(&additional_fee))?;
let potential_pure_above_minimum =
potential_pure_value.coin.compare(&minimum_utxo_val) > 0;
if potential_pure_above_minimum {
new_fee = new_fee.checked_add(&additional_fee)?;
change_left = Value::zero();
self.add_output(&TransactionOutput {
address: address.clone(),
amount: potential_pure_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
}
}
self.set_fee(&new_fee);
// add in the rest of the ADA
if !change_left.is_zero() {
self.outputs.0.last_mut().unwrap().amount = self
.outputs
.0
.last()
.unwrap()
.amount
.checked_add(&change_left)?;
}
Ok(true)
} else {
let mut calc = MinOutputAdaCalculator::new_empty(&self.config.utxo_cost())?;
calc.set_amount(&change_estimator);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
// no-asset case so we have no problem burning the rest if there is no other option
fn burn_extra(
builder: &mut TransactionBuilder,
burn_amount: &BigNum,
) -> Result<bool, JsError> {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
builder.set_fee(burn_amount);
Ok(false) // not enough input to covert the extra fee from adding an output so we just burn whatever is left
}
match change_estimator.coin() >= min_ada {
false => burn_extra(self, &change_estimator.coin()),
true => {
// check how much the fee would increase if we added a change output
let fee_for_change = self.fee_for_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
let new_fee = fee.checked_add(&fee_for_change)?;
match change_estimator.coin()
>= min_ada.checked_add(&Value::new(&new_fee).coin())?
{
false => burn_extra(self, &change_estimator.coin()),
true => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&new_fee);
self.add_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator
.checked_sub(&Value::new(&new_fee.clone()))?,
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
Ok(true)
}
}
}
}
}
}
None => Err(JsError::from_str(
"missing input or output for some native asset",
)),
}
}src/output_builder.rs (line 132)
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn with_asset_and_min_required_coin_by_utxo_cost(
&self,
multiasset: &MultiAsset,
data_cost: &DataCost,
) -> Result<TransactionOutputAmountBuilder, JsError> {
// TODO: double ada calculation needs to check if it redundant
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let min_possible_coin = calc.calculate_ada()?;
let mut value = Value::new(&min_possible_coin);
value.set_multiasset(multiasset);
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&value);
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let required_coin = calc.calculate_ada()?;
Ok(self.with_coin_and_asset(&required_coin, &multiasset))
}sourcepub fn set_script_ref(&mut self, script_ref: &ScriptRef)
pub fn set_script_ref(&mut self, script_ref: &ScriptRef)
Examples found in repository?
src/output_builder.rs (line 125)
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn with_asset_and_min_required_coin_by_utxo_cost(
&self,
multiasset: &MultiAsset,
data_cost: &DataCost,
) -> Result<TransactionOutputAmountBuilder, JsError> {
// TODO: double ada calculation needs to check if it redundant
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let min_possible_coin = calc.calculate_ada()?;
let mut value = Value::new(&min_possible_coin);
value.set_multiasset(multiasset);
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&value);
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let required_coin = calc.calculate_ada()?;
Ok(self.with_coin_and_asset(&required_coin, &multiasset))
}More examples
src/tx_builder.rs (line 1521)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
pub fn add_change_if_needed(&mut self, address: &Address) -> Result<bool, JsError> {
let fee = match &self.fee {
None => self.min_fee(),
// generating the change output involves changing the fee
Some(_x) => {
return Err(JsError::from_str(
"Cannot calculate change if fee was explicitly specified",
))
}
}?;
// note: can't add plutus data or data hash and script to change
// because we don't know how many change outputs will need to be created
let plutus_data: Option<DataOption> = None;
let script_ref: Option<ScriptRef> = None;
let input_total = self.get_total_input()?;
let output_total = self.get_total_output()?;
let shortage = get_input_shortage(&input_total, &output_total, &fee)?;
if let Some(shortage) = shortage {
return Err(JsError::from_str(&format!("Insufficient input in transaction. {}", shortage)));
}
use std::cmp::Ordering;
match &input_total.partial_cmp(&output_total.checked_add(&Value::new(&fee))?) {
Some(Ordering::Equal) => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&input_total.checked_sub(&output_total)?.coin());
Ok(false)
}
Some(Ordering::Less) => Err(JsError::from_str("Insufficient input in transaction")),
Some(Ordering::Greater) => {
fn has_assets(ma: Option<MultiAsset>) -> bool {
ma.map(|assets| assets.len() > 0).unwrap_or(false)
}
let change_estimator = input_total.checked_sub(&output_total)?;
if has_assets(change_estimator.multiasset()) {
fn will_adding_asset_make_output_overflow(
output: &TransactionOutput,
current_assets: &Assets,
asset_to_add: (PolicyID, AssetName, BigNum),
max_value_size: u32,
data_cost: &DataCost,
) -> Result<bool, JsError> {
let (policy, asset_name, value) = asset_to_add;
let mut current_assets_clone = current_assets.clone();
current_assets_clone.insert(&asset_name, &value);
let mut amount_clone = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut ma = MultiAsset::new();
ma.insert(&policy, ¤t_assets_clone);
val.set_multiasset(&ma);
amount_clone = amount_clone.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
Ok(amount_clone.to_bytes().len() > max_value_size as usize)
}
fn pack_nfts_for_change(
max_value_size: u32,
data_cost: &DataCost,
change_address: &Address,
change_estimator: &Value,
plutus_data: &Option<DataOption>,
script_ref: &Option<ScriptRef>,
) -> Result<Vec<MultiAsset>, JsError> {
// we insert the entire available ADA temporarily here since that could potentially impact the size
// as it could be 1, 2 3 or 4 bytes for Coin.
let mut change_assets: Vec<MultiAsset> = Vec::new();
let mut base_coin = Value::new(&change_estimator.coin());
base_coin.set_multiasset(&MultiAsset::new());
let mut output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// If this becomes slow on large TXs we can optimize it like the following
// to avoid cloning + reserializing the entire output.
// This would probably be more relevant if we use a smarter packing algorithm
// which might need to compare more size differences than greedy
//let mut bytes_used = output.to_bytes().len();
// a greedy packing is done here to avoid an exponential bin-packing
// which in most cases likely shouldn't be the difference between
// having an extra change output or not unless there are gigantic
// differences in NFT policy sizes
for (policy, assets) in change_estimator.multiasset().unwrap().0.iter() {
// for simplicity we also don't split assets within a single policy since
// you would need to have a very high amoun of assets (which add 1-36 bytes each)
// in a single policy to make a difference. In the future if this becomes an issue
// we can change that here.
// this is the other part of the optimization but we need to take into account
// the difference between CBOR encoding which can change which happens in two places:
// a) length within assets of one policy id
// b) length of the entire multiasset
// so for simplicity we will just do it the safe, naive way unless
// performance becomes an issue.
//let extra_bytes = policy.to_bytes().len() + assets.to_bytes().len() + 2 + cbor_len_diff;
//if bytes_used + extra_bytes <= max_value_size as usize {
let mut old_amount = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut next_nft = MultiAsset::new();
let asset_names = assets.keys();
let mut rebuilt_assets = Assets::new();
for n in 0..asset_names.len() {
let asset_name = asset_names.get(n);
let value = assets.get(&asset_name).unwrap();
if will_adding_asset_make_output_overflow(
&output,
&rebuilt_assets,
(policy.clone(), asset_name.clone(), value),
max_value_size,
data_cost,
)? {
// if we got here, this means we will run into a overflow error,
// so we want to split into multiple outputs, for that we...
// 1. insert the current assets as they are, as this won't overflow
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
change_assets.push(output.amount.multiasset().unwrap());
// 2. create a new output with the base coin value as zero
base_coin = Value::new(&Coin::zero());
base_coin.set_multiasset(&MultiAsset::new());
output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// 3. continue building the new output from the asset we stopped
old_amount = output.amount.clone();
val = Value::new(&Coin::zero());
next_nft = MultiAsset::new();
rebuilt_assets = Assets::new();
}
rebuilt_assets.insert(&asset_name, &value);
}
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut amount_clone = output.amount.clone();
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
if amount_clone.to_bytes().len() > max_value_size as usize {
output.amount = old_amount;
break;
}
}
change_assets.push(output.amount.multiasset().unwrap());
Ok(change_assets)
}
let mut change_left = input_total.checked_sub(&output_total)?;
let mut new_fee = fee.clone();
// we might need multiple change outputs for cases where the change has many asset types
// which surpass the max UTXO size limit
let utxo_cost = self.config.utxo_cost();
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let minimum_utxo_val = calc.calculate_ada()?;
while let Some(Ordering::Greater) = change_left
.multiasset
.as_ref()
.map_or_else(|| None, |ma| ma.partial_cmp(&MultiAsset::new()))
{
let nft_changes = pack_nfts_for_change(
self.config.max_value_size,
&utxo_cost,
address,
&change_left,
&plutus_data.clone(),
&script_ref.clone(),
)?;
if nft_changes.len() == 0 {
// this likely should never happen
return Err(JsError::from_str("NFTs too large for change output"));
}
// we only add the minimum needed (for now) to cover this output
let mut change_value = Value::new(&Coin::zero());
for nft_change in nft_changes.iter() {
change_value.set_multiasset(&nft_change);
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
//TODO add precise calculation
let mut fake_change = change_value.clone();
fake_change.set_coin(&change_left.coin);
calc.set_amount(&fake_change);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => {
calc.set_data_hash(data_hash)
}
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
change_value.set_coin(&min_ada);
let change_output = TransactionOutput {
address: address.clone(),
amount: change_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// increase fee
let fee_for_change = self.fee_for_output(&change_output)?;
new_fee = new_fee.checked_add(&fee_for_change)?;
if change_left.coin() < min_ada.checked_add(&new_fee)? {
return Err(JsError::from_str("Not enough ADA leftover to include non-ADA assets in a change address"));
}
change_left = change_left.checked_sub(&change_value)?;
self.add_output(&change_output)?;
}
}
change_left = change_left.checked_sub(&Value::new(&new_fee))?;
// add potentially a separate pure ADA change output
let left_above_minimum = change_left.coin.compare(&minimum_utxo_val) > 0;
if self.config.prefer_pure_change && left_above_minimum {
let pure_output = TransactionOutput {
address: address.clone(),
amount: change_left.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
let additional_fee = self.fee_for_output(&pure_output)?;
let potential_pure_value =
change_left.checked_sub(&Value::new(&additional_fee))?;
let potential_pure_above_minimum =
potential_pure_value.coin.compare(&minimum_utxo_val) > 0;
if potential_pure_above_minimum {
new_fee = new_fee.checked_add(&additional_fee)?;
change_left = Value::zero();
self.add_output(&TransactionOutput {
address: address.clone(),
amount: potential_pure_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
}
}
self.set_fee(&new_fee);
// add in the rest of the ADA
if !change_left.is_zero() {
self.outputs.0.last_mut().unwrap().amount = self
.outputs
.0
.last()
.unwrap()
.amount
.checked_add(&change_left)?;
}
Ok(true)
} else {
let mut calc = MinOutputAdaCalculator::new_empty(&self.config.utxo_cost())?;
calc.set_amount(&change_estimator);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
// no-asset case so we have no problem burning the rest if there is no other option
fn burn_extra(
builder: &mut TransactionBuilder,
burn_amount: &BigNum,
) -> Result<bool, JsError> {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
builder.set_fee(burn_amount);
Ok(false) // not enough input to covert the extra fee from adding an output so we just burn whatever is left
}
match change_estimator.coin() >= min_ada {
false => burn_extra(self, &change_estimator.coin()),
true => {
// check how much the fee would increase if we added a change output
let fee_for_change = self.fee_for_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
let new_fee = fee.checked_add(&fee_for_change)?;
match change_estimator.coin()
>= min_ada.checked_add(&Value::new(&new_fee).coin())?
{
false => burn_extra(self, &change_estimator.coin()),
true => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&new_fee);
self.add_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator
.checked_sub(&Value::new(&new_fee.clone()))?,
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
Ok(true)
}
}
}
}
}
}
None => Err(JsError::from_str(
"missing input or output for some native asset",
)),
}
}sourcepub fn calculate_ada(&self) -> Result<BigNum, JsError>
pub fn calculate_ada(&self) -> Result<BigNum, JsError>
Examples found in repository?
src/utils.rs (line 1428)
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
pub fn min_ada_for_output(
output: &TransactionOutput,
data_cost: &DataCost,
) -> Result<BigNum, JsError> {
MinOutputAdaCalculator::new(output, data_cost).calculate_ada()
}
/// !!! DEPRECATED !!!
/// This function uses outdated set of arguments.
/// Use `min_ada_for_output` instead
#[wasm_bindgen]
#[deprecated(since = "11.0.0", note = "Use `min_ada_for_output` instead")]
pub fn min_ada_required(
assets: &Value,
has_data_hash: bool, // whether the output includes a data hash
coins_per_utxo_word: &BigNum, // protocol parameter (in lovelace)
) -> Result<BigNum, JsError> {
let data_cost = DataCost::new_coins_per_word(coins_per_utxo_word);
let mut calc = MinOutputAdaCalculator::new_empty(&data_cost)?;
calc.set_amount(assets);
if has_data_hash {
calc.set_data_hash(&fake_data_hash(0));
}
calc.calculate_ada()
}More examples
src/tx_builder.rs (line 1393)
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
pub fn add_change_if_needed(&mut self, address: &Address) -> Result<bool, JsError> {
let fee = match &self.fee {
None => self.min_fee(),
// generating the change output involves changing the fee
Some(_x) => {
return Err(JsError::from_str(
"Cannot calculate change if fee was explicitly specified",
))
}
}?;
// note: can't add plutus data or data hash and script to change
// because we don't know how many change outputs will need to be created
let plutus_data: Option<DataOption> = None;
let script_ref: Option<ScriptRef> = None;
let input_total = self.get_total_input()?;
let output_total = self.get_total_output()?;
let shortage = get_input_shortage(&input_total, &output_total, &fee)?;
if let Some(shortage) = shortage {
return Err(JsError::from_str(&format!("Insufficient input in transaction. {}", shortage)));
}
use std::cmp::Ordering;
match &input_total.partial_cmp(&output_total.checked_add(&Value::new(&fee))?) {
Some(Ordering::Equal) => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&input_total.checked_sub(&output_total)?.coin());
Ok(false)
}
Some(Ordering::Less) => Err(JsError::from_str("Insufficient input in transaction")),
Some(Ordering::Greater) => {
fn has_assets(ma: Option<MultiAsset>) -> bool {
ma.map(|assets| assets.len() > 0).unwrap_or(false)
}
let change_estimator = input_total.checked_sub(&output_total)?;
if has_assets(change_estimator.multiasset()) {
fn will_adding_asset_make_output_overflow(
output: &TransactionOutput,
current_assets: &Assets,
asset_to_add: (PolicyID, AssetName, BigNum),
max_value_size: u32,
data_cost: &DataCost,
) -> Result<bool, JsError> {
let (policy, asset_name, value) = asset_to_add;
let mut current_assets_clone = current_assets.clone();
current_assets_clone.insert(&asset_name, &value);
let mut amount_clone = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut ma = MultiAsset::new();
ma.insert(&policy, ¤t_assets_clone);
val.set_multiasset(&ma);
amount_clone = amount_clone.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
Ok(amount_clone.to_bytes().len() > max_value_size as usize)
}
fn pack_nfts_for_change(
max_value_size: u32,
data_cost: &DataCost,
change_address: &Address,
change_estimator: &Value,
plutus_data: &Option<DataOption>,
script_ref: &Option<ScriptRef>,
) -> Result<Vec<MultiAsset>, JsError> {
// we insert the entire available ADA temporarily here since that could potentially impact the size
// as it could be 1, 2 3 or 4 bytes for Coin.
let mut change_assets: Vec<MultiAsset> = Vec::new();
let mut base_coin = Value::new(&change_estimator.coin());
base_coin.set_multiasset(&MultiAsset::new());
let mut output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// If this becomes slow on large TXs we can optimize it like the following
// to avoid cloning + reserializing the entire output.
// This would probably be more relevant if we use a smarter packing algorithm
// which might need to compare more size differences than greedy
//let mut bytes_used = output.to_bytes().len();
// a greedy packing is done here to avoid an exponential bin-packing
// which in most cases likely shouldn't be the difference between
// having an extra change output or not unless there are gigantic
// differences in NFT policy sizes
for (policy, assets) in change_estimator.multiasset().unwrap().0.iter() {
// for simplicity we also don't split assets within a single policy since
// you would need to have a very high amoun of assets (which add 1-36 bytes each)
// in a single policy to make a difference. In the future if this becomes an issue
// we can change that here.
// this is the other part of the optimization but we need to take into account
// the difference between CBOR encoding which can change which happens in two places:
// a) length within assets of one policy id
// b) length of the entire multiasset
// so for simplicity we will just do it the safe, naive way unless
// performance becomes an issue.
//let extra_bytes = policy.to_bytes().len() + assets.to_bytes().len() + 2 + cbor_len_diff;
//if bytes_used + extra_bytes <= max_value_size as usize {
let mut old_amount = output.amount.clone();
let mut val = Value::new(&Coin::zero());
let mut next_nft = MultiAsset::new();
let asset_names = assets.keys();
let mut rebuilt_assets = Assets::new();
for n in 0..asset_names.len() {
let asset_name = asset_names.get(n);
let value = assets.get(&asset_name).unwrap();
if will_adding_asset_make_output_overflow(
&output,
&rebuilt_assets,
(policy.clone(), asset_name.clone(), value),
max_value_size,
data_cost,
)? {
// if we got here, this means we will run into a overflow error,
// so we want to split into multiple outputs, for that we...
// 1. insert the current assets as they are, as this won't overflow
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
change_assets.push(output.amount.multiasset().unwrap());
// 2. create a new output with the base coin value as zero
base_coin = Value::new(&Coin::zero());
base_coin.set_multiasset(&MultiAsset::new());
output = TransactionOutput {
address: change_address.clone(),
amount: base_coin.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// 3. continue building the new output from the asset we stopped
old_amount = output.amount.clone();
val = Value::new(&Coin::zero());
next_nft = MultiAsset::new();
rebuilt_assets = Assets::new();
}
rebuilt_assets.insert(&asset_name, &value);
}
next_nft.insert(policy, &rebuilt_assets);
val.set_multiasset(&next_nft);
output.amount = output.amount.checked_add(&val)?;
// calculate minADA for more precise max value size
let mut amount_clone = output.amount.clone();
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&val);
let min_ada = calc.calculate_ada()?;
amount_clone.set_coin(&min_ada);
if amount_clone.to_bytes().len() > max_value_size as usize {
output.amount = old_amount;
break;
}
}
change_assets.push(output.amount.multiasset().unwrap());
Ok(change_assets)
}
let mut change_left = input_total.checked_sub(&output_total)?;
let mut new_fee = fee.clone();
// we might need multiple change outputs for cases where the change has many asset types
// which surpass the max UTXO size limit
let utxo_cost = self.config.utxo_cost();
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let minimum_utxo_val = calc.calculate_ada()?;
while let Some(Ordering::Greater) = change_left
.multiasset
.as_ref()
.map_or_else(|| None, |ma| ma.partial_cmp(&MultiAsset::new()))
{
let nft_changes = pack_nfts_for_change(
self.config.max_value_size,
&utxo_cost,
address,
&change_left,
&plutus_data.clone(),
&script_ref.clone(),
)?;
if nft_changes.len() == 0 {
// this likely should never happen
return Err(JsError::from_str("NFTs too large for change output"));
}
// we only add the minimum needed (for now) to cover this output
let mut change_value = Value::new(&Coin::zero());
for nft_change in nft_changes.iter() {
change_value.set_multiasset(&nft_change);
let mut calc = MinOutputAdaCalculator::new_empty(&utxo_cost)?;
//TODO add precise calculation
let mut fake_change = change_value.clone();
fake_change.set_coin(&change_left.coin);
calc.set_amount(&fake_change);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => {
calc.set_data_hash(data_hash)
}
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
change_value.set_coin(&min_ada);
let change_output = TransactionOutput {
address: address.clone(),
amount: change_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
// increase fee
let fee_for_change = self.fee_for_output(&change_output)?;
new_fee = new_fee.checked_add(&fee_for_change)?;
if change_left.coin() < min_ada.checked_add(&new_fee)? {
return Err(JsError::from_str("Not enough ADA leftover to include non-ADA assets in a change address"));
}
change_left = change_left.checked_sub(&change_value)?;
self.add_output(&change_output)?;
}
}
change_left = change_left.checked_sub(&Value::new(&new_fee))?;
// add potentially a separate pure ADA change output
let left_above_minimum = change_left.coin.compare(&minimum_utxo_val) > 0;
if self.config.prefer_pure_change && left_above_minimum {
let pure_output = TransactionOutput {
address: address.clone(),
amount: change_left.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
};
let additional_fee = self.fee_for_output(&pure_output)?;
let potential_pure_value =
change_left.checked_sub(&Value::new(&additional_fee))?;
let potential_pure_above_minimum =
potential_pure_value.coin.compare(&minimum_utxo_val) > 0;
if potential_pure_above_minimum {
new_fee = new_fee.checked_add(&additional_fee)?;
change_left = Value::zero();
self.add_output(&TransactionOutput {
address: address.clone(),
amount: potential_pure_value.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
}
}
self.set_fee(&new_fee);
// add in the rest of the ADA
if !change_left.is_zero() {
self.outputs.0.last_mut().unwrap().amount = self
.outputs
.0
.last()
.unwrap()
.amount
.checked_add(&change_left)?;
}
Ok(true)
} else {
let mut calc = MinOutputAdaCalculator::new_empty(&self.config.utxo_cost())?;
calc.set_amount(&change_estimator);
if let Some(data) = &plutus_data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &script_ref {
calc.set_script_ref(script_ref);
}
let min_ada = calc.calculate_ada()?;
// no-asset case so we have no problem burning the rest if there is no other option
fn burn_extra(
builder: &mut TransactionBuilder,
burn_amount: &BigNum,
) -> Result<bool, JsError> {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
builder.set_fee(burn_amount);
Ok(false) // not enough input to covert the extra fee from adding an output so we just burn whatever is left
}
match change_estimator.coin() >= min_ada {
false => burn_extra(self, &change_estimator.coin()),
true => {
// check how much the fee would increase if we added a change output
let fee_for_change = self.fee_for_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator.clone(),
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
let new_fee = fee.checked_add(&fee_for_change)?;
match change_estimator.coin()
>= min_ada.checked_add(&Value::new(&new_fee).coin())?
{
false => burn_extra(self, &change_estimator.coin()),
true => {
// recall: min_fee assumed the fee was the maximum possible so we definitely have enough input to cover whatever fee it ends up being
self.set_fee(&new_fee);
self.add_output(&TransactionOutput {
address: address.clone(),
amount: change_estimator
.checked_sub(&Value::new(&new_fee.clone()))?,
plutus_data: plutus_data.clone(),
script_ref: script_ref.clone(),
})?;
Ok(true)
}
}
}
}
}
}
None => Err(JsError::from_str(
"missing input or output for some native asset",
)),
}
}src/output_builder.rs (line 127)
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
pub fn with_asset_and_min_required_coin_by_utxo_cost(
&self,
multiasset: &MultiAsset,
data_cost: &DataCost,
) -> Result<TransactionOutputAmountBuilder, JsError> {
// TODO: double ada calculation needs to check if it redundant
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let min_possible_coin = calc.calculate_ada()?;
let mut value = Value::new(&min_possible_coin);
value.set_multiasset(multiasset);
let mut calc = MinOutputAdaCalculator::new_empty(data_cost)?;
calc.set_amount(&value);
if let Some(data) = &self.data {
match data {
DataOption::DataHash(data_hash) => calc.set_data_hash(data_hash),
DataOption::Data(datum) => calc.set_plutus_data(datum),
};
}
if let Some(script_ref) = &self.script_ref {
calc.set_script_ref(script_ref);
}
let required_coin = calc.calculate_ada()?;
Ok(self.with_coin_and_asset(&required_coin, &multiasset))
}sourcepub fn calc_size_cost(data_cost: &DataCost, size: usize) -> Result<Coin, JsError>
pub fn calc_size_cost(data_cost: &DataCost, size: usize) -> Result<Coin, JsError>
Examples found in repository?
More examples
src/tx_builder/batch_tools/cbor_calculator.rs (line 100)
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
pub(super) fn estimate_output_cost(used_coins: &Coin,
output_size: usize,
data_cost: &DataCost) -> Result<(Coin, usize), JsError> {
let mut current_cost = MinOutputAdaCalculator::calc_size_cost(data_cost, output_size)?;
if current_cost <= *used_coins {
return Ok((current_cost, output_size));
}
let size_without_coin = output_size - CborCalculator::get_coin_size(used_coins);
let mut last_size = size_without_coin + CborCalculator::get_coin_size(¤t_cost);
for _ in 0..3 {
current_cost = MinOutputAdaCalculator::calc_size_cost(data_cost, last_size)?;
let new_size = size_without_coin + CborCalculator::get_coin_size(¤t_cost);
if new_size == last_size {
return Ok((current_cost, last_size));
} else {
last_size = new_size;
}
}
let max_size = output_size + CborCalculator::get_coin_size(&Coin::max_value());
let pessimistic_cost = MinOutputAdaCalculator::calc_size_cost(data_cost, max_size)?;
Ok((pessimistic_cost, max_size))
}sourcepub fn calc_required_coin(
output: &TransactionOutput,
data_cost: &DataCost
) -> Result<Coin, JsError>
pub fn calc_required_coin(
output: &TransactionOutput,
data_cost: &DataCost
) -> Result<Coin, JsError>
Examples found in repository?
More examples
src/utils.rs (line 1391)
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
pub fn calculate_ada(&self) -> Result<BigNum, JsError> {
let mut output: TransactionOutput = self.output.clone();
for _ in 0..3 {
let required_coin = Self::calc_required_coin(&output, &self.data_cost)?;
if output.amount.coin.less_than(&required_coin) {
output.amount.coin = required_coin.clone();
} else {
return Ok(required_coin);
}
}
output.amount.coin = to_bignum(u64::MAX);
Ok(Self::calc_required_coin(&output, &self.data_cost)?)
}Trait Implementations§
source§impl Clone for MinOutputAdaCalculator
impl Clone for MinOutputAdaCalculator
source§fn clone(&self) -> MinOutputAdaCalculator
fn clone(&self) -> MinOutputAdaCalculator
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moresource§impl Debug for MinOutputAdaCalculator
impl Debug for MinOutputAdaCalculator
source§impl Ord for MinOutputAdaCalculator
impl Ord for MinOutputAdaCalculator
source§fn cmp(&self, other: &MinOutputAdaCalculator) -> Ordering
fn cmp(&self, other: &MinOutputAdaCalculator) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl PartialEq<MinOutputAdaCalculator> for MinOutputAdaCalculator
impl PartialEq<MinOutputAdaCalculator> for MinOutputAdaCalculator
source§fn eq(&self, other: &MinOutputAdaCalculator) -> bool
fn eq(&self, other: &MinOutputAdaCalculator) -> bool
This method tests for
self and other values to be equal, and is used
by ==.source§impl PartialOrd<MinOutputAdaCalculator> for MinOutputAdaCalculator
impl PartialOrd<MinOutputAdaCalculator> for MinOutputAdaCalculator
source§fn partial_cmp(&self, other: &MinOutputAdaCalculator) -> Option<Ordering>
fn partial_cmp(&self, other: &MinOutputAdaCalculator) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self and other) and is used by the <=
operator. Read more