Struct cardano_serialization_lib::NativeScript
source · pub struct NativeScript(_);
Implementations§
source§impl NativeScript
impl NativeScript
source§impl NativeScript
impl NativeScript
pub fn from_bytes(bytes: Vec<u8>) -> Result<NativeScript, DeserializeError>
source§impl NativeScript
impl NativeScript
pub fn from_hex(hex_str: &str) -> Result<NativeScript, DeserializeError>
source§impl NativeScript
impl NativeScript
source§impl NativeScript
impl NativeScript
sourcepub fn hash(&self) -> ScriptHash
pub fn hash(&self) -> ScriptHash
Examples found in repository?
src/tx_builder/tx_inputs_builder.rs (line 257)
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
pub fn script_hash(&self) -> ScriptHash {
match self {
ScriptWitnessType::NativeScriptWitness(script) => script.hash(),
ScriptWitnessType::PlutusScriptWitness(script) => script.script.script_hash(),
}
}
}
// We need to know how many of each type of witness will be in the transaction so we can calculate the tx fee
#[derive(Clone, Debug)]
pub struct RequiredWitnessSet {
vkeys: RequiredSignersSet,
scripts: LinkedHashMap<ScriptHash, LinkedHashMap<TransactionInput, Option<ScriptWitnessType>>>,
bootstraps: BTreeSet<Vec<u8>>,
}
#[wasm_bindgen]
#[derive(Clone, Debug)]
pub struct TxInputsBuilder {
inputs: BTreeMap<TransactionInput, (TxBuilderInput, Option<ScriptHash>)>,
required_witnesses: RequiredWitnessSet,
}
pub(crate) fn get_bootstraps(inputs: &TxInputsBuilder) -> BTreeSet<Vec<u8>> {
inputs.required_witnesses.bootstraps.clone()
}
#[wasm_bindgen]
impl TxInputsBuilder {
pub fn new() -> Self {
Self {
inputs: BTreeMap::new(),
required_witnesses: RequiredWitnessSet {
vkeys: BTreeSet::new(),
scripts: LinkedHashMap::new(),
bootstraps: BTreeSet::new(),
},
}
}
fn push_input(&mut self, e: (TxBuilderInput, Option<ScriptHash>)) {
self.inputs.insert(e.0.input.clone(), e);
}
/// We have to know what kind of inputs these are to know what kind of mock witnesses to create since
/// 1) mock witnesses have different lengths depending on the type which changes the expecting fee
/// 2) Witnesses are a set so we need to get rid of duplicates to avoid over-estimating the fee
pub fn add_key_input(
&mut self,
hash: &Ed25519KeyHash,
input: &TransactionInput,
amount: &Value,
) {
let inp = TxBuilderInput {
input: input.clone(),
amount: amount.clone(),
};
self.push_input((inp, None));
self.required_witnesses.vkeys.insert(hash.clone());
}
#[deprecated(
since = "11.2.0",
note = "Use `.add_native_script_input` or `.add_plutus_script_input` instead."
)]
/// !!! DEPRECATED !!!
/// This function can make a mistake in choosing right input index. Use `.add_native_script_input` or `.add_plutus_script_input` instead.
/// This method adds the input to the builder BUT leaves a missing spot for the witness native script
///
/// After adding the input with this method, use `.add_required_native_input_scripts`
/// and `.add_required_plutus_input_scripts` to add the witness scripts
///
/// Or instead use `.add_native_script_input` and `.add_plutus_script_input`
/// to add inputs right along with the script, instead of the script hash
pub fn add_script_input(
&mut self,
hash: &ScriptHash,
input: &TransactionInput,
amount: &Value,
) {
let inp = TxBuilderInput {
input: input.clone(),
amount: amount.clone(),
};
self.push_input((inp, Some(hash.clone())));
self.insert_input_with_empty_witness(hash, input);
}
/// This method will add the input to the builder and also register the required native script witness
pub fn add_native_script_input(
&mut self,
script: &NativeScript,
input: &TransactionInput,
amount: &Value,
) {
let hash = script.hash();
self.add_script_input(&hash, input, amount);
let witness = ScriptWitnessType::NativeScriptWitness(script.clone());
self.insert_input_with_witness(&hash, input, &witness);
}
/// This method will add the input to the builder and also register the required plutus witness
pub fn add_plutus_script_input(
&mut self,
witness: &PlutusWitness,
input: &TransactionInput,
amount: &Value,
) {
let hash = witness.script.script_hash();
self.add_script_input(&hash, input, amount);
let witness = ScriptWitnessType::PlutusScriptWitness(witness.clone());
self.insert_input_with_witness(&hash, input, &witness);
}
pub fn add_bootstrap_input(
&mut self,
hash: &ByronAddress,
input: &TransactionInput,
amount: &Value,
) {
let inp = TxBuilderInput {
input: input.clone(),
amount: amount.clone(),
};
self.push_input((inp, None));
self.required_witnesses.bootstraps.insert(hash.to_bytes());
}
/// Note that for script inputs this method will use underlying generic `.add_script_input`
/// which leaves a required empty spot for the script witness (or witnesses in case of Plutus).
/// You can use `.add_native_script_input` or `.add_plutus_script_input` directly to register the input along with the witness.
pub fn add_input(&mut self, address: &Address, input: &TransactionInput, amount: &Value) {
match &BaseAddress::from_address(address) {
Some(addr) => {
match &addr.payment_cred().to_keyhash() {
Some(hash) => return self.add_key_input(hash, input, amount),
None => (),
}
match &addr.payment_cred().to_scripthash() {
Some(hash) => return self.add_script_input(hash, input, amount),
None => (),
}
}
None => (),
}
match &EnterpriseAddress::from_address(address) {
Some(addr) => {
match &addr.payment_cred().to_keyhash() {
Some(hash) => return self.add_key_input(hash, input, amount),
None => (),
}
match &addr.payment_cred().to_scripthash() {
Some(hash) => return self.add_script_input(hash, input, amount),
None => (),
}
}
None => (),
}
match &PointerAddress::from_address(address) {
Some(addr) => {
match &addr.payment_cred().to_keyhash() {
Some(hash) => return self.add_key_input(hash, input, amount),
None => (),
}
match &addr.payment_cred().to_scripthash() {
Some(hash) => return self.add_script_input(hash, input, amount),
None => (),
}
}
None => (),
}
match &ByronAddress::from_address(address) {
Some(addr) => {
return self.add_bootstrap_input(addr, input, amount);
}
None => (),
}
}
/// Returns the number of still missing input scripts (either native or plutus)
/// Use `.add_required_native_input_scripts` or `.add_required_plutus_input_scripts` to add the missing scripts
pub fn count_missing_input_scripts(&self) -> usize {
self.required_witnesses
.scripts
.values()
.flat_map(|v| v.values())
.filter(|s| s.is_none())
.count()
}
/// Try adding the specified scripts as witnesses for ALREADY ADDED script inputs
/// Any scripts that don't match any of the previously added inputs will be ignored
/// Returns the number of remaining required missing witness scripts
/// Use `.count_missing_input_scripts` to find the number of still missing scripts
pub fn add_required_native_input_scripts(&mut self, scripts: &NativeScripts) -> usize {
scripts.0.iter().for_each(|s: &NativeScript| {
let hash = s.hash();
if let Some(script_wits) = self.required_witnesses.scripts.get_mut(&hash) {
let mut tx_in = None;
for script_wit in script_wits {
if script_wit.1.is_none() {
tx_in = Some(script_wit.0.clone());
break;
}
}
if let Some(tx_in) = tx_in {
let witness = ScriptWitnessType::NativeScriptWitness(s.clone());
self.insert_input_with_witness(&hash, &tx_in, &witness);
}
}
});
self.count_missing_input_scripts()
}
More examples
src/tx_builder.rs (line 166)
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
fn assert_required_mint_scripts(
mint: &Mint,
maybe_mint_scripts: Option<&NativeScripts>,
) -> Result<(), JsError> {
if maybe_mint_scripts.is_none_or_empty() {
return Err(JsError::from_str(
"Mint is present in the builder, but witness scripts are not provided!",
));
}
let mint_scripts = maybe_mint_scripts.unwrap();
let witness_hashes: HashSet<ScriptHash> =
mint_scripts.0.iter().map(|script| script.hash()).collect();
for mint_hash in mint.keys().0.iter() {
if !witness_hashes.contains(mint_hash) {
return Err(JsError::from_str(&format!(
"No witness script is found for mint policy '{:?}'! Script is required!",
hex::encode(mint_hash.to_bytes()),
)));
}
}
Ok(())
}
fn min_fee(tx_builder: &TransactionBuilder) -> Result<Coin, JsError> {
// Commented out for performance, `min_fee` is a critical function
// This was mostly added here as a paranoid step anyways
// If someone is using `set_mint` and `add_mint*` API function, everything is expected to be intact
// TODO: figure out if assert is needed here and a better way to do it maybe only once if mint doesn't change
// if let Some(mint) = tx_builder.mint.as_ref() {
// assert_required_mint_scripts(mint, tx_builder.mint_scripts.as_ref())?;
// }
let full_tx = fake_full_tx(tx_builder, tx_builder.build()?)?;
let fee: Coin = fees::min_fee(&full_tx, &tx_builder.config.fee_algo)?;
if let Some(ex_unit_prices) = &tx_builder.config.ex_unit_prices {
let script_fee: Coin = fees::min_script_fee(&full_tx, &ex_unit_prices)?;
return fee.checked_add(&script_fee);
}
if tx_builder.has_plutus_inputs() {
return Err(JsError::from_str(
"Plutus inputs are present but ex unit prices are missing in the config!",
));
}
Ok(fee)
}
#[wasm_bindgen]
pub enum CoinSelectionStrategyCIP2 {
/// Performs CIP2's Largest First ada-only selection. Will error if outputs contain non-ADA assets.
LargestFirst,
/// Performs CIP2's Random Improve ada-only selection. Will error if outputs contain non-ADA assets.
RandomImprove,
/// Same as LargestFirst, but before adding ADA, will insert by largest-first for each asset type.
LargestFirstMultiAsset,
/// Same as RandomImprove, but before adding ADA, will insert by random-improve for each asset type.
RandomImproveMultiAsset,
}
#[wasm_bindgen]
#[derive(Clone, Debug)]
pub struct TransactionBuilderConfig {
fee_algo: fees::LinearFee,
pool_deposit: Coin, // protocol parameter
key_deposit: Coin, // protocol parameter
max_value_size: u32, // protocol parameter
max_tx_size: u32, // protocol parameter
data_cost: DataCost, // protocol parameter
ex_unit_prices: Option<ExUnitPrices>, // protocol parameter
prefer_pure_change: bool,
}
impl TransactionBuilderConfig {
fn utxo_cost(&self) -> DataCost {
self.data_cost.clone()
}
}
#[wasm_bindgen]
#[derive(Clone, Debug)]
pub struct TransactionBuilderConfigBuilder {
fee_algo: Option<fees::LinearFee>,
pool_deposit: Option<Coin>, // protocol parameter
key_deposit: Option<Coin>, // protocol parameter
max_value_size: Option<u32>, // protocol parameter
max_tx_size: Option<u32>, // protocol parameter
data_cost: Option<DataCost>, // protocol parameter
ex_unit_prices: Option<ExUnitPrices>, // protocol parameter
prefer_pure_change: bool,
}
#[wasm_bindgen]
impl TransactionBuilderConfigBuilder {
pub fn new() -> Self {
Self {
fee_algo: None,
pool_deposit: None,
key_deposit: None,
max_value_size: None,
max_tx_size: None,
data_cost: None,
ex_unit_prices: None,
prefer_pure_change: false,
}
}
pub fn fee_algo(&self, fee_algo: &fees::LinearFee) -> Self {
let mut cfg = self.clone();
cfg.fee_algo = Some(fee_algo.clone());
cfg
}
/// !!! DEPRECATED !!!
/// Since babbage era cardano nodes use coins per byte. Use '.coins_per_utxo_byte' instead.
#[deprecated(
since = "11.0.0",
note = "Since babbage era cardano nodes use coins per byte. Use '.coins_per_utxo_byte' instead."
)]
pub fn coins_per_utxo_word(&self, coins_per_utxo_word: &Coin) -> Self {
let mut cfg = self.clone();
cfg.data_cost = Some(DataCost::new_coins_per_word(coins_per_utxo_word));
cfg
}
pub fn coins_per_utxo_byte(&self, coins_per_utxo_byte: &Coin) -> Self {
let mut cfg = self.clone();
cfg.data_cost = Some(DataCost::new_coins_per_byte(coins_per_utxo_byte));
cfg
}
pub fn ex_unit_prices(&self, ex_unit_prices: &ExUnitPrices) -> Self {
let mut cfg = self.clone();
cfg.ex_unit_prices = Some(ex_unit_prices.clone());
cfg
}
pub fn pool_deposit(&self, pool_deposit: &BigNum) -> Self {
let mut cfg = self.clone();
cfg.pool_deposit = Some(pool_deposit.clone());
cfg
}
pub fn key_deposit(&self, key_deposit: &BigNum) -> Self {
let mut cfg = self.clone();
cfg.key_deposit = Some(key_deposit.clone());
cfg
}
pub fn max_value_size(&self, max_value_size: u32) -> Self {
let mut cfg = self.clone();
cfg.max_value_size = Some(max_value_size);
cfg
}
pub fn max_tx_size(&self, max_tx_size: u32) -> Self {
let mut cfg = self.clone();
cfg.max_tx_size = Some(max_tx_size);
cfg
}
pub fn prefer_pure_change(&self, prefer_pure_change: bool) -> Self {
let mut cfg = self.clone();
cfg.prefer_pure_change = prefer_pure_change;
cfg
}
pub fn build(&self) -> Result<TransactionBuilderConfig, JsError> {
let cfg: Self = self.clone();
Ok(TransactionBuilderConfig {
fee_algo: cfg
.fee_algo
.ok_or(JsError::from_str("uninitialized field: fee_algo"))?,
pool_deposit: cfg
.pool_deposit
.ok_or(JsError::from_str("uninitialized field: pool_deposit"))?,
key_deposit: cfg
.key_deposit
.ok_or(JsError::from_str("uninitialized field: key_deposit"))?,
max_value_size: cfg
.max_value_size
.ok_or(JsError::from_str("uninitialized field: max_value_size"))?,
max_tx_size: cfg
.max_tx_size
.ok_or(JsError::from_str("uninitialized field: max_tx_size"))?,
data_cost: cfg.data_cost.ok_or(JsError::from_str(
"uninitialized field: coins_per_utxo_byte or coins_per_utxo_word",
))?,
ex_unit_prices: cfg.ex_unit_prices,
prefer_pure_change: cfg.prefer_pure_change,
})
}
}
#[wasm_bindgen]
#[derive(Clone, Debug)]
pub struct TransactionBuilder {
config: TransactionBuilderConfig,
inputs: TxInputsBuilder,
collateral: TxInputsBuilder,
outputs: TransactionOutputs,
fee: Option<Coin>,
ttl: Option<SlotBigNum>, // absolute slot number
certs: Option<Certificates>,
withdrawals: Option<Withdrawals>,
auxiliary_data: Option<AuxiliaryData>,
validity_start_interval: Option<SlotBigNum>,
mint: Option<MintBuilder>,
script_data_hash: Option<ScriptDataHash>,
required_signers: Ed25519KeyHashes,
collateral_return: Option<TransactionOutput>,
total_collateral: Option<Coin>,
reference_inputs: HashSet<TransactionInput>,
}
#[wasm_bindgen]
impl TransactionBuilder {
/// This automatically selects and adds inputs from {inputs} consisting of just enough to cover
/// the outputs that have already been added.
/// This should be called after adding all certs/outputs/etc and will be an error otherwise.
/// Uses CIP2: https://github.com/cardano-foundation/CIPs/blob/master/CIP-0002/CIP-0002.md
/// Adding a change output must be called after via TransactionBuilder::add_change_if_needed()
/// This function, diverging from CIP2, takes into account fees and will attempt to add additional
/// inputs to cover the minimum fees. This does not, however, set the txbuilder's fee.
pub fn add_inputs_from(
&mut self,
inputs: &TransactionUnspentOutputs,
strategy: CoinSelectionStrategyCIP2,
) -> Result<(), JsError> {
let available_inputs = &inputs.0.clone();
let mut input_total = self.get_total_input()?;
let mut output_total = self
.get_total_output()?
.checked_add(&Value::new(&self.min_fee()?))?;
match strategy {
CoinSelectionStrategyCIP2::LargestFirst => {
if self
.outputs
.0
.iter()
.any(|output| output.amount.multiasset.is_some())
{
return Err(JsError::from_str("Multiasset values not supported by LargestFirst. Please use LargestFirstMultiAsset"));
}
self.cip2_largest_first_by(
available_inputs,
&mut (0..available_inputs.len()).collect(),
&mut input_total,
&mut output_total,
|value| Some(value.coin),
)?;
}
CoinSelectionStrategyCIP2::RandomImprove => {
if self
.outputs
.0
.iter()
.any(|output| output.amount.multiasset.is_some())
{
return Err(JsError::from_str("Multiasset values not supported by RandomImprove. Please use RandomImproveMultiAsset"));
}
use rand::Rng;
let mut rng = rand::thread_rng();
let mut available_indices =
(0..available_inputs.len()).collect::<BTreeSet<usize>>();
self.cip2_random_improve_by(
available_inputs,
&mut available_indices,
&mut input_total,
&mut output_total,
|value| Some(value.coin),
&mut rng,
true,
)?;
// Phase 3: add extra inputs needed for fees (not covered by CIP-2)
// We do this at the end because this new inputs won't be associated with
// a specific output, so the improvement algorithm we do above does not apply here.
while input_total.coin < output_total.coin {
if available_indices.is_empty() {
return Err(JsError::from_str("UTxO Balance Insufficient[x]"));
}
let i = *available_indices
.iter()
.nth(rng.gen_range(0..available_indices.len()))
.unwrap();
available_indices.remove(&i);
let input = &available_inputs[i];
let input_fee = self.fee_for_input(
&input.output.address,
&input.input,
&input.output.amount,
)?;
self.add_input(&input.output.address, &input.input, &input.output.amount);
input_total = input_total.checked_add(&input.output.amount)?;
output_total = output_total.checked_add(&Value::new(&input_fee))?;
}
}
CoinSelectionStrategyCIP2::LargestFirstMultiAsset => {
// indices into {available_inputs} for inputs that contain {policy_id}:{asset_name}
let mut available_indices = (0..available_inputs.len()).collect::<Vec<usize>>();
// run largest-fist by each asset type
if let Some(ma) = output_total.multiasset.clone() {
for (policy_id, assets) in ma.0.iter() {
for (asset_name, _) in assets.0.iter() {
self.cip2_largest_first_by(
available_inputs,
&mut available_indices,
&mut input_total,
&mut output_total,
|value| value.multiasset.as_ref()?.get(policy_id)?.get(asset_name),
)?;
}
}
}
// add in remaining ADA
self.cip2_largest_first_by(
available_inputs,
&mut available_indices,
&mut input_total,
&mut output_total,
|value| Some(value.coin),
)?;
}
CoinSelectionStrategyCIP2::RandomImproveMultiAsset => {
use rand::Rng;
let mut rng = rand::thread_rng();
let mut available_indices =
(0..available_inputs.len()).collect::<BTreeSet<usize>>();
// run random-improve by each asset type
if let Some(ma) = output_total.multiasset.clone() {
for (policy_id, assets) in ma.0.iter() {
for (asset_name, _) in assets.0.iter() {
self.cip2_random_improve_by(
available_inputs,
&mut available_indices,
&mut input_total,
&mut output_total,
|value| value.multiasset.as_ref()?.get(policy_id)?.get(asset_name),
&mut rng,
false,
)?;
}
}
}
// add in remaining ADA
self.cip2_random_improve_by(
available_inputs,
&mut available_indices,
&mut input_total,
&mut output_total,
|value| Some(value.coin),
&mut rng,
false,
)?;
// Phase 3: add extra inputs needed for fees (not covered by CIP-2)
// We do this at the end because this new inputs won't be associated with
// a specific output, so the improvement algorithm we do above does not apply here.
while input_total.coin < output_total.coin {
if available_indices.is_empty() {
return Err(JsError::from_str("UTxO Balance Insufficient[x]"));
}
let i = *available_indices
.iter()
.nth(rng.gen_range(0..available_indices.len()))
.unwrap();
available_indices.remove(&i);
let input = &available_inputs[i];
let input_fee = self.fee_for_input(
&input.output.address,
&input.input,
&input.output.amount,
)?;
self.add_input(&input.output.address, &input.input, &input.output.amount);
input_total = input_total.checked_add(&input.output.amount)?;
output_total = output_total.checked_add(&Value::new(&input_fee))?;
}
}
}
Ok(())
}
fn cip2_largest_first_by<F>(
&mut self,
available_inputs: &Vec<TransactionUnspentOutput>,
available_indices: &mut Vec<usize>,
input_total: &mut Value,
output_total: &mut Value,
by: F,
) -> Result<(), JsError>
where
F: Fn(&Value) -> Option<BigNum>,
{
let mut relevant_indices = available_indices.clone();
relevant_indices.retain(|i| by(&available_inputs[*i].output.amount).is_some());
// ordered in ascending order by predicate {by}
relevant_indices
.sort_by_key(|i| by(&available_inputs[*i].output.amount).expect("filtered above"));
// iterate in decreasing order for predicate {by}
for i in relevant_indices.iter().rev() {
if by(input_total).unwrap_or(BigNum::zero())
>= by(output_total).expect("do not call on asset types that aren't in the output")
{
break;
}
let input = &available_inputs[*i];
// differing from CIP2, we include the needed fees in the targets instead of just output values
let input_fee =
self.fee_for_input(&input.output.address, &input.input, &input.output.amount)?;
self.add_input(&input.output.address, &input.input, &input.output.amount);
*input_total = input_total.checked_add(&input.output.amount)?;
*output_total = output_total.checked_add(&Value::new(&input_fee))?;
available_indices.swap_remove(available_indices.iter().position(|j| i == j).unwrap());
}
if by(input_total).unwrap_or(BigNum::zero())
< by(output_total).expect("do not call on asset types that aren't in the output")
{
return Err(JsError::from_str("UTxO Balance Insufficient"));
}
Ok(())
}
fn cip2_random_improve_by<F>(
&mut self,
available_inputs: &Vec<TransactionUnspentOutput>,
available_indices: &mut BTreeSet<usize>,
input_total: &mut Value,
output_total: &mut Value,
by: F,
rng: &mut rand::rngs::ThreadRng,
pure_ada: bool,
) -> Result<(), JsError>
where
F: Fn(&Value) -> Option<BigNum>,
{
use rand::Rng;
// Phase 1: Random Selection
let mut relevant_indices = available_indices
.iter()
.filter(|i| by(&available_inputs[**i].output.amount).is_some())
.cloned()
.collect::<Vec<usize>>();
let mut associated_indices: BTreeMap<TransactionOutput, Vec<usize>> = BTreeMap::new();
let mut outputs = self
.outputs
.0
.iter()
.filter(|output| by(&output.amount).is_some())
.cloned()
.collect::<Vec<TransactionOutput>>();
outputs.sort_by_key(|output| by(&output.amount).expect("filtered above"));
let mut available_coins = by(input_total).unwrap_or(BigNum::zero());
for output in outputs.iter().rev() {
// TODO: how should we adapt this to inputs being associated when running for other assets?
// if we do these two phases for each asset and don't take into account the other runs for other assets
// then we over-add (and potentially fail if we don't have plenty of inputs)
// On the other hand, the improvement phase it difficult to determine if a change is an improvement
// if we're trying to improve for multiple assets at a time without knowing how important each input is
// e.g. maybe we have lots of asset A but not much of B
// For now I will just have this be entirely separarte per-asset but we might want to in a later commit
// consider the improvements separately and have it take some kind of dot product / distance for assets
// during the improvement phase and have the improvement phase target multiple asset types at once.
// One issue with that is how to scale in between differnet assets. We could maybe normalize them by
// dividing each asset type by the sum of the required asset type in all outputs.
// Another possibility for adapting this to multiasstes is when associating an input x for asset type a
// we try and subtract all other assets b != a from the outputs we're trying to cover.
// It might make sense to diverge further and not consider it per-output and to instead just match against
// the sum of all outputs as one single value.
let mut added = available_coins.clone();
let needed = by(&output.amount).unwrap();
while added < needed {
if relevant_indices.is_empty() {
return Err(JsError::from_str("UTxO Balance Insufficient"));
}
let random_index = rng.gen_range(0..relevant_indices.len());
let i = relevant_indices.swap_remove(random_index);
available_indices.remove(&i);
let input = &available_inputs[i];
added = added.checked_add(
&by(&input.output.amount)
.expect("do not call on asset types that aren't in the output"),
)?;
associated_indices
.entry(output.clone())
.or_default()
.push(i);
}
available_coins = added.checked_sub(&needed)?;
}
if !relevant_indices.is_empty() && pure_ada {
// Phase 2: Improvement
for output in outputs.iter_mut() {
let associated = associated_indices.get_mut(output).unwrap();
for i in associated.iter_mut() {
let random_index = rng.gen_range(0..relevant_indices.len());
let j: &mut usize = relevant_indices.get_mut(random_index).unwrap();
let input = &available_inputs[*i];
let new_input = &available_inputs[*j];
let cur = from_bignum(&by(&input.output.amount).unwrap_or(BigNum::zero()));
let new = from_bignum(&by(&new_input.output.amount).unwrap_or(BigNum::zero()));
let min = from_bignum(&by(&output.amount).unwrap_or(BigNum::zero()));
let ideal = 2 * min;
let max = 3 * min;
let move_closer =
(ideal as i128 - new as i128).abs() < (ideal as i128 - cur as i128).abs();
let not_exceed_max = new < max;
if move_closer && not_exceed_max {
std::mem::swap(i, j);
available_indices.insert(*i);
available_indices.remove(j);
}
}
}
}
// after finalizing the improvement we need to actually add these results to the builder
for output in outputs.iter() {
if let Some(associated) = associated_indices.get(output) {
for i in associated.iter() {
let input = &available_inputs[*i];
let input_fee =
self.fee_for_input(&input.output.address, &input.input, &input.output.amount)?;
self.add_input(&input.output.address, &input.input, &input.output.amount);
*input_total = input_total.checked_add(&input.output.amount)?;
*output_total = output_total.checked_add(&Value::new(&input_fee))?;
}
}
}
Ok(())
}
pub fn set_inputs(&mut self, inputs: &TxInputsBuilder) {
self.inputs = inputs.clone();
}
pub fn set_collateral(&mut self, collateral: &TxInputsBuilder) {
self.collateral = collateral.clone();
}
pub fn set_collateral_return(&mut self, collateral_return: &TransactionOutput) {
self.collateral_return = Some(collateral_return.clone());
}
/// This function will set the collateral-return value and then auto-calculate and assign
/// the total collateral coin value. Will raise an error in case no collateral inputs are set
/// or in case the total collateral value will have any assets in it except coin.
pub fn set_collateral_return_and_total(
&mut self,
collateral_return: &TransactionOutput,
) -> Result<(), JsError> {
let collateral = &self.collateral;
if collateral.len() == 0 {
return Err(JsError::from_str(
"Cannot calculate total collateral value when collateral inputs are missing",
));
}
let col_input_value: Value = collateral.total_value()?;
let total_col: Value = col_input_value.checked_sub(&collateral_return.amount())?;
if total_col.multiasset.is_some() {
return Err(JsError::from_str(
"Total collateral value cannot contain assets!",
));
}
let min_ada = min_ada_for_output(&collateral_return, &self.config.utxo_cost())?;
if min_ada > collateral_return.amount.coin {
return Err(JsError::from_str(&format!(
"Not enough coin to make return on the collateral value!\
Increase amount of return coins. \
Min ada for return {}, but was {}",
min_ada, collateral_return.amount.coin
)));
}
self.set_collateral_return(collateral_return);
self.total_collateral = Some(total_col.coin);
Ok(())
}
pub fn set_total_collateral(&mut self, total_collateral: &Coin) {
self.total_collateral = Some(total_collateral.clone());
}
/// This function will set the total-collateral coin and then auto-calculate and assign
/// the collateral return value. Will raise an error in case no collateral inputs are set.
/// The specified address will be the received of the collateral return
pub fn set_total_collateral_and_return(
&mut self,
total_collateral: &Coin,
return_address: &Address,
) -> Result<(), JsError> {
let collateral = &self.collateral;
if collateral.len() == 0 {
return Err(JsError::from_str(
"Cannot calculate collateral return when collateral inputs are missing",
));
}
let col_input_value: Value = collateral.total_value()?;
let col_return: Value = col_input_value.checked_sub(&Value::new(&total_collateral))?;
if col_return.multiasset.is_some() || col_return.coin > BigNum::zero() {
let return_output = TransactionOutput::new(return_address, &col_return);
let min_ada = min_ada_for_output(&return_output, &self.config.utxo_cost())?;
if min_ada > col_return.coin {
return Err(JsError::from_str(&format!(
"Not enough coin to make return on the collateral value!\
Decrease the total collateral value or add more collateral inputs. \
Min ada for return {}, but was {}",
min_ada, col_return.coin
)));
}
self.collateral_return = Some(return_output);
}
self.set_total_collateral(total_collateral);
Ok(())
}
pub fn add_reference_input(&mut self, reference_input: &TransactionInput) {
self.reference_inputs.insert(reference_input.clone());
}
/// We have to know what kind of inputs these are to know what kind of mock witnesses to create since
/// 1) mock witnesses have different lengths depending on the type which changes the expecting fee
/// 2) Witnesses are a set so we need to get rid of duplicates to avoid over-estimating the fee
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_key_input(
&mut self,
hash: &Ed25519KeyHash,
input: &TransactionInput,
amount: &Value,
) {
self.inputs.add_key_input(hash, input, amount);
}
/// This method adds the input to the builder BUT leaves a missing spot for the witness native script
///
/// After adding the input with this method, use `.add_required_native_input_scripts`
/// and `.add_required_plutus_input_scripts` to add the witness scripts
///
/// Or instead use `.add_native_script_input` and `.add_plutus_script_input`
/// to add inputs right along with the script, instead of the script hash
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_script_input(
&mut self,
hash: &ScriptHash,
input: &TransactionInput,
amount: &Value,
) {
self.inputs.add_script_input(hash, input, amount);
}
/// This method will add the input to the builder and also register the required native script witness
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_native_script_input(
&mut self,
script: &NativeScript,
input: &TransactionInput,
amount: &Value,
) {
self.inputs.add_native_script_input(script, input, amount);
}
/// This method will add the input to the builder and also register the required plutus witness
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_plutus_script_input(
&mut self,
witness: &PlutusWitness,
input: &TransactionInput,
amount: &Value,
) {
self.inputs.add_plutus_script_input(witness, input, amount);
}
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_bootstrap_input(
&mut self,
hash: &ByronAddress,
input: &TransactionInput,
amount: &Value,
) {
self.inputs.add_bootstrap_input(hash, input, amount);
}
/// Note that for script inputs this method will use underlying generic `.add_script_input`
/// which leaves a required empty spot for the script witness (or witnesses in case of Plutus).
/// You can use `.add_native_script_input` or `.add_plutus_script_input` directly to register the input along with the witness.
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_input(&mut self, address: &Address, input: &TransactionInput, amount: &Value) {
self.inputs.add_input(address, input, amount);
}
/// Returns the number of still missing input scripts (either native or plutus)
/// Use `.add_required_native_input_scripts` or `.add_required_plutus_input_scripts` to add the missing scripts
#[deprecated(since = "10.2.0", note = "Use `.count_missing_input_scripts` from `TxInputsBuilder`")]
pub fn count_missing_input_scripts(&self) -> usize {
self.inputs.count_missing_input_scripts()
}
/// Try adding the specified scripts as witnesses for ALREADY ADDED script inputs
/// Any scripts that don't match any of the previously added inputs will be ignored
/// Returns the number of remaining required missing witness scripts
/// Use `.count_missing_input_scripts` to find the number of still missing scripts
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_required_native_input_scripts(&mut self, scripts: &NativeScripts) -> usize {
self.inputs.add_required_native_input_scripts(scripts)
}
/// Try adding the specified scripts as witnesses for ALREADY ADDED script inputs
/// Any scripts that don't match any of the previously added inputs will be ignored
/// Returns the number of remaining required missing witness scripts
/// Use `.count_missing_input_scripts` to find the number of still missing scripts
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn add_required_plutus_input_scripts(&mut self, scripts: &PlutusWitnesses) -> usize {
self.inputs.add_required_plutus_input_scripts(scripts)
}
/// Returns a copy of the current script input witness scripts in the builder
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn get_native_input_scripts(&self) -> Option<NativeScripts> {
self.inputs.get_native_input_scripts()
}
/// Returns a copy of the current plutus input witness scripts in the builder.
/// NOTE: each plutus witness will be cloned with a specific corresponding input index
#[deprecated(since = "10.2.0", note = "Use `.set_inputs`")]
pub fn get_plutus_input_scripts(&self) -> Option<PlutusWitnesses> {
self.inputs.get_plutus_input_scripts()
}
/// calculates how much the fee would increase if you added a given output
pub fn fee_for_input(
&self,
address: &Address,
input: &TransactionInput,
amount: &Value,
) -> Result<Coin, JsError> {
let mut self_copy = self.clone();
// we need some value for these for it to be a a valid transaction
// but since we're only calculating the difference between the fee of two transactions
// it doesn't matter what these are set as, since it cancels out
self_copy.set_fee(&to_bignum(0));
let fee_before = min_fee(&self_copy)?;
self_copy.add_input(&address, &input, &amount);
let fee_after = min_fee(&self_copy)?;
fee_after.checked_sub(&fee_before)
}
/// Add explicit output via a TransactionOutput object
pub fn add_output(&mut self, output: &TransactionOutput) -> Result<(), JsError> {
let value_size = output.amount.to_bytes().len();
if value_size > self.config.max_value_size as usize {
return Err(JsError::from_str(&format!(
"Maximum value size of {} exceeded. Found: {}",
self.config.max_value_size, value_size
)));
}
let min_ada = min_ada_for_output(&output, &self.config.utxo_cost())?;
if output.amount().coin() < min_ada {
Err(JsError::from_str(&format!(
"Value {} less than the minimum UTXO value {}",
from_bignum(&output.amount().coin()),
from_bignum(&min_ada)
)))
} else {
self.outputs.add(output);
Ok(())
}
}
/// calculates how much the fee would increase if you added a given output
pub fn fee_for_output(&self, output: &TransactionOutput) -> Result<Coin, JsError> {
let mut self_copy = self.clone();
// we need some value for these for it to be a a valid transaction
// but since we're only calculating the different between the fee of two transactions
// it doesn't matter what these are set as, since it cancels out
self_copy.set_fee(&to_bignum(0));
let fee_before = min_fee(&self_copy)?;
self_copy.add_output(&output)?;
let fee_after = min_fee(&self_copy)?;
fee_after.checked_sub(&fee_before)
}
pub fn set_fee(&mut self, fee: &Coin) {
self.fee = Some(fee.clone())
}
/// !!! DEPRECATED !!!
/// Set ttl value.
#[deprecated(
since = "10.1.0",
note = "Underlying value capacity of ttl (BigNum u64) bigger then Slot32. Use set_ttl_bignum instead."
)]
pub fn set_ttl(&mut self, ttl: Slot32) {
self.ttl = Some(ttl.into())
}
pub fn set_ttl_bignum(&mut self, ttl: &SlotBigNum) {
self.ttl = Some(ttl.clone())
}
/// !!! DEPRECATED !!!
/// Uses outdated slot number format.
#[deprecated(
since = "10.1.0",
note = "Underlying value capacity of validity_start_interval (BigNum u64) bigger then Slot32. Use set_validity_start_interval_bignum instead."
)]
pub fn set_validity_start_interval(&mut self, validity_start_interval: Slot32) {
self.validity_start_interval = Some(validity_start_interval.into())
}
pub fn set_validity_start_interval_bignum(&mut self, validity_start_interval: SlotBigNum) {
self.validity_start_interval = Some(validity_start_interval.clone())
}
pub fn set_certs(&mut self, certs: &Certificates) {
self.certs = Some(certs.clone());
for cert in &certs.0 {
self.inputs
.add_required_signers(&witness_keys_for_cert(cert))
}
}
pub fn set_withdrawals(&mut self, withdrawals: &Withdrawals) {
self.withdrawals = Some(withdrawals.clone());
for (withdrawal, _coin) in &withdrawals.0 {
self.inputs
.add_required_signer(&withdrawal.payment_cred().to_keyhash().unwrap())
}
}
pub fn get_auxiliary_data(&self) -> Option<AuxiliaryData> {
self.auxiliary_data.clone()
}
/// Set explicit auxiliary data via an AuxiliaryData object
/// It might contain some metadata plus native or Plutus scripts
pub fn set_auxiliary_data(&mut self, auxiliary_data: &AuxiliaryData) {
self.auxiliary_data = Some(auxiliary_data.clone())
}
/// Set metadata using a GeneralTransactionMetadata object
/// It will be set to the existing or new auxiliary data in this builder
pub fn set_metadata(&mut self, metadata: &GeneralTransactionMetadata) {
let mut aux = self
.auxiliary_data
.as_ref()
.cloned()
.unwrap_or(AuxiliaryData::new());
aux.set_metadata(metadata);
self.set_auxiliary_data(&aux);
}
/// Add a single metadatum using TransactionMetadatumLabel and TransactionMetadatum objects
/// It will be securely added to existing or new metadata in this builder
pub fn add_metadatum(&mut self, key: &TransactionMetadatumLabel, val: &TransactionMetadatum) {
let mut metadata = self
.auxiliary_data
.as_ref()
.map(|aux| aux.metadata().as_ref().cloned())
.unwrap_or(None)
.unwrap_or(GeneralTransactionMetadata::new());
metadata.insert(key, val);
self.set_metadata(&metadata);
}
/// Add a single JSON metadatum using a TransactionMetadatumLabel and a String
/// It will be securely added to existing or new metadata in this builder
pub fn add_json_metadatum(
&mut self,
key: &TransactionMetadatumLabel,
val: String,
) -> Result<(), JsError> {
self.add_json_metadatum_with_schema(key, val, MetadataJsonSchema::NoConversions)
}
/// Add a single JSON metadatum using a TransactionMetadatumLabel, a String, and a MetadataJsonSchema object
/// It will be securely added to existing or new metadata in this builder
pub fn add_json_metadatum_with_schema(
&mut self,
key: &TransactionMetadatumLabel,
val: String,
schema: MetadataJsonSchema,
) -> Result<(), JsError> {
let metadatum = encode_json_str_to_metadatum(val, schema)?;
self.add_metadatum(key, &metadatum);
Ok(())
}
pub fn set_mint_builder(&mut self, mint_builder: &MintBuilder) {
self.mint = Some(mint_builder.clone());
}
pub fn get_mint_builder(&self) -> Option<MintBuilder> {
self.mint.clone()
}
/// !!! DEPRECATED !!!
/// Mints are defining by MintBuilder now.
/// Use `.set_mint_builder()` and `MintBuilder` instead.
#[deprecated(
since = "11.2.0",
note = "Mints are defining by MintBuilder now. Use `.set_mint_builder()` and `MintBuilder` instead."
)]
/// Set explicit Mint object and the required witnesses to this builder
/// it will replace any previously existing mint and mint scripts
/// NOTE! Error will be returned in case a mint policy does not have a matching script
pub fn set_mint(&mut self, mint: &Mint, mint_scripts: &NativeScripts) -> Result<(), JsError> {
assert_required_mint_scripts(mint, Some(mint_scripts))?;
let mut scripts_policies = HashMap::new();
for scipt in &mint_scripts.0 {
scripts_policies.insert(scipt.hash(), scipt.clone());
}
let mut mint_builder = MintBuilder::new();
for (policy_id, asset_map) in &mint.0 {
for (asset_name, amount) in &asset_map.0 {
if let Some(script) = scripts_policies.get(policy_id) {
let mint_witness = MintWitness::new_native_script(script);
mint_builder.set_asset(&mint_witness, asset_name, amount);
} else {
return Err(JsError::from_str("Mint policy does not have a matching script"));
}
}
}
self.mint = Some(mint_builder);
Ok(())
}
/// !!! DEPRECATED !!!
/// Mints are defining by MintBuilder now.
/// Use `.get_mint_builder()` and `.build()` instead.
#[deprecated(
since = "11.2.0",
note = "Mints are defining by MintBuilder now. Use `.get_mint_builder()` and `.build()` instead."
)]
/// Returns a copy of the current mint state in the builder
pub fn get_mint(&self) -> Option<Mint> {
match &self.mint {
Some(mint) => Some(mint.build()),
None => None,
}
}
/// Returns a copy of the current mint witness scripts in the builder
pub fn get_mint_scripts(&self) -> Option<NativeScripts> {
match &self.mint {
Some(mint) => Some(mint.get_native_scripts()),
None => None,
}
}
/// !!! DEPRECATED !!!
/// Mints are defining by MintBuilder now.
/// Use `.set_mint_builder()` and `MintBuilder` instead.
#[deprecated(
since = "11.2.0",
note = "Mints are defining by MintBuilder now. Use `.set_mint_builder()` and `MintBuilder` instead."
)]
/// Add a mint entry to this builder using a PolicyID and MintAssets object
/// It will be securely added to existing or new Mint in this builder
/// It will replace any existing mint assets with the same PolicyID
pub fn set_mint_asset(&mut self, policy_script: &NativeScript, mint_assets: &MintAssets) {
let mint_witness = MintWitness::new_native_script(policy_script);
if let Some(mint) = &mut self.mint {
for (asset, amount) in mint_assets.0.iter() {
mint.set_asset(&mint_witness, asset, amount);
}
} else {
let mut mint = MintBuilder::new();
for (asset, amount) in mint_assets.0.iter() {
mint.set_asset(&mint_witness, asset, amount);
}
self.mint = Some(mint);
}
}
/// !!! DEPRECATED !!!
/// Mints are defining by MintBuilder now.
/// Use `.set_mint_builder()` and `MintBuilder` instead.
#[deprecated(
since = "11.2.0",
note = "Mints are defining by MintBuilder now. Use `.set_mint_builder()` and `MintBuilder` instead."
)]
/// Add a mint entry to this builder using a PolicyID, AssetName, and Int object for amount
/// It will be securely added to existing or new Mint in this builder
/// It will replace any previous existing amount same PolicyID and AssetName
pub fn add_mint_asset(
&mut self,
policy_script: &NativeScript,
asset_name: &AssetName,
amount: Int,
) {
let mint_witness = MintWitness::new_native_script(policy_script);
if let Some(mint) = &mut self.mint {
mint.add_asset(&mint_witness, asset_name, &amount);
} else {
let mut mint = MintBuilder::new();
mint.add_asset(&mint_witness, asset_name, &amount);
self.mint = Some(mint);
}
}
/// Add a mint entry together with an output to this builder
/// Using a PolicyID, AssetName, Int for amount, Address, and Coin (BigNum) objects
/// The asset will be securely added to existing or new Mint in this builder
/// A new output will be added with the specified Address, the Coin value, and the minted asset
pub fn add_mint_asset_and_output(
&mut self,
policy_script: &NativeScript,
asset_name: &AssetName,
amount: Int,
output_builder: &TransactionOutputAmountBuilder,
output_coin: &Coin,
) -> Result<(), JsError> {
if !amount.is_positive() {
return Err(JsError::from_str("Output value must be positive!"));
}
let policy_id: PolicyID = policy_script.hash();
self.add_mint_asset(policy_script, asset_name, amount.clone());
let multiasset = Mint::new_from_entry(
&policy_id,
&MintAssets::new_from_entry(asset_name, amount.clone()),
)
.as_positive_multiasset();
self.add_output(
&output_builder
.with_coin_and_asset(&output_coin, &multiasset)
.build()?,
)
}
/// Add a mint entry together with an output to this builder
/// Using a PolicyID, AssetName, Int for amount, and Address objects
/// The asset will be securely added to existing or new Mint in this builder
/// A new output will be added with the specified Address and the minted asset
/// The output will be set to contain the minimum required amount of Coin
pub fn add_mint_asset_and_output_min_required_coin(
&mut self,
policy_script: &NativeScript,
asset_name: &AssetName,
amount: Int,
output_builder: &TransactionOutputAmountBuilder,
) -> Result<(), JsError> {
if !amount.is_positive() {
return Err(JsError::from_str("Output value must be positive!"));
}
let policy_id: PolicyID = policy_script.hash();
self.add_mint_asset(policy_script, asset_name, amount.clone());
let multiasset = Mint::new_from_entry(
&policy_id,
&MintAssets::new_from_entry(asset_name, amount.clone()),
)
.as_positive_multiasset();
self.add_output(
&output_builder
.with_asset_and_min_required_coin_by_utxo_cost(
&multiasset,
&self.config.utxo_cost(),
)?
.build()?,
)
}
src/tx_builder/mint_builder.rs (line 69)
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
fn update_mint_value(&mut self, mint: &MintWitness, asset_name: &AssetName, amount: &Int, overwrite: bool) {
match &mint.0 {
MintWitnessEnum::NativeScript(native_script) => {
let script_mint = self.mints.entry(native_script.hash()).or_insert(ScriptMint::Native(NativeMints {
script: native_script.clone(),
mints: BTreeMap::new(),
}));
match script_mint {
ScriptMint::Native(native_mints) => {
let mint = native_mints.mints.entry(asset_name.clone()).or_insert(Int::new(&BigNum::zero()));
if overwrite {
mint.0 = amount.0;
} else {
mint.0 += amount.0;
}
},
_ => {},
}
},
MintWitnessEnum::Plutus(plutus_script, redeemer) => {
let script_mint = self.mints.entry(plutus_script.script_hash()).or_insert(ScriptMint::Plutus(PlutusMints {
script: plutus_script.clone(),
redeemer_mints: BTreeMap::new(),
}));
match script_mint {
ScriptMint::Plutus(plutus_mints) => {
let redeemer_mints = plutus_mints.redeemer_mints.entry(redeemer.clone()).or_insert(BTreeMap::new());
let mint = redeemer_mints.entry(asset_name.clone()).or_insert(Int::new(&BigNum::zero()));
if overwrite {
mint.0 = amount.0;
} else {
mint.0 += amount.0;
}
},
_ => {},
}
},
}
}
pub fn build(&self) -> Mint {
let mut mint = Mint::new();
for (_, script_mint) in self.mints.iter() {
match script_mint {
ScriptMint::Native(native_mints) => {
let mut mint_asset = MintAssets::new();
for (asset_name, amount) in &native_mints.mints {
mint_asset.insert(asset_name, amount.clone());
}
mint.insert(&native_mints.script.hash(), &mint_asset);
},
ScriptMint::Plutus(plutus_mints) => {
for (_, redeemer_mints) in &plutus_mints.redeemer_mints {
let mut mint_asset = MintAssets::new();
for (asset_name, amount) in redeemer_mints {
mint_asset.insert(asset_name, amount.clone());
}
mint.insert(&plutus_mints.script.script_hash(), &mint_asset);
}
}
}
}
mint
}
sourcepub fn new_script_pubkey(script_pubkey: &ScriptPubkey) -> Self
pub fn new_script_pubkey(script_pubkey: &ScriptPubkey) -> Self
Examples found in repository?
src/utils.rs (lines 1531-1533)
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
fn encode_template_to_native_script(
template: &serde_json::Value,
cosigners: &HashMap<String, String>,
) -> Result<NativeScript, JsError> {
match template {
serde_json::Value::String(cosigner) => {
if let Some(xpub) = cosigners.get(cosigner) {
let bytes = Vec::from_hex(xpub).map_err(|e| JsError::from_str(&e.to_string()))?;
let public_key = Bip32PublicKey::from_bytes(&bytes)?;
Ok(NativeScript::new_script_pubkey(&ScriptPubkey::new(
&public_key.to_raw_key().hash(),
)))
} else {
Err(JsError::from_str(&format!(
"cosigner {} not found",
cosigner
)))
}
}
serde_json::Value::Object(map) if map.contains_key("all") => {
let mut all = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("all").unwrap() {
for val in array {
all.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("all must be an array"));
}
Ok(NativeScript::new_script_all(&ScriptAll::new(&all)))
}
serde_json::Value::Object(map) if map.contains_key("any") => {
let mut any = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("any").unwrap() {
for val in array {
any.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("any must be an array"));
}
Ok(NativeScript::new_script_any(&ScriptAny::new(&any)))
}
serde_json::Value::Object(map) if map.contains_key("some") => {
if let serde_json::Value::Object(some) = map.get("some").unwrap() {
if some.contains_key("at_least") && some.contains_key("from") {
let n = if let serde_json::Value::Number(at_least) =
some.get("at_least").unwrap()
{
if let Some(n) = at_least.as_u64() {
n as u32
} else {
return Err(JsError::from_str("at_least must be an integer"));
}
} else {
return Err(JsError::from_str("at_least must be an integer"));
};
let mut from_scripts = NativeScripts::new();
if let serde_json::Value::Array(array) = some.get("from").unwrap() {
for val in array {
from_scripts.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("from must be an array"));
}
Ok(NativeScript::new_script_n_of_k(&ScriptNOfK::new(
n,
&from_scripts,
)))
} else {
Err(JsError::from_str("some must contain at_least and from"))
}
} else {
Err(JsError::from_str("some must be an object"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_from") => {
if let serde_json::Value::Number(active_from) = map.get("active_from").unwrap() {
if let Some(n) = active_from.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_start = TimelockStart::new_timelockstart(&slot);
Ok(NativeScript::new_timelock_start(&time_lock_start))
} else {
Err(JsError::from_str(
"active_from slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_from slot must be a number"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_until") => {
if let serde_json::Value::Number(active_until) = map.get("active_until").unwrap() {
if let Some(n) = active_until.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_expiry = TimelockExpiry::new_timelockexpiry(&slot);
Ok(NativeScript::new_timelock_expiry(&time_lock_expiry))
} else {
Err(JsError::from_str(
"active_until slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_until slot must be a number"))
}
}
_ => Err(JsError::from_str("invalid template format")),
}
}
sourcepub fn new_script_all(script_all: &ScriptAll) -> Self
pub fn new_script_all(script_all: &ScriptAll) -> Self
Examples found in repository?
src/utils.rs (line 1552)
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
fn encode_template_to_native_script(
template: &serde_json::Value,
cosigners: &HashMap<String, String>,
) -> Result<NativeScript, JsError> {
match template {
serde_json::Value::String(cosigner) => {
if let Some(xpub) = cosigners.get(cosigner) {
let bytes = Vec::from_hex(xpub).map_err(|e| JsError::from_str(&e.to_string()))?;
let public_key = Bip32PublicKey::from_bytes(&bytes)?;
Ok(NativeScript::new_script_pubkey(&ScriptPubkey::new(
&public_key.to_raw_key().hash(),
)))
} else {
Err(JsError::from_str(&format!(
"cosigner {} not found",
cosigner
)))
}
}
serde_json::Value::Object(map) if map.contains_key("all") => {
let mut all = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("all").unwrap() {
for val in array {
all.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("all must be an array"));
}
Ok(NativeScript::new_script_all(&ScriptAll::new(&all)))
}
serde_json::Value::Object(map) if map.contains_key("any") => {
let mut any = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("any").unwrap() {
for val in array {
any.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("any must be an array"));
}
Ok(NativeScript::new_script_any(&ScriptAny::new(&any)))
}
serde_json::Value::Object(map) if map.contains_key("some") => {
if let serde_json::Value::Object(some) = map.get("some").unwrap() {
if some.contains_key("at_least") && some.contains_key("from") {
let n = if let serde_json::Value::Number(at_least) =
some.get("at_least").unwrap()
{
if let Some(n) = at_least.as_u64() {
n as u32
} else {
return Err(JsError::from_str("at_least must be an integer"));
}
} else {
return Err(JsError::from_str("at_least must be an integer"));
};
let mut from_scripts = NativeScripts::new();
if let serde_json::Value::Array(array) = some.get("from").unwrap() {
for val in array {
from_scripts.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("from must be an array"));
}
Ok(NativeScript::new_script_n_of_k(&ScriptNOfK::new(
n,
&from_scripts,
)))
} else {
Err(JsError::from_str("some must contain at_least and from"))
}
} else {
Err(JsError::from_str("some must be an object"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_from") => {
if let serde_json::Value::Number(active_from) = map.get("active_from").unwrap() {
if let Some(n) = active_from.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_start = TimelockStart::new_timelockstart(&slot);
Ok(NativeScript::new_timelock_start(&time_lock_start))
} else {
Err(JsError::from_str(
"active_from slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_from slot must be a number"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_until") => {
if let serde_json::Value::Number(active_until) = map.get("active_until").unwrap() {
if let Some(n) = active_until.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_expiry = TimelockExpiry::new_timelockexpiry(&slot);
Ok(NativeScript::new_timelock_expiry(&time_lock_expiry))
} else {
Err(JsError::from_str(
"active_until slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_until slot must be a number"))
}
}
_ => Err(JsError::from_str("invalid template format")),
}
}
sourcepub fn new_script_any(script_any: &ScriptAny) -> Self
pub fn new_script_any(script_any: &ScriptAny) -> Self
Examples found in repository?
src/utils.rs (line 1565)
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
fn encode_template_to_native_script(
template: &serde_json::Value,
cosigners: &HashMap<String, String>,
) -> Result<NativeScript, JsError> {
match template {
serde_json::Value::String(cosigner) => {
if let Some(xpub) = cosigners.get(cosigner) {
let bytes = Vec::from_hex(xpub).map_err(|e| JsError::from_str(&e.to_string()))?;
let public_key = Bip32PublicKey::from_bytes(&bytes)?;
Ok(NativeScript::new_script_pubkey(&ScriptPubkey::new(
&public_key.to_raw_key().hash(),
)))
} else {
Err(JsError::from_str(&format!(
"cosigner {} not found",
cosigner
)))
}
}
serde_json::Value::Object(map) if map.contains_key("all") => {
let mut all = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("all").unwrap() {
for val in array {
all.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("all must be an array"));
}
Ok(NativeScript::new_script_all(&ScriptAll::new(&all)))
}
serde_json::Value::Object(map) if map.contains_key("any") => {
let mut any = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("any").unwrap() {
for val in array {
any.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("any must be an array"));
}
Ok(NativeScript::new_script_any(&ScriptAny::new(&any)))
}
serde_json::Value::Object(map) if map.contains_key("some") => {
if let serde_json::Value::Object(some) = map.get("some").unwrap() {
if some.contains_key("at_least") && some.contains_key("from") {
let n = if let serde_json::Value::Number(at_least) =
some.get("at_least").unwrap()
{
if let Some(n) = at_least.as_u64() {
n as u32
} else {
return Err(JsError::from_str("at_least must be an integer"));
}
} else {
return Err(JsError::from_str("at_least must be an integer"));
};
let mut from_scripts = NativeScripts::new();
if let serde_json::Value::Array(array) = some.get("from").unwrap() {
for val in array {
from_scripts.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("from must be an array"));
}
Ok(NativeScript::new_script_n_of_k(&ScriptNOfK::new(
n,
&from_scripts,
)))
} else {
Err(JsError::from_str("some must contain at_least and from"))
}
} else {
Err(JsError::from_str("some must be an object"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_from") => {
if let serde_json::Value::Number(active_from) = map.get("active_from").unwrap() {
if let Some(n) = active_from.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_start = TimelockStart::new_timelockstart(&slot);
Ok(NativeScript::new_timelock_start(&time_lock_start))
} else {
Err(JsError::from_str(
"active_from slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_from slot must be a number"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_until") => {
if let serde_json::Value::Number(active_until) = map.get("active_until").unwrap() {
if let Some(n) = active_until.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_expiry = TimelockExpiry::new_timelockexpiry(&slot);
Ok(NativeScript::new_timelock_expiry(&time_lock_expiry))
} else {
Err(JsError::from_str(
"active_until slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_until slot must be a number"))
}
}
_ => Err(JsError::from_str("invalid template format")),
}
}
sourcepub fn new_script_n_of_k(script_n_of_k: &ScriptNOfK) -> Self
pub fn new_script_n_of_k(script_n_of_k: &ScriptNOfK) -> Self
Examples found in repository?
src/utils.rs (lines 1592-1595)
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
fn encode_template_to_native_script(
template: &serde_json::Value,
cosigners: &HashMap<String, String>,
) -> Result<NativeScript, JsError> {
match template {
serde_json::Value::String(cosigner) => {
if let Some(xpub) = cosigners.get(cosigner) {
let bytes = Vec::from_hex(xpub).map_err(|e| JsError::from_str(&e.to_string()))?;
let public_key = Bip32PublicKey::from_bytes(&bytes)?;
Ok(NativeScript::new_script_pubkey(&ScriptPubkey::new(
&public_key.to_raw_key().hash(),
)))
} else {
Err(JsError::from_str(&format!(
"cosigner {} not found",
cosigner
)))
}
}
serde_json::Value::Object(map) if map.contains_key("all") => {
let mut all = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("all").unwrap() {
for val in array {
all.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("all must be an array"));
}
Ok(NativeScript::new_script_all(&ScriptAll::new(&all)))
}
serde_json::Value::Object(map) if map.contains_key("any") => {
let mut any = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("any").unwrap() {
for val in array {
any.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("any must be an array"));
}
Ok(NativeScript::new_script_any(&ScriptAny::new(&any)))
}
serde_json::Value::Object(map) if map.contains_key("some") => {
if let serde_json::Value::Object(some) = map.get("some").unwrap() {
if some.contains_key("at_least") && some.contains_key("from") {
let n = if let serde_json::Value::Number(at_least) =
some.get("at_least").unwrap()
{
if let Some(n) = at_least.as_u64() {
n as u32
} else {
return Err(JsError::from_str("at_least must be an integer"));
}
} else {
return Err(JsError::from_str("at_least must be an integer"));
};
let mut from_scripts = NativeScripts::new();
if let serde_json::Value::Array(array) = some.get("from").unwrap() {
for val in array {
from_scripts.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("from must be an array"));
}
Ok(NativeScript::new_script_n_of_k(&ScriptNOfK::new(
n,
&from_scripts,
)))
} else {
Err(JsError::from_str("some must contain at_least and from"))
}
} else {
Err(JsError::from_str("some must be an object"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_from") => {
if let serde_json::Value::Number(active_from) = map.get("active_from").unwrap() {
if let Some(n) = active_from.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_start = TimelockStart::new_timelockstart(&slot);
Ok(NativeScript::new_timelock_start(&time_lock_start))
} else {
Err(JsError::from_str(
"active_from slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_from slot must be a number"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_until") => {
if let serde_json::Value::Number(active_until) = map.get("active_until").unwrap() {
if let Some(n) = active_until.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_expiry = TimelockExpiry::new_timelockexpiry(&slot);
Ok(NativeScript::new_timelock_expiry(&time_lock_expiry))
} else {
Err(JsError::from_str(
"active_until slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_until slot must be a number"))
}
}
_ => Err(JsError::from_str("invalid template format")),
}
}
sourcepub fn new_timelock_start(timelock_start: &TimelockStart) -> Self
pub fn new_timelock_start(timelock_start: &TimelockStart) -> Self
Examples found in repository?
src/utils.rs (line 1610)
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
fn encode_template_to_native_script(
template: &serde_json::Value,
cosigners: &HashMap<String, String>,
) -> Result<NativeScript, JsError> {
match template {
serde_json::Value::String(cosigner) => {
if let Some(xpub) = cosigners.get(cosigner) {
let bytes = Vec::from_hex(xpub).map_err(|e| JsError::from_str(&e.to_string()))?;
let public_key = Bip32PublicKey::from_bytes(&bytes)?;
Ok(NativeScript::new_script_pubkey(&ScriptPubkey::new(
&public_key.to_raw_key().hash(),
)))
} else {
Err(JsError::from_str(&format!(
"cosigner {} not found",
cosigner
)))
}
}
serde_json::Value::Object(map) if map.contains_key("all") => {
let mut all = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("all").unwrap() {
for val in array {
all.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("all must be an array"));
}
Ok(NativeScript::new_script_all(&ScriptAll::new(&all)))
}
serde_json::Value::Object(map) if map.contains_key("any") => {
let mut any = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("any").unwrap() {
for val in array {
any.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("any must be an array"));
}
Ok(NativeScript::new_script_any(&ScriptAny::new(&any)))
}
serde_json::Value::Object(map) if map.contains_key("some") => {
if let serde_json::Value::Object(some) = map.get("some").unwrap() {
if some.contains_key("at_least") && some.contains_key("from") {
let n = if let serde_json::Value::Number(at_least) =
some.get("at_least").unwrap()
{
if let Some(n) = at_least.as_u64() {
n as u32
} else {
return Err(JsError::from_str("at_least must be an integer"));
}
} else {
return Err(JsError::from_str("at_least must be an integer"));
};
let mut from_scripts = NativeScripts::new();
if let serde_json::Value::Array(array) = some.get("from").unwrap() {
for val in array {
from_scripts.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("from must be an array"));
}
Ok(NativeScript::new_script_n_of_k(&ScriptNOfK::new(
n,
&from_scripts,
)))
} else {
Err(JsError::from_str("some must contain at_least and from"))
}
} else {
Err(JsError::from_str("some must be an object"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_from") => {
if let serde_json::Value::Number(active_from) = map.get("active_from").unwrap() {
if let Some(n) = active_from.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_start = TimelockStart::new_timelockstart(&slot);
Ok(NativeScript::new_timelock_start(&time_lock_start))
} else {
Err(JsError::from_str(
"active_from slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_from slot must be a number"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_until") => {
if let serde_json::Value::Number(active_until) = map.get("active_until").unwrap() {
if let Some(n) = active_until.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_expiry = TimelockExpiry::new_timelockexpiry(&slot);
Ok(NativeScript::new_timelock_expiry(&time_lock_expiry))
} else {
Err(JsError::from_str(
"active_until slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_until slot must be a number"))
}
}
_ => Err(JsError::from_str("invalid template format")),
}
}
sourcepub fn new_timelock_expiry(timelock_expiry: &TimelockExpiry) -> Self
pub fn new_timelock_expiry(timelock_expiry: &TimelockExpiry) -> Self
Examples found in repository?
src/utils.rs (line 1627)
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
fn encode_template_to_native_script(
template: &serde_json::Value,
cosigners: &HashMap<String, String>,
) -> Result<NativeScript, JsError> {
match template {
serde_json::Value::String(cosigner) => {
if let Some(xpub) = cosigners.get(cosigner) {
let bytes = Vec::from_hex(xpub).map_err(|e| JsError::from_str(&e.to_string()))?;
let public_key = Bip32PublicKey::from_bytes(&bytes)?;
Ok(NativeScript::new_script_pubkey(&ScriptPubkey::new(
&public_key.to_raw_key().hash(),
)))
} else {
Err(JsError::from_str(&format!(
"cosigner {} not found",
cosigner
)))
}
}
serde_json::Value::Object(map) if map.contains_key("all") => {
let mut all = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("all").unwrap() {
for val in array {
all.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("all must be an array"));
}
Ok(NativeScript::new_script_all(&ScriptAll::new(&all)))
}
serde_json::Value::Object(map) if map.contains_key("any") => {
let mut any = NativeScripts::new();
if let serde_json::Value::Array(array) = map.get("any").unwrap() {
for val in array {
any.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("any must be an array"));
}
Ok(NativeScript::new_script_any(&ScriptAny::new(&any)))
}
serde_json::Value::Object(map) if map.contains_key("some") => {
if let serde_json::Value::Object(some) = map.get("some").unwrap() {
if some.contains_key("at_least") && some.contains_key("from") {
let n = if let serde_json::Value::Number(at_least) =
some.get("at_least").unwrap()
{
if let Some(n) = at_least.as_u64() {
n as u32
} else {
return Err(JsError::from_str("at_least must be an integer"));
}
} else {
return Err(JsError::from_str("at_least must be an integer"));
};
let mut from_scripts = NativeScripts::new();
if let serde_json::Value::Array(array) = some.get("from").unwrap() {
for val in array {
from_scripts.add(&encode_template_to_native_script(val, cosigners)?);
}
} else {
return Err(JsError::from_str("from must be an array"));
}
Ok(NativeScript::new_script_n_of_k(&ScriptNOfK::new(
n,
&from_scripts,
)))
} else {
Err(JsError::from_str("some must contain at_least and from"))
}
} else {
Err(JsError::from_str("some must be an object"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_from") => {
if let serde_json::Value::Number(active_from) = map.get("active_from").unwrap() {
if let Some(n) = active_from.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_start = TimelockStart::new_timelockstart(&slot);
Ok(NativeScript::new_timelock_start(&time_lock_start))
} else {
Err(JsError::from_str(
"active_from slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_from slot must be a number"))
}
}
serde_json::Value::Object(map) if map.contains_key("active_until") => {
if let serde_json::Value::Number(active_until) = map.get("active_until").unwrap() {
if let Some(n) = active_until.as_u64() {
let slot: SlotBigNum = n.into();
let time_lock_expiry = TimelockExpiry::new_timelockexpiry(&slot);
Ok(NativeScript::new_timelock_expiry(&time_lock_expiry))
} else {
Err(JsError::from_str(
"active_until slot must be an integer greater than or equal to 0",
))
}
} else {
Err(JsError::from_str("active_until slot must be a number"))
}
}
_ => Err(JsError::from_str("invalid template format")),
}
}
pub fn kind(&self) -> NativeScriptKind
pub fn as_script_pubkey(&self) -> Option<ScriptPubkey>
pub fn as_script_all(&self) -> Option<ScriptAll>
pub fn as_script_any(&self) -> Option<ScriptAny>
pub fn as_script_n_of_k(&self) -> Option<ScriptNOfK>
pub fn as_timelock_start(&self) -> Option<TimelockStart>
pub fn as_timelock_expiry(&self) -> Option<TimelockExpiry>
sourcepub fn get_required_signers(&self) -> Ed25519KeyHashes
pub fn get_required_signers(&self) -> Ed25519KeyHashes
Returns an array of unique Ed25519KeyHashes contained within this script recursively on any depth level. The order of the keys in the result is not determined in any way.
Trait Implementations§
source§impl Clone for NativeScript
impl Clone for NativeScript
source§fn clone(&self) -> NativeScript
fn clone(&self) -> NativeScript
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 NativeScript
impl Debug for NativeScript
source§impl<'de> Deserialize<'de> for NativeScript
impl<'de> Deserialize<'de> for NativeScript
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Deserialize for NativeScript
impl Deserialize for NativeScript
fn deserialize<R: BufRead + Seek>(
raw: &mut Deserializer<R>
) -> Result<Self, DeserializeError>
source§impl From<&NativeScript> for RequiredSignersSet
impl From<&NativeScript> for RequiredSignersSet
source§fn from(script: &NativeScript) -> Self
fn from(script: &NativeScript) -> Self
Converts to this type from the input type.
source§impl JsonSchema for NativeScript
impl JsonSchema for NativeScript
source§fn schema_name() -> String
fn schema_name() -> String
The name of the generated JSON Schema. Read more
source§fn json_schema(gen: &mut SchemaGenerator) -> Schema
fn json_schema(gen: &mut SchemaGenerator) -> Schema
Generates a JSON Schema for this type. Read more
source§fn is_referenceable() -> bool
fn is_referenceable() -> bool
Whether JSON Schemas generated for this type should be re-used where possible using the
$ref
keyword. Read moresource§impl Ord for NativeScript
impl Ord for NativeScript
source§fn cmp(&self, other: &NativeScript) -> Ordering
fn cmp(&self, other: &NativeScript) -> 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<NativeScript> for NativeScript
impl PartialEq<NativeScript> for NativeScript
source§fn eq(&self, other: &NativeScript) -> bool
fn eq(&self, other: &NativeScript) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<NativeScript> for NativeScript
impl PartialOrd<NativeScript> for NativeScript
source§fn partial_cmp(&self, other: &NativeScript) -> Option<Ordering>
fn partial_cmp(&self, other: &NativeScript) -> 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