1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 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 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 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 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
// Copyright 2019 The Grin Developers // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Owner API External Definition use chrono::prelude::*; use uuid::Uuid; use crate::config::WalletConfig; use crate::core::core::Transaction; use crate::core::global; use crate::impls::create_sender; use crate::keychain::{Identifier, Keychain}; use crate::libwallet::api_impl::owner; use crate::libwallet::{ AcctPathMapping, Error, ErrorKind, InitTxArgs, IssueInvoiceTxArgs, NodeClient, NodeHeightResult, OutputCommitMapping, Slate, TxLogEntry, WalletInfo, WalletInst, WalletLCProvider, }; use crate::util::secp::key::SecretKey; use crate::util::{from_hex, static_secp_instance, LoggingConfig, Mutex, ZeroingString}; use std::sync::Arc; /// Main interface into all wallet API functions. /// Wallet APIs are split into two seperate blocks of functionality /// called the ['Owner'](struct.Owner.html) and ['Foreign'](struct.Foreign.html) APIs /// /// * The 'Owner' API is intended to expose methods that are to be /// used by the wallet owner only. It is vital that this API is not /// exposed to anyone other than the owner of the wallet (i.e. the /// person with access to the seed and password. /// /// Methods in both APIs are intended to be 'single use', that is to say each /// method will 'open' the wallet (load the keychain with its master seed), perform /// its operation, then 'close' the wallet (unloading references to the keychain and master /// seed). pub struct Owner<'a, L, C, K> where L: WalletLCProvider<'a, C, K>, C: NodeClient + 'a, K: Keychain + 'a, { /// contain all methods to manage the wallet pub wallet_inst: Arc<Mutex<Box<dyn WalletInst<'a, L, C, K>>>>, /// Flag to normalize some output during testing. Can mostly be ignored. pub doctest_mode: bool, /// Share ECDH key pub shared_key: Arc<Mutex<Option<SecretKey>>>, } impl<'a, L, C, K> Owner<'a, L, C, K> where L: WalletLCProvider<'a, C, K>, C: NodeClient, K: Keychain, { /// Create a new API instance with the given wallet instance. All subsequent /// API calls will operate on this instance of the wallet. /// /// Each method will call the [`WalletBackend`](../grin_wallet_libwallet/types/trait.WalletBackend.html)'s /// [`open_with_credentials`](../grin_wallet_libwallet/types/trait.WalletBackend.html#tymethod.open_with_credentials) /// (initialising a keychain with the master seed,) perform its operation, then close the keychain /// with a call to [`close`](../grin_wallet_libwallet/types/trait.WalletBackend.html#tymethod.close) /// /// # Arguments /// * `wallet_in` - A reference-counted mutex containing an implementation of the /// [`WalletBackend`](../grin_wallet_libwallet/types/trait.WalletBackend.html) trait. /// /// # Returns /// * An instance of the OwnerApi holding a reference to the provided wallet /// /// # Example /// ``` /// use grin_wallet_util::grin_keychain as keychain; /// use grin_wallet_util::grin_util as util; /// use grin_wallet_api as api; /// use grin_wallet_config as config; /// use grin_wallet_impls as impls; /// use grin_wallet_libwallet as libwallet; /// /// use keychain::ExtKeychain; /// use tempfile::tempdir; /// /// use std::sync::Arc; /// use util::{Mutex, ZeroingString}; /// /// use api::Owner; /// use config::WalletConfig; /// use impls::{DefaultWalletImpl, DefaultLCProvider, HTTPNodeClient}; /// use libwallet::WalletInst; /// /// let mut wallet_config = WalletConfig::default(); /// # let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap(); /// # let dir = dir /// # .path() /// # .to_str() /// # .ok_or("Failed to convert tmpdir path to string.".to_owned()) /// # .unwrap(); /// # wallet_config.data_file_dir = dir.to_owned(); /// /// // A NodeClient must first be created to handle communication between /// // the wallet and the node. /// let node_client = HTTPNodeClient::new(&wallet_config.check_node_api_http_addr, None); /// /// // impls::DefaultWalletImpl is provided for convenience in instantiating the wallet /// // It contains the LMDBBackend, DefaultLCProvider (lifecycle) and ExtKeychain used /// // by the reference wallet implementation. /// // These traits can be replaced with alternative implementations if desired /// /// let mut wallet = Box::new(DefaultWalletImpl::<'static, HTTPNodeClient>::new(node_client.clone()).unwrap()) /// as Box<WalletInst<'static, DefaultLCProvider<HTTPNodeClient, ExtKeychain>, HTTPNodeClient, ExtKeychain>>; /// /// // Wallet LifeCycle Provider provides all functions init wallet and work with seeds, etc... /// let lc = wallet.lc_provider().unwrap(); /// /// // The top level wallet directory should be set manually (in the reference implementation, /// // this is provided in the WalletConfig) /// let _ = lc.set_top_level_directory(&wallet_config.data_file_dir); /// /// // Wallet must be opened with the password (TBD) /// let pw = ZeroingString::from("wallet_password"); /// lc.open_wallet(None, pw, false, false); /// /// // All wallet functions operate on an Arc::Mutex to allow multithreading where needed /// let mut wallet = Arc::new(Mutex::new(wallet)); /// /// let api_owner = Owner::new(wallet.clone()); /// // .. perform wallet operations /// /// ``` pub fn new(wallet_inst: Arc<Mutex<Box<dyn WalletInst<'a, L, C, K>>>>) -> Self { Owner { wallet_inst, doctest_mode: false, shared_key: Arc::new(Mutex::new(None)), } } /// Returns a list of accounts stored in the wallet (i.e. mappings between /// user-specified labels and BIP32 derivation paths. /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// /// # Returns /// * Result Containing: /// * A Vector of [`AcctPathMapping`](../grin_wallet_libwallet/types/struct.AcctPathMapping.html) data /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Remarks /// /// * A wallet should always have the path with the label 'default' path defined, /// with path m/0/0 /// * This method does not need to use the wallet seed or keychain. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// /// let result = api_owner.accounts(None); /// /// if let Ok(accts) = result { /// //... /// } /// ``` pub fn accounts( &self, keychain_mask: Option<&SecretKey>, ) -> Result<Vec<AcctPathMapping>, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; // Test keychain mask, to keep API consistent let _ = w.keychain(keychain_mask)?; owner::accounts(&mut **w) } /// Creates a new 'account', which is a mapping of a user-specified /// label to a BIP32 path /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `label` - A human readable label to which to map the new BIP32 Path /// /// # Returns /// * Result Containing: /// * A [Keychain Identifier](../grin_keychain/struct.Identifier.html) for the new path /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Remarks /// /// * Wallets should be initialised with the 'default' path mapped to `m/0/0` /// * Each call to this function will increment the first element of the path /// so the first call will create an account at `m/1/0` and the second at /// `m/2/0` etc. . . /// * The account path is used throughout as the parent key for most key-derivation /// operations. See [`set_active_account`](struct.Owner.html#method.set_active_account) for /// further details. /// /// * This function does not need to use the root wallet seed or keychain. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// /// let result = api_owner.create_account_path(None, "account1"); /// /// if let Ok(identifier) = result { /// //... /// } /// ``` pub fn create_account_path( &self, keychain_mask: Option<&SecretKey>, label: &str, ) -> Result<Identifier, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::create_account_path(&mut **w, keychain_mask, label) } /// Sets the wallet's currently active account. This sets the /// BIP32 parent path used for most key-derivation operations. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `label` - The human readable label for the account. Accounts can be retrieved via /// the [`account`](struct.Owner.html#method.accounts) method /// /// # Returns /// * Result Containing: /// * `Ok(())` if the path was correctly set /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Remarks /// /// * Wallet parent paths are 2 path elements long, e.g. `m/0/0` is the path /// labelled 'default'. Keys derived from this parent path are 3 elements long, /// e.g. the secret keys derived from the `m/0/0` path will be at paths `m/0/0/0`, /// `m/0/0/1` etc... /// /// * This function does not need to use the root wallet seed or keychain. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// /// let result = api_owner.create_account_path(None, "account1"); /// /// if let Ok(identifier) = result { /// // set the account active /// let result2 = api_owner.set_active_account(None, "account1"); /// } /// ``` pub fn set_active_account( &self, keychain_mask: Option<&SecretKey>, label: &str, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; // Test keychain mask, to keep API consistent let _ = w.keychain(keychain_mask)?; owner::set_active_account(&mut **w, label) } /// Returns a list of outputs from the active account in the wallet. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `include_spent` - If `true`, outputs that have been marked as 'spent' /// in the wallet will be returned. If `false`, spent outputs will omitted /// from the results. /// * `refresh_from_node` - If true, the wallet will attempt to contact /// a node (via the [`NodeClient`](../grin_wallet_libwallet/types/trait.NodeClient.html) /// provided during wallet instantiation). If `false`, the results will /// contain output information that may be out-of-date (from the last time /// the wallet's output set was refreshed against the node). /// * `tx_id` - If `Some(i)`, only return the outputs associated with /// the transaction log entry of id `i`. /// /// # Returns /// * `(bool, Vec<OutputCommitMapping>)` - A tuple: /// * The first `bool` element indicates whether the data was successfully /// refreshed from the node (note this may be false even if the `refresh_from_node` /// argument was set to `true`. /// * The second element contains a vector of /// [OutputCommitMapping](../grin_wallet_libwallet/types/struct.OutputCommitMapping.html) /// of which each element is a mapping between the wallet's internal /// [OutputData](../grin_wallet_libwallet/types/struct.Output.html) /// and the Output commitment as identified in the chain's UTXO set /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// let show_spent = false; /// let update_from_node = true; /// let tx_id = None; /// /// let result = api_owner.retrieve_outputs(None, show_spent, update_from_node, tx_id); /// /// if let Ok((was_updated, output_mappings)) = result { /// //... /// } /// ``` pub fn retrieve_outputs( &self, keychain_mask: Option<&SecretKey>, include_spent: bool, refresh_from_node: bool, tx_id: Option<u32>, ) -> Result<(bool, Vec<OutputCommitMapping>), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::retrieve_outputs( &mut **w, keychain_mask, include_spent, refresh_from_node, tx_id, ) } /// Returns a list of [Transaction Log Entries](../grin_wallet_libwallet/types/struct.TxLogEntry.html) /// from the active account in the wallet. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `refresh_from_node` - If true, the wallet will attempt to contact /// a node (via the [`NodeClient`](../grin_wallet_libwallet/types/trait.NodeClient.html) /// provided during wallet instantiation). If `false`, the results will /// contain transaction information that may be out-of-date (from the last time /// the wallet's output set was refreshed against the node). /// * `tx_id` - If `Some(i)`, only return the transactions associated with /// the transaction log entry of id `i`. /// * `tx_slate_id` - If `Some(uuid)`, only return transactions associated with /// the given [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html) uuid. /// /// # Returns /// * `(bool, Vec<TxLogEntry)` - A tuple: /// * The first `bool` element indicates whether the data was successfully /// refreshed from the node (note this may be false even if the `refresh_from_node` /// argument was set to `true`. /// * The second element contains the set of retrieved /// [TxLogEntries](../grin_wallet_libwallet/types/struct.TxLogEntry.html) /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// let update_from_node = true; /// let tx_id = None; /// let tx_slate_id = None; /// /// // Return all TxLogEntries /// let result = api_owner.retrieve_txs(None, update_from_node, tx_id, tx_slate_id); /// /// if let Ok((was_updated, tx_log_entries)) = result { /// //... /// } /// ``` pub fn retrieve_txs( &self, keychain_mask: Option<&SecretKey>, refresh_from_node: bool, tx_id: Option<u32>, tx_slate_id: Option<Uuid>, ) -> Result<(bool, Vec<TxLogEntry>), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; let mut res = owner::retrieve_txs( &mut **w, keychain_mask, refresh_from_node, tx_id, tx_slate_id, )?; if self.doctest_mode { res.1 = res .1 .into_iter() .map(|mut t| { t.confirmation_ts = Some(Utc.ymd(2019, 1, 15).and_hms(16, 1, 26)); t.creation_ts = Utc.ymd(2019, 1, 15).and_hms(16, 1, 26); t }) .collect(); } Ok(res) } /// Returns summary information from the active account in the wallet. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `refresh_from_node` - If true, the wallet will attempt to contact /// a node (via the [`NodeClient`](../grin_wallet_libwallet/types/trait.NodeClient.html) /// provided during wallet instantiation). If `false`, the results will /// contain transaction information that may be out-of-date (from the last time /// the wallet's output set was refreshed against the node). /// * `minimum_confirmations` - The minimum number of confirmations an output /// should have before it's included in the 'amount_currently_spendable' total /// /// # Returns /// * (`bool`, [`WalletInfo`](../grin_wallet_libwallet/types/struct.WalletInfo.html)) - A tuple: /// * The first `bool` element indicates whether the data was successfully /// refreshed from the node (note this may be false even if the `refresh_from_node` /// argument was set to `true`. /// * The second element contains the Summary [`WalletInfo`](../grin_wallet_libwallet/types/struct.WalletInfo.html) /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let update_from_node = true; /// let minimum_confirmations=10; /// /// // Return summary info for active account /// let result = api_owner.retrieve_summary_info(None, update_from_node, minimum_confirmations); /// /// if let Ok((was_updated, summary_info)) = result { /// //... /// } /// ``` pub fn retrieve_summary_info( &self, keychain_mask: Option<&SecretKey>, refresh_from_node: bool, minimum_confirmations: u64, ) -> Result<(bool, WalletInfo), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::retrieve_summary_info( &mut **w, keychain_mask, refresh_from_node, minimum_confirmations, ) } /// Initiates a new transaction as the sender, creating a new /// [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html) object containing /// the sender's inputs, change outputs, and public signature data. This slate can /// then be sent to the recipient to continue the transaction via the /// [Foreign API's `receive_tx`](struct.Foreign.html#method.receive_tx) method. /// /// When a transaction is created, the wallet must also lock inputs (and create unconfirmed /// outputs) corresponding to the transaction created in the slate, so that the wallet doesn't /// attempt to re-spend outputs that are already included in a transaction before the transaction /// is confirmed. This method also returns a function that will perform that locking, and it is /// up to the caller to decide the best time to call the lock function /// (via the [`tx_lock_outputs`](struct.Owner.html#method.tx_lock_outputs) method). /// If the exchange method is intended to be synchronous (such as via a direct http call,) /// then the lock call can wait until the response is confirmed. If it is asynchronous, (such /// as via file transfer,) the lock call should happen immediately (before the file is sent /// to the recipient). /// /// If the `send_args` [`InitTxSendArgs`](../grin_wallet_libwallet/types/struct.InitTxSendArgs.html), /// of the [`args`](../grin_wallet_libwallet/types/struct.InitTxArgs.html), field is Some, this /// function will attempt to perform a synchronous send to the recipient specified in the `dest` /// field according to the `method` field, and will also finalize and post the transaction if /// the `finalize` field is set. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `args` - [`InitTxArgs`](../grin_wallet_libwallet/types/struct.InitTxArgs.html), /// transaction initialization arguments. See struct documentation for further detail. /// /// # Returns /// * a result containing: /// * The transaction [Slate](../grin_wallet_libwallet/slate/struct.Slate.html), /// which can be forwarded to the recieving party by any means. Once the caller is relatively /// certain that the transaction has been sent to the recipient, the associated wallet /// transaction outputs should be locked via a call to /// [`tx_lock_outputs`](struct.Owner.html#method.tx_lock_outputs). This must be called before calling /// [`finalize_tx`](struct.Owner.html#method.finalize_tx). /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Remarks /// /// * This method requires an active connection to a node, and will fail with error if a node /// cannot be contacted to refresh output statuses. /// * This method will store a partially completed transaction in the wallet's transaction log, /// which will be updated on the corresponding call to [`finalize_tx`](struct.Owner.html#method.finalize_tx). /// /// # Example /// Set up as in [new](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// // Attempt to create a transaction using the 'default' account /// let args = InitTxArgs { /// src_acct_name: None, /// amount: 2_000_000_000, /// minimum_confirmations: 2, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// message: Some("Have some Grins. Love, Yeastplume".to_owned()), /// ..Default::default() /// }; /// let result = api_owner.init_send_tx( /// None, /// args, /// ); /// /// if let Ok(slate) = result { /// // Send slate somehow /// // ... /// // Lock our outputs if we're happy the slate was (or is being) sent /// api_owner.tx_lock_outputs(None, &slate, 0); /// } /// ``` pub fn init_send_tx( &self, keychain_mask: Option<&SecretKey>, args: InitTxArgs, ) -> Result<Slate, Error> { let send_args = args.send_args.clone(); let mut slate = { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::init_send_tx(&mut **w, keychain_mask, args, self.doctest_mode)? }; // Helper functionality. If send arguments exist, attempt to send match send_args { Some(sa) => { //TODO: in case of keybase, the response might take 60s and leave the service hanging match sa.method.as_ref() { "http" | "keybase" => {} _ => { error!("unsupported payment method: {}", sa.method); return Err(ErrorKind::ClientCallback( "unsupported payment method".to_owned(), ) .into()); } }; let comm_adapter = create_sender(&sa.method, &sa.dest) .map_err(|e| ErrorKind::GenericError(format!("{}", e)))?; slate = comm_adapter.send_tx(&slate)?; self.tx_lock_outputs(keychain_mask, &slate, 0)?; let slate = match sa.finalize { true => self.finalize_tx(keychain_mask, &slate)?, false => slate, }; if sa.post_tx { self.post_tx(keychain_mask, &slate.tx, sa.fluff)?; } Ok(slate) } None => Ok(slate), } } /// Issues a new invoice transaction slate, essentially a `request for payment`. /// The slate created by this function will contain the amount, an output for the amount, /// as well as round 1 of singature creation complete. The slate should then be send /// to the payer, who should add their inputs and signature data and return the slate /// via the [Foreign API's `finalize_invoice_tx`](struct.Foreign.html#method.finalize_invoice_tx) method. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `args` - [`IssueInvoiceTxArgs`](../grin_wallet_libwallet/types/struct.IssueInvoiceTxArgs.html), /// invoice transaction initialization arguments. See struct documentation for further detail. /// /// # Returns /// * ``Ok([`slate`](../grin_wallet_libwallet/slate/struct.Slate.html))` if successful, /// containing the updated slate. /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// /// let args = IssueInvoiceTxArgs { /// amount: 60_000_000_000, /// ..Default::default() /// }; /// let result = api_owner.issue_invoice_tx(None, args); /// /// if let Ok(slate) = result { /// // if okay, send to the payer to add their inputs /// // . . . /// } /// ``` pub fn issue_invoice_tx( &self, keychain_mask: Option<&SecretKey>, args: IssueInvoiceTxArgs, ) -> Result<Slate, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::issue_invoice_tx(&mut **w, keychain_mask, args, self.doctest_mode) } /// Processes an invoice tranaction created by another party, essentially /// a `request for payment`. The incoming slate should contain a requested /// amount, an output created by the invoicer convering the amount, and /// part 1 of signature creation completed. This function will add inputs /// equalling the amount + fees, as well as perform round 1 and 2 of signature /// creation. /// /// Callers should note that no prompting of the user will be done by this function /// it is up to the caller to present the request for payment to the user /// and verify that payment should go ahead. /// /// This function also stores the final transaction in the user's wallet files for retrieval /// via the [`get_stored_tx`](struct.Owner.html#method.get_stored_tx) function. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `slate` - The transaction [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html). The /// payer should have filled in round 1 and 2. /// * `args` - [`InitTxArgs`](../grin_wallet_libwallet/types/struct.InitTxArgs.html), /// transaction initialization arguments. See struct documentation for further detail. /// /// # Returns /// * ``Ok([`slate`](../grin_wallet_libwallet/slate/struct.Slate.html))` if successful, /// containing the updated slate. /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// /// // . . . /// // The slate has been recieved from the invoicer, somehow /// # let slate = Slate::blank(2); /// let args = InitTxArgs { /// src_acct_name: None, /// amount: slate.amount, /// minimum_confirmations: 2, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// ..Default::default() /// }; /// /// let result = api_owner.process_invoice_tx(None, &slate, args); /// /// if let Ok(slate) = result { /// // If result okay, send back to the invoicer /// // . . . /// } /// ``` pub fn process_invoice_tx( &self, keychain_mask: Option<&SecretKey>, slate: &Slate, args: InitTxArgs, ) -> Result<Slate, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::process_invoice_tx(&mut **w, keychain_mask, slate, args, self.doctest_mode) } /// Locks the outputs associated with the inputs to the transaction in the given /// [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html), /// making them unavailable for use in further transactions. This function is called /// by the sender, (or more generally, all parties who have put inputs into the transaction,) /// and must be called before the corresponding call to [`finalize_tx`](struct.Owner.html#method.finalize_tx) /// that completes the transaction. /// /// Outputs will generally remain locked until they are removed from the chain, /// at which point they will become `Spent`. It is commonplace for transactions not to complete /// for various reasons over which a particular wallet has no control. For this reason, /// [`cancel_tx`](struct.Owner.html#method.cancel_tx) can be used to manually unlock outputs /// and return them to the `Unspent` state. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `slate` - The transaction [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html). All /// * `participant_id` - The participant id, generally 0 for the party putting in funds, 1 for the /// party receiving. /// elements in the `input` vector of the `tx` field that are found in the wallet's currently /// active account will be set to status `Locked` /// /// # Returns /// * Ok(()) if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let args = InitTxArgs { /// src_acct_name: None, /// amount: 2_000_000_000, /// minimum_confirmations: 10, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// message: Some("Remember to lock this when we're happy this is sent".to_owned()), /// ..Default::default() /// }; /// let result = api_owner.init_send_tx( /// None, /// args, /// ); /// /// if let Ok(slate) = result { /// // Send slate somehow /// // ... /// // Lock our outputs if we're happy the slate was (or is being) sent /// api_owner.tx_lock_outputs(None, &slate, 0); /// } /// ``` pub fn tx_lock_outputs( &self, keychain_mask: Option<&SecretKey>, slate: &Slate, participant_id: usize, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::tx_lock_outputs(&mut **w, keychain_mask, slate, participant_id) } /// Finalizes a transaction, after all parties /// have filled in both rounds of Slate generation. This step adds /// all participants partial signatures to create the final signature, /// resulting in a final transaction that is ready to post to a node. /// /// Note that this function DOES NOT POST the transaction to a node /// for validation. This is done in separately via the /// [`post_tx`](struct.Owner.html#method.post_tx) function. /// /// This function also stores the final transaction in the user's wallet files for retrieval /// via the [`get_stored_tx`](struct.Owner.html#method.get_stored_tx) function. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `slate` - The transaction [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html). All /// participants must have filled in both rounds, and the sender should have locked their /// outputs (via the [`tx_lock_outputs`](struct.Owner.html#method.tx_lock_outputs) function). /// /// # Returns /// * ``Ok([`slate`](../grin_wallet_libwallet/slate/struct.Slate.html))` if successful, /// containing the new finalized slate. /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let args = InitTxArgs { /// src_acct_name: None, /// amount: 2_000_000_000, /// minimum_confirmations: 10, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// message: Some("Finalize this tx now".to_owned()), /// ..Default::default() /// }; /// let result = api_owner.init_send_tx( /// None, /// args, /// ); /// /// if let Ok(slate) = result { /// // Send slate somehow /// // ... /// // Lock our outputs if we're happy the slate was (or is being) sent /// let res = api_owner.tx_lock_outputs(None, &slate, 0); /// // /// // Retrieve slate back from recipient /// // /// let res = api_owner.finalize_tx(None, &slate); /// } /// ``` pub fn finalize_tx( &self, keychain_mask: Option<&SecretKey>, slate: &Slate, ) -> Result<Slate, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::finalize_tx(&mut **w, keychain_mask, &slate) } /// Posts a completed transaction to the listening node for validation and inclusion in a block /// for mining. /// /// # Arguments /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `tx` - A completed [`Transaction`](../grin_core/core/transaction/struct.Transaction.html), /// typically the `tx` field in the transaction [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html). /// * `fluff` - Instruct the node whether to use the Dandelion protocol when posting the /// transaction. If `true`, the node should skip the Dandelion phase and broadcast the /// transaction to all peers immediately. If `false`, the node will follow dandelion logic and /// initiate the stem phase. /// /// # Returns /// * `Ok(())` if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let args = InitTxArgs { /// src_acct_name: None, /// amount: 2_000_000_000, /// minimum_confirmations: 10, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// message: Some("Post this tx".to_owned()), /// ..Default::default() /// }; /// let result = api_owner.init_send_tx( /// None, /// args, /// ); /// /// if let Ok(slate) = result { /// // Send slate somehow /// // ... /// // Lock our outputs if we're happy the slate was (or is being) sent /// let res = api_owner.tx_lock_outputs(None, &slate, 0); /// // /// // Retrieve slate back from recipient /// // /// let res = api_owner.finalize_tx(None, &slate); /// let res = api_owner.post_tx(None, &slate.tx, true); /// } /// ``` pub fn post_tx( &self, keychain_mask: Option<&SecretKey>, tx: &Transaction, fluff: bool, ) -> Result<(), Error> { let client = { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; // Test keychain mask, to keep API consistent let _ = w.keychain(keychain_mask)?; w.w2n_client().clone() }; owner::post_tx(&client, tx, fluff) } /// Cancels a transaction. This entails: /// * Setting the transaction status to either `TxSentCancelled` or `TxReceivedCancelled` /// * Deleting all change outputs or recipient outputs associated with the transaction /// * Setting the status of all assocatied inputs from `Locked` to `Spent` so they can be /// used in new transactions. /// /// Transactions can be cancelled by transaction log id or slate id (call with either set to /// Some, not both) /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `tx_id` - If present, cancel by the [`TxLogEntry`](../grin_wallet_libwallet/types/struct.TxLogEntry.html) id /// for the transaction. /// /// * `tx_slate_id` - If present, cancel by the Slate id. /// /// # Returns /// * `Ok(())` if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let args = InitTxArgs { /// src_acct_name: None, /// amount: 2_000_000_000, /// minimum_confirmations: 10, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// message: Some("Cancel this tx".to_owned()), /// ..Default::default() /// }; /// let result = api_owner.init_send_tx( /// None, /// args, /// ); /// /// if let Ok(slate) = result { /// // Send slate somehow /// // ... /// // Lock our outputs if we're happy the slate was (or is being) sent /// let res = api_owner.tx_lock_outputs(None, &slate, 0); /// // /// // We didn't get the slate back, or something else went wrong /// // /// let res = api_owner.cancel_tx(None, None, Some(slate.id.clone())); /// } /// ``` pub fn cancel_tx( &self, keychain_mask: Option<&SecretKey>, tx_id: Option<u32>, tx_slate_id: Option<Uuid>, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::cancel_tx(&mut **w, keychain_mask, tx_id, tx_slate_id) } /// Retrieves the stored transaction associated with a TxLogEntry. Can be used even after the /// transaction has completed. /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `tx_log_entry` - A [`TxLogEntry`](../grin_wallet_libwallet/types/struct.TxLogEntry.html) /// /// # Returns /// * Ok with the stored [`Transaction`](../grin_core/core/transaction/struct.Transaction.html) /// if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// let update_from_node = true; /// let tx_id = None; /// let tx_slate_id = None; /// /// // Return all TxLogEntries /// let result = api_owner.retrieve_txs(None, update_from_node, tx_id, tx_slate_id); /// /// if let Ok((was_updated, tx_log_entries)) = result { /// let stored_tx = api_owner.get_stored_tx(None, &tx_log_entries[0]).unwrap(); /// //... /// } /// ``` // TODO: Should be accepting an id, not an entire entry struct pub fn get_stored_tx( &self, keychain_mask: Option<&SecretKey>, tx_log_entry: &TxLogEntry, ) -> Result<Option<Transaction>, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; // Test keychain mask, to keep API consistent let _ = w.keychain(keychain_mask)?; owner::get_stored_tx(&**w, tx_log_entry) } /// Verifies all messages in the slate match their public keys. /// /// The optional messages themselves are part of the `participant_data` field within the slate. /// Messages are signed with the same key used to sign for the paricipant's inputs, and can thus be /// verified with the public key found in the `public_blind_excess` field. This function is a /// simple helper to returns whether all signatures in the participant data match their public /// keys. /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `slate` - The transaction [`Slate`](../grin_wallet_libwallet/slate/struct.Slate.html). /// /// # Returns /// * `Ok(())` if successful and the signatures validate /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let args = InitTxArgs { /// src_acct_name: None, /// amount: 2_000_000_000, /// minimum_confirmations: 10, /// max_outputs: 500, /// num_change_outputs: 1, /// selection_strategy_is_use_all: true, /// message: Some("Just verify messages".to_owned()), /// ..Default::default() /// }; /// let result = api_owner.init_send_tx( /// None, /// args, /// ); /// /// if let Ok(slate) = result { /// // Send slate somehow /// // ... /// // Lock our outputs if we're happy the slate was (or is being) sent /// let res = api_owner.tx_lock_outputs(None, &slate, 0); /// // /// // Retrieve slate back from recipient /// // /// let res = api_owner.verify_slate_messages(None, &slate); /// } /// ``` pub fn verify_slate_messages( &self, keychain_mask: Option<&SecretKey>, slate: &Slate, ) -> Result<(), Error> { { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; // Test keychain mask, to keep API consistent let _ = w.keychain(keychain_mask)?; } owner::verify_slate_messages(slate) } /// Scans the entire UTXO set from the node, creating outputs for each scanned /// output that matches the wallet's master seed. This function is intended to be called as part /// of a recovery process (either from BIP32 phrase or backup seed files,) and will error if the /// wallet is non-empty, i.e. contains any outputs at all. /// /// This operation scans the entire chain, and is expected to be time intensive. It is imperative /// that no other processes should be trying to use the wallet at the same time this function is /// running. /// /// A single [TxLogEntry](../grin_wallet_libwallet/types/struct.TxLogEntry.html) is created for /// all non-coinbase outputs discovered and restored during this process. A separate entry /// is created for each coinbase output. /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// /// # Returns /// * `Ok(())` if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let result = api_owner.restore(None); /// /// if let Ok(_) = result { /// // Wallet outputs should be consistent with what's on chain /// // ... /// } /// ``` pub fn restore(&self, keychain_mask: Option<&SecretKey>) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; let res = owner::restore(&mut **w, keychain_mask); res } /// Scans the entire UTXO set from the node, identify which outputs belong to the given wallet /// update the wallet state to be consistent with what's currently in the UTXO set. /// /// This function can be used to repair wallet state, particularly by restoring outputs that may /// be missing if the wallet owner has cancelled transactions locally that were then successfully /// posted to the chain. /// /// This operation scans the entire chain, and is expected to be time intensive. It is imperative /// that no other processes should be trying to use the wallet at the same time this function is /// running. /// /// When an output is found that doesn't exist in the wallet, a corresponding /// [TxLogEntry](../grin_wallet_libwallet/types/struct.TxLogEntry.html) is created. /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// * `delete_unconfirmed` - if `false`, the check_repair process will be non-destructive, and /// mostly limited to restoring missing outputs. It will leave unconfirmed transaction logs entries /// and unconfirmed outputs intact. If `true`, the process will unlock all locked outputs, /// restore all missing outputs, and mark any outputs that have been marked 'Spent' but are still /// in the UTXO set as 'Unspent' (as can happen during a fork). It will also attempt to cancel any /// transaction log entries associated with any locked outputs or outputs incorrectly marked 'Spent'. /// Note this completely removes all outstanding transactions, so users should be very aware what /// will happen if this flag is set. Note that if transactions/outputs are removed that later /// confirm on the chain, another call to this function will restore them. /// /// # Returns /// * `Ok(())` if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let mut api_owner = Owner::new(wallet.clone()); /// let result = api_owner.check_repair( /// None, /// false, /// ); /// /// if let Ok(_) = result { /// // Wallet outputs should be consistent with what's on chain /// // ... /// } /// ``` pub fn check_repair( &self, keychain_mask: Option<&SecretKey>, delete_unconfirmed: bool, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; owner::check_repair(&mut **w, keychain_mask, delete_unconfirmed) } /// Retrieves the last known height known by the wallet. This is determined as follows: /// * If the wallet can successfully contact its configured node, the reported node /// height is returned, and the `updated_from_node` field in the response is `true` /// * If the wallet cannot contact the node, this function returns the maximum height /// of all outputs contained within the wallet, and the `updated_from_node` fields /// in the response is set to false. /// /// Clients should generally ensure the `updated_from_node` field is returned as /// `true` before assuming the height for any operation. /// /// # Arguments /// /// * `keychain_mask` - Wallet secret mask to XOR against the stored wallet seed before using, if /// being used. /// /// # Returns /// * Ok with a [`NodeHeightResult`](../grin_wallet_libwallet/types/struct.NodeHeightResult.html) /// if successful. If the height result was obtained from the configured node, /// `updated_from_node` will be set to `true` /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// let result = api_owner.node_height(None); /// /// if let Ok(node_height_result) = result { /// if node_height_result.updated_from_node { /// //we can assume node_height_result.height is relatively safe to use /// /// } /// //... /// } /// ``` pub fn node_height( &self, keychain_mask: Option<&SecretKey>, ) -> Result<NodeHeightResult, Error> { let mut w_lock = self.wallet_inst.lock(); let w = w_lock.lc_provider()?.wallet_inst()?; // Test keychain mask, to keep API consistent let _ = w.keychain(keychain_mask)?; owner::node_height(&mut **w, keychain_mask) } // LIFECYCLE FUNCTIONS /// Retrieve the top-level directory for the wallet. This directory should contain the /// `grin-wallet.toml` file and the `wallet_data` directory that contains the wallet /// seed + data files. Future versions of the wallet API will support multiple wallets /// within the top level directory. /// /// The top level directory defaults to (in order of precedence): /// /// 1) The current directory, from which `grin-wallet` or the main process was run, if it /// contains a `grin-wallet.toml` file. /// 2) ~/.grin/<chaintype>/ otherwise /// /// # Arguments /// /// * None /// /// # Returns /// * Ok with a String value representing the full path to the top level wallet dierctory /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let api_owner = Owner::new(wallet.clone()); /// let result = api_owner.get_top_level_directory(); /// /// if let Ok(dir) = result { /// println!("Top level directory is: {}", dir); /// //... /// } /// ``` pub fn get_top_level_directory(&self) -> Result<String, Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; if self.doctest_mode { Ok("/doctest/dir".to_owned()) } else { lc.get_top_level_directory() } } /// Set the top-level directory for the wallet. This directory can be empty, and will be created /// during a subsequent calls to [`create_config`](struct.Owner.html#method.create_config) /// /// Set [`get_top_level_directory`](struct.Owner.html#method.get_top_level_directory) for a /// description of the top level directory and default paths. /// /// # Arguments /// /// * `dir`: The new top-level directory path (either relative to current directory or /// absolute. /// /// # Returns /// * Ok if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// let dir = "path/to/wallet/dir"; /// /// # let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap(); /// # let dir = dir /// # .path() /// # .to_str() /// # .ok_or("Failed to convert tmpdir path to string.".to_owned()) /// # .unwrap(); /// /// let api_owner = Owner::new(wallet.clone()); /// let result = api_owner.set_top_level_directory(dir); /// /// if let Ok(dir) = result { /// //... /// } /// ``` pub fn set_top_level_directory(&self, dir: &str) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.set_top_level_directory(dir) } /// Create a `grin-wallet.toml` configuration file in the top-level directory for the /// specified chain type. /// A custom [`WalletConfig`](../grin_wallet_config/types/struct.WalletConfig.html) /// and/or grin `LoggingConfig` may optionally be provided, otherwise defaults will be used. /// /// Paths in the configuration file will be updated to reflect the top level directory, so /// path-related values in the optional configuration structs will be ignored. /// /// # Arguments /// /// * `chain_type`: The chain type to use in creation of the configuration file. This can be /// * `AutomatedTesting` /// * `UserTesting` /// * `Floonet` /// * `Mainnet` /// /// # Returns /// * Ok if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// let dir = "path/to/wallet/dir"; /// /// # let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap(); /// # let dir = dir /// # .path() /// # .to_str() /// # .ok_or("Failed to convert tmpdir path to string.".to_owned()) /// # .unwrap(); /// /// let api_owner = Owner::new(wallet.clone()); /// let _ = api_owner.set_top_level_directory(dir); /// /// let result = api_owner.create_config(&ChainTypes::Mainnet, None, None); /// /// if let Ok(_) = result { /// //... /// } /// ``` pub fn create_config( &self, chain_type: &global::ChainTypes, wallet_config: Option<WalletConfig>, logging_config: Option<LoggingConfig>, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.create_config( chain_type, "grin-wallet.toml", wallet_config, logging_config, ) } /// Creates a new wallet seed and empty wallet database in the `wallet_data` directory of /// the top level directory. /// /// Paths in the configuration file will be updated to reflect the top level directory, so /// path-related values in the optional configuration structs will be ignored. /// /// The wallet files must not already exist, and ~The `grin-wallet.toml` file must exist /// in the top level directory (can be created via a call to /// [`create_config`](struct.Owner.html#method.create_config)) /// /// # Arguments /// /// * `name`: Reserved for future use, use `None` for the time being. /// * `mnemonic`: If present, restore the wallet seed from the given mnemonic instead of creating /// a new random seed. /// * `mnemonic_length`: Desired length of mnemonic in bytes (16 or 32, either 12 or 24 words). /// Use 0 if mnemonic isn't being used. /// * `password`: The password used to encrypt/decrypt the `wallet.seed` file /// /// # Returns /// * Ok if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// // note that the WalletInst struct does not necessarily need to contain an /// // instantiated wallet /// /// let dir = "path/to/wallet/dir"; /// /// # let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap(); /// # let dir = dir /// # .path() /// # .to_str() /// # .ok_or("Failed to convert tmpdir path to string.".to_owned()) /// # .unwrap(); /// let api_owner = Owner::new(wallet.clone()); /// let _ = api_owner.set_top_level_directory(dir); /// /// // Create configuration /// let result = api_owner.create_config(&ChainTypes::Mainnet, None, None); /// /// // create new wallet wirh random seed /// let pw = ZeroingString::from("my_password"); /// let result = api_owner.create_wallet(None, None, 0, pw); /// /// if let Ok(r) = result { /// //... /// } /// ``` pub fn create_wallet( &self, name: Option<&str>, mnemonic: Option<ZeroingString>, mnemonic_length: u32, password: ZeroingString, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.create_wallet( name, mnemonic, mnemonic_length as usize, password, self.doctest_mode, ) } /// `Opens` a wallet, populating the internal keychain with the encrypted seed, and optionally /// returning a `keychain_mask` token to the caller to provide in all future calls. /// If using a mask, the seed will be stored in-memory XORed against the `keychain_mask`, and /// will not be useable if the mask is not provided. /// /// # Arguments /// /// * `name`: Reserved for future use, use `None` for the time being. /// * `password`: The password to use to open the wallet /// a new random seed. /// * `use_mask`: Whether to create and return a mask which much be provided in all future /// API calls. /// /// # Returns /// * Ok if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// // note that the WalletInst struct does not necessarily need to contain an /// // instantiated wallet /// let dir = "path/to/wallet/dir"; /// /// # let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap(); /// # let dir = dir /// # .path() /// # .to_str() /// # .ok_or("Failed to convert tmpdir path to string.".to_owned()) /// # .unwrap(); /// let api_owner = Owner::new(wallet.clone()); /// let _ = api_owner.set_top_level_directory(dir); /// /// // Create configuration /// let result = api_owner.create_config(&ChainTypes::Mainnet, None, None); /// /// // create new wallet wirh random seed /// let pw = ZeroingString::from("my_password"); /// let _ = api_owner.create_wallet(None, None, 0, pw.clone()); /// /// let result = api_owner.open_wallet(None, pw, true); /// /// if let Ok(m) = result { /// // use this mask in all subsequent calls /// let mask = m; /// } /// ``` pub fn open_wallet( &self, name: Option<&str>, password: ZeroingString, use_mask: bool, ) -> Result<Option<SecretKey>, Error> { // just return a representative string for doctest mode if self.doctest_mode { let secp_inst = static_secp_instance(); let secp = secp_inst.lock(); return Ok(Some(SecretKey::from_slice( &secp, &from_hex( "d096b3cb75986b3b13f80b8f5243a9edf0af4c74ac37578c5a12cfb5b59b1868".to_owned(), ) .unwrap(), )?)); } let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.open_wallet(name, password, use_mask, self.doctest_mode) } /// `Close` a wallet, removing the master seed from memory. /// /// # Arguments /// /// * `name`: Reserved for future use, use `None` for the time being. /// /// # Returns /// * Ok if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// // Set up as above /// # let api_owner = Owner::new(wallet.clone()); /// /// let res = api_owner.close_wallet(None); /// /// if let Ok(_) = res { /// // ... /// } /// ``` pub fn close_wallet(&self, name: Option<&str>) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.close_wallet(name) } /// Return the BIP39 mnemonic for the given wallet. This function will decrypt /// the wallet's seed file with the given password, and thus does not need the /// wallet to be open. /// /// # Arguments /// /// * `name`: Reserved for future use, use `None` for the time being. /// * `password`: The password used to encrypt the seed file. /// /// # Returns /// * Ok(BIP-39 mneminc) if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// // Set up as above /// # let api_owner = Owner::new(wallet.clone()); /// /// let pw = ZeroingString::from("my_password"); /// let res = api_owner.get_mnemonic(None, pw); /// /// if let Ok(mne) = res { /// // ... /// } /// ``` pub fn get_mnemonic( &self, name: Option<&str>, password: ZeroingString, ) -> Result<ZeroingString, Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.get_mnemonic(name, password) } /// Changes a wallet's password, meaning the old seed file is decrypted with the old password, /// and a new seed file is created with the same mnemonic and encrypted with the new password. /// /// This function temporarily backs up the old seed file until a test-decryption of the new /// file is confirmed to contain the same seed as the original seed file, at which point the /// backup is deleted. If this operation fails for an unknown reason, the backup file will still /// exist in the wallet's data directory encrypted with the old password. /// /// # Arguments /// /// * `name`: Reserved for future use, use `None` for the time being. /// * `old`: The password used to encrypt the existing seed file (i.e. old password) /// * `new`: The password to be used to encrypt the new seed file /// /// # Returns /// * Ok(()) if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// // Set up as above /// # let api_owner = Owner::new(wallet.clone()); /// /// let old = ZeroingString::from("my_password"); /// let new = ZeroingString::from("new_password"); /// let res = api_owner.change_password(None, old, new); /// /// if let Ok(mne) = res { /// // ... /// } /// ``` pub fn change_password( &self, name: Option<&str>, old: ZeroingString, new: ZeroingString, ) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.change_password(name, old, new) } /// Deletes a wallet, removing the config file, seed file and all data files. /// Obviously, use with extreme caution and plenty of user warning /// /// Highly recommended that the wallet be explicitly closed first via the `close_wallet` /// function. /// /// # Arguments /// /// * `name`: Reserved for future use, use `None` for the time being. /// /// # Returns /// * Ok if successful /// * or [`libwallet::Error`](../grin_wallet_libwallet/struct.Error.html) if an error is encountered. /// /// # Example /// Set up as in [`new`](struct.Owner.html#method.new) method above. /// ``` /// # grin_wallet_api::doctest_helper_setup_doc_env!(wallet, wallet_config); /// /// use grin_core::global::ChainTypes; /// /// // Set up as above /// # let api_owner = Owner::new(wallet.clone()); /// /// let res = api_owner.delete_wallet(None); /// /// if let Ok(_) = res { /// // ... /// } /// ``` pub fn delete_wallet(&self, name: Option<&str>) -> Result<(), Error> { let mut w_lock = self.wallet_inst.lock(); let lc = w_lock.lc_provider()?; lc.delete_wallet(name) } } #[doc(hidden)] #[macro_export] macro_rules! doctest_helper_setup_doc_env { ($wallet:ident, $wallet_config:ident) => { use grin_wallet_api as api; use grin_wallet_config as config; use grin_wallet_impls as impls; use grin_wallet_libwallet as libwallet; use grin_wallet_util::grin_core; use grin_wallet_util::grin_keychain as keychain; use grin_wallet_util::grin_util as util; use keychain::ExtKeychain; use tempfile::tempdir; use std::sync::Arc; use util::{Mutex, ZeroingString}; use api::{Foreign, Owner}; use config::WalletConfig; use impls::{DefaultLCProvider, DefaultWalletImpl, HTTPNodeClient}; use libwallet::{BlockFees, InitTxArgs, IssueInvoiceTxArgs, Slate, WalletInst}; let dir = tempdir().map_err(|e| format!("{:#?}", e)).unwrap(); let dir = dir .path() .to_str() .ok_or("Failed to convert tmpdir path to string.".to_owned()) .unwrap(); let mut wallet_config = WalletConfig::default(); wallet_config.data_file_dir = dir.to_owned(); let pw = ZeroingString::from(""); let node_client = HTTPNodeClient::new(&wallet_config.check_node_api_http_addr, None); let mut wallet = Box::new( DefaultWalletImpl::<'static, HTTPNodeClient>::new(node_client.clone()).unwrap(), ) as Box< WalletInst< 'static, DefaultLCProvider<HTTPNodeClient, ExtKeychain>, HTTPNodeClient, ExtKeychain, >, >; let lc = wallet.lc_provider().unwrap(); let _ = lc.set_top_level_directory(&wallet_config.data_file_dir); lc.open_wallet(None, pw, false, false); let mut $wallet = Arc::new(Mutex::new(wallet)); }; }