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
//! Contains [`ApiError`] and associated helper functions. use core::{ fmt::{self, Debug, Formatter}, u16, u8, }; use crate::{ account::{ AddKeyFailure, RemoveKeyFailure, SetThresholdFailure, TryFromIntError, TryFromSliceForAccountHashError, UpdateKeyFailure, }, bytesrepr, contracts, system_contract_errors::{mint, pos}, CLValueError, }; /// All `Error` variants defined in this library other than `Error::User` will convert to a `u32` /// value less than or equal to `RESERVED_ERROR_MAX`. const RESERVED_ERROR_MAX: u32 = u16::MAX as u32; // 0..=65535 /// Proof of Stake errors (defined in "contracts/system/pos/src/error.rs") will have this value /// added to them when being converted to a `u32`. const POS_ERROR_OFFSET: u32 = RESERVED_ERROR_MAX - u8::MAX as u32; // 65280..=65535 /// Mint errors (defined in "contracts/system/mint/src/error.rs") will have this value /// added to them when being converted to a `u32`. const MINT_ERROR_OFFSET: u32 = (POS_ERROR_OFFSET - 1) - u8::MAX as u32; // 65024..=65279 /// Contract header errors (defined in "types/src/contract_header.rs") will have this value /// added to them when being converted to a `u32`. const HEADER_ERROR_OFFSET: u32 = (MINT_ERROR_OFFSET - 1) - u8::MAX as u32; // 64768..=65023 /// Minimum value of user error's inclusive range. const USER_ERROR_MIN: u32 = RESERVED_ERROR_MAX + 1; /// Maximum value of user error's inclusive range. const USER_ERROR_MAX: u32 = 2 * RESERVED_ERROR_MAX + 1; /// Minimum value of Mint error's inclusive range. const MINT_ERROR_MIN: u32 = MINT_ERROR_OFFSET; /// Maximum value of Mint error's inclusive range. const MINT_ERROR_MAX: u32 = POS_ERROR_OFFSET - 1; /// Minimum value of Proof of Stake error's inclusive range. const POS_ERROR_MIN: u32 = POS_ERROR_OFFSET; /// Maximum value of Proof of Stake error's inclusive range. const POS_ERROR_MAX: u32 = RESERVED_ERROR_MAX; /// Minimum value of contract header error's inclusive range. const HEADER_ERROR_MIN: u32 = HEADER_ERROR_OFFSET; /// Maximum value of contract header error's inclusive range. const HEADER_ERROR_MAX: u32 = HEADER_ERROR_OFFSET + u8::MAX as u32; /// Errors which can be encountered while running a smart contract. /// /// An `ApiError` can be converted to a `u32` in order to be passed via the execution engine's /// `ext_ffi::revert()` function. This means the information each variant can convey is limited. /// /// The variants are split into numeric ranges as follows: /// /// | Inclusive range | Variant(s) | /// | ----------------| ---------------------------------------------| /// | [1, 65023] | all except `Mint`, `ProofOfStake` and `User` | /// | [65024, 65279] | `Mint` | /// | [65280, 65535] | `ProofOfStake` | /// | [65536, 131071] | `User` | /// /// ## Mappings /// /// The expanded mapping of all variants to their numerical equivalents is as follows: /// ``` /// # use casperlabs_types::ApiError::{self, *}; /// # macro_rules! show_and_check { /// # ($lhs:literal => $rhs:expr) => { /// # assert_eq!($lhs as u32, ApiError::from($rhs).into()); /// # }; /// # } /// // General system errors: /// # show_and_check!( /// 1 => None /// # ); /// # show_and_check!( /// 2 => MissingArgument /// # ); /// # show_and_check!( /// 3 => InvalidArgument /// # ); /// # show_and_check!( /// 4 => Deserialize /// # ); /// # show_and_check!( /// 5 => Read /// # ); /// # show_and_check!( /// 6 => ValueNotFound /// # ); /// # show_and_check!( /// 7 => ContractNotFound /// # ); /// # show_and_check!( /// 8 => GetKey /// # ); /// # show_and_check!( /// 9 => UnexpectedKeyVariant /// # ); /// # show_and_check!( /// 10 => UnexpectedContractRefVariant /// # ); /// # show_and_check!( /// 11 => InvalidPurseName /// # ); /// # show_and_check!( /// 12 => InvalidPurse /// # ); /// # show_and_check!( /// 13 => UpgradeContractAtURef /// # ); /// # show_and_check!( /// 14 => Transfer /// # ); /// # show_and_check!( /// 15 => NoAccessRights /// # ); /// # show_and_check!( /// 16 => CLTypeMismatch /// # ); /// # show_and_check!( /// 17 => EarlyEndOfStream /// # ); /// # show_and_check!( /// 18 => Formatting /// # ); /// # show_and_check!( /// 19 => LeftOverBytes /// # ); /// # show_and_check!( /// 20 => OutOfMemory /// # ); /// # show_and_check!( /// 21 => MaxKeysLimit /// # ); /// # show_and_check!( /// 22 => DuplicateKey /// # ); /// # show_and_check!( /// 23 => PermissionDenied /// # ); /// # show_and_check!( /// 24 => MissingKey /// # ); /// # show_and_check!( /// 25 => ThresholdViolation /// # ); /// # show_and_check!( /// 26 => KeyManagementThreshold /// # ); /// # show_and_check!( /// 27 => DeploymentThreshold /// # ); /// # show_and_check!( /// 28 => InsufficientTotalWeight /// # ); /// # show_and_check!( /// 29 => InvalidSystemContract /// # ); /// # show_and_check!( /// 30 => PurseNotCreated /// # ); /// # show_and_check!( /// 31 => Unhandled /// # ); /// # show_and_check!( /// 32 => BufferTooSmall /// # ); /// # show_and_check!( /// 33 => HostBufferEmpty /// # ); /// # show_and_check!( /// 34 => HostBufferFull /// # ); /// // Contract header errors: /// use casperlabs_types::contracts::Error as ContractHeaderError; /// # show_and_check!( /// 64_769 => ContractHeaderError::PreviouslyUsedVersion /// # ); /// # show_and_check!( /// 64_770 => ContractHeaderError::ContractNotFound /// # ); /// # show_and_check!( /// 64_771 => ContractHeaderError::GroupAlreadyExists /// # ); /// # show_and_check!( /// 64_772 => ContractHeaderError::MaxGroupsExceeded /// # ); /// # show_and_check!( /// 64_773 => ContractHeaderError::MaxTotalURefsExceeded /// # ); /// // Mint errors: /// use casperlabs_types::system_contract_errors::mint::Error as MintError; /// # show_and_check!( /// 65_024 => MintError::InsufficientFunds /// # ); /// # show_and_check!( /// 65_025 => MintError::SourceNotFound /// # ); /// # show_and_check!( /// 65_026 => MintError::DestNotFound /// # ); /// # show_and_check!( /// 65_027 => MintError::InvalidURef /// # ); /// # show_and_check!( /// 65_028 => MintError::InvalidAccessRights /// # ); /// # show_and_check!( /// 65_029 => MintError::InvalidNonEmptyPurseCreation /// # ); /// # show_and_check!( /// 65_030 => MintError::Storage /// # ); /// # show_and_check!( /// 65_031 => MintError::PurseNotFound /// # ); /// /// // Proof of stake errors: /// use casperlabs_types::system_contract_errors::pos::Error as PosError; /// # show_and_check!( /// 65_280 => PosError::NotBonded /// # ); /// # show_and_check!( /// 65_281 => PosError::TooManyEventsInQueue /// # ); /// # show_and_check!( /// 65_282 => PosError::CannotUnbondLastValidator /// # ); /// # show_and_check!( /// 65_283 => PosError::SpreadTooHigh /// # ); /// # show_and_check!( /// 65_284 => PosError::MultipleRequests /// # ); /// # show_and_check!( /// 65_285 => PosError::BondTooSmall /// # ); /// # show_and_check!( /// 65_286 => PosError::BondTooLarge /// # ); /// # show_and_check!( /// 65_287 => PosError::UnbondTooLarge /// # ); /// # show_and_check!( /// 65_288 => PosError::BondTransferFailed /// # ); /// # show_and_check!( /// 65_289 => PosError::UnbondTransferFailed /// # ); /// # show_and_check!( /// 65_290 => PosError::TimeWentBackwards /// # ); /// # show_and_check!( /// 65_291 => PosError::StakesNotFound /// # ); /// # show_and_check!( /// 65_292 => PosError::PaymentPurseNotFound /// # ); /// # show_and_check!( /// 65_293 => PosError::PaymentPurseKeyUnexpectedType /// # ); /// # show_and_check!( /// 65_294 => PosError::PaymentPurseBalanceNotFound /// # ); /// # show_and_check!( /// 65_295 => PosError::BondingPurseNotFound /// # ); /// # show_and_check!( /// 65_296 => PosError::BondingPurseKeyUnexpectedType /// # ); /// # show_and_check!( /// 65_297 => PosError::RefundPurseKeyUnexpectedType /// # ); /// # show_and_check!( /// 65_298 => PosError::RewardsPurseNotFound /// # ); /// # show_and_check!( /// 65_299 => PosError::RewardsPurseKeyUnexpectedType /// # ); /// # show_and_check!( /// 65_300 => PosError::StakesKeyDeserializationFailed /// # ); /// # show_and_check!( /// 65_301 => PosError::StakesDeserializationFailed /// # ); /// # show_and_check!( /// 65_302 => PosError::SystemFunctionCalledByUserAccount /// # ); /// # show_and_check!( /// 65_303 => PosError::InsufficientPaymentForAmountSpent /// # ); /// # show_and_check!( /// 65_304 => PosError::FailedTransferToRewardsPurse /// # ); /// # show_and_check!( /// 65_305 => PosError::FailedTransferToAccountPurse /// # ); /// # show_and_check!( /// 65_306 => PosError::SetRefundPurseCalledOutsidePayment /// # ); /// /// // User-defined errors: /// # show_and_check!( /// 65_536 => User(0) /// # ); /// # show_and_check!( /// 65_537 => User(1) /// # ); /// # show_and_check!( /// 65_538 => User(2) /// # ); /// # show_and_check!( /// 131_071 => User(u16::max_value()) /// # ); /// ``` /// /// Users can specify a C-style enum and implement `From` to ease usage of /// `casperlabs_contract::runtime::revert()`, e.g. /// ``` /// use casperlabs_types::ApiError; /// /// #[repr(u16)] /// enum FailureCode { /// Zero = 0, // 65,536 as an ApiError::User /// One, // 65,537 as an ApiError::User /// Two // 65,538 as an ApiError::User /// } /// /// impl From<FailureCode> for ApiError { /// fn from(code: FailureCode) -> Self { /// ApiError::User(code as u16) /// } /// } /// /// assert_eq!(ApiError::User(1), FailureCode::One.into()); /// assert_eq!(65_536, u32::from(ApiError::from(FailureCode::Zero))); /// assert_eq!(65_538, u32::from(ApiError::from(FailureCode::Two))); /// ``` #[derive(Copy, Clone, PartialEq, Eq)] pub enum ApiError { /// Optional data was unexpectedly `None`. None, /// Specified argument not provided. MissingArgument, /// Argument not of correct type. InvalidArgument, /// Failed to deserialize a value. Deserialize, /// `casperlabs_contract::storage::read()` returned an error. Read, /// The given key returned a `None` value. ValueNotFound, /// Failed to find a specified contract. ContractNotFound, /// A call to `casperlabs_contract::runtime::get_key()` returned a failure. GetKey, /// The [`Key`](crate::Key) variant was not as expected. UnexpectedKeyVariant, /// The [`ContractRef`](crate::ContractRef) variant was not as expected. UnexpectedContractRefVariant, /// Invalid purse name given. InvalidPurseName, /// Invalid purse retrieved. InvalidPurse, /// Failed to upgrade contract at [`URef`](crate::URef). UpgradeContractAtURef, /// Failed to transfer motes. Transfer, /// The given [`URef`](crate::URef) has no access rights. NoAccessRights, /// A given type could not be constructed from a [`CLValue`](crate::CLValue). CLTypeMismatch, /// Early end of stream while deserializing. EarlyEndOfStream, /// Formatting error while deserializing. Formatting, /// Not all input bytes were consumed in [`deserialize`](crate::bytesrepr::deserialize). LeftOverBytes, /// Out of memory error. OutOfMemory, /// There are already [`MAX_ASSOCIATED_KEYS`](crate::account::MAX_ASSOCIATED_KEYS) /// [`AccountHash`](crate::account::AccountHash)s associated with the given account. MaxKeysLimit, /// The given [`AccountHash`](crate::account::AccountHash) is already associated with the given /// account. DuplicateKey, /// Caller doesn't have sufficient permissions to perform the given action. PermissionDenied, /// The given [`AccountHash`](crate::account::AccountHash) is not associated with the given /// account. MissingKey, /// Removing/updating the given associated [`AccountHash`](crate::account::AccountHash) would /// cause the total [`Weight`](crate::account::Weight) of all remaining `AccountHash`s to /// fall below one of the action thresholds for the given account. ThresholdViolation, /// Setting the key-management threshold to a value lower than the deployment threshold is /// disallowed. KeyManagementThreshold, /// Setting the deployment threshold to a value greater than any other threshold is disallowed. DeploymentThreshold, /// Setting a threshold to a value greater than the total weight of associated keys is /// disallowed. InsufficientTotalWeight, /// The given `u32` doesn't map to a [`SystemContractType`](crate::SystemContractType). InvalidSystemContract, /// Failed to create a new purse. PurseNotCreated, /// An unhandled value, likely representing a bug in the code. Unhandled, /// The provided buffer is too small to complete an operation. BufferTooSmall, /// No data available in the host buffer. HostBufferEmpty, /// The host buffer has been set to a value and should be consumed first by a read operation. HostBufferFull, /// Could not lay out an array in memory AllocLayout, /// Contract header errors. ContractHeader(u8), /// Error specific to Mint contract. Mint(u8), /// Error specific to Proof of Stake contract. ProofOfStake(u8), /// User-specified error code. The internal `u16` value is added to `u16::MAX as u32 + 1` when /// an `Error::User` is converted to a `u32`. User(u16), } impl From<bytesrepr::Error> for ApiError { fn from(error: bytesrepr::Error) -> Self { match error { bytesrepr::Error::EarlyEndOfStream => ApiError::EarlyEndOfStream, bytesrepr::Error::Formatting => ApiError::Formatting, bytesrepr::Error::LeftOverBytes => ApiError::LeftOverBytes, bytesrepr::Error::OutOfMemory => ApiError::OutOfMemory, } } } impl From<AddKeyFailure> for ApiError { fn from(error: AddKeyFailure) -> Self { match error { AddKeyFailure::MaxKeysLimit => ApiError::MaxKeysLimit, AddKeyFailure::DuplicateKey => ApiError::DuplicateKey, AddKeyFailure::PermissionDenied => ApiError::PermissionDenied, } } } impl From<UpdateKeyFailure> for ApiError { fn from(error: UpdateKeyFailure) -> Self { match error { UpdateKeyFailure::MissingKey => ApiError::MissingKey, UpdateKeyFailure::PermissionDenied => ApiError::PermissionDenied, UpdateKeyFailure::ThresholdViolation => ApiError::ThresholdViolation, } } } impl From<RemoveKeyFailure> for ApiError { fn from(error: RemoveKeyFailure) -> Self { match error { RemoveKeyFailure::MissingKey => ApiError::MissingKey, RemoveKeyFailure::PermissionDenied => ApiError::PermissionDenied, RemoveKeyFailure::ThresholdViolation => ApiError::ThresholdViolation, } } } impl From<SetThresholdFailure> for ApiError { fn from(error: SetThresholdFailure) -> Self { match error { SetThresholdFailure::KeyManagementThreshold => ApiError::KeyManagementThreshold, SetThresholdFailure::DeploymentThreshold => ApiError::DeploymentThreshold, SetThresholdFailure::PermissionDeniedError => ApiError::PermissionDenied, SetThresholdFailure::InsufficientTotalWeight => ApiError::InsufficientTotalWeight, } } } impl From<CLValueError> for ApiError { fn from(error: CLValueError) -> Self { match error { CLValueError::Serialization(bytesrepr_error) => bytesrepr_error.into(), CLValueError::Type(_) => ApiError::CLTypeMismatch, } } } impl From<contracts::Error> for ApiError { fn from(error: contracts::Error) -> Self { ApiError::ContractHeader(error as u8) } } // This conversion is not intended to be used by third party crates. #[doc(hidden)] impl From<TryFromIntError> for ApiError { fn from(_error: TryFromIntError) -> Self { ApiError::Unhandled } } impl From<TryFromSliceForAccountHashError> for ApiError { fn from(_error: TryFromSliceForAccountHashError) -> Self { ApiError::Deserialize } } impl From<mint::Error> for ApiError { fn from(error: mint::Error) -> Self { ApiError::Mint(error as u8) } } impl From<pos::Error> for ApiError { fn from(error: pos::Error) -> Self { ApiError::ProofOfStake(error as u8) } } impl From<ApiError> for u32 { fn from(error: ApiError) -> Self { match error { ApiError::None => 1, ApiError::MissingArgument => 2, ApiError::InvalidArgument => 3, ApiError::Deserialize => 4, ApiError::Read => 5, ApiError::ValueNotFound => 6, ApiError::ContractNotFound => 7, ApiError::GetKey => 8, ApiError::UnexpectedKeyVariant => 9, ApiError::UnexpectedContractRefVariant => 10, ApiError::InvalidPurseName => 11, ApiError::InvalidPurse => 12, ApiError::UpgradeContractAtURef => 13, ApiError::Transfer => 14, ApiError::NoAccessRights => 15, ApiError::CLTypeMismatch => 16, ApiError::EarlyEndOfStream => 17, ApiError::Formatting => 18, ApiError::LeftOverBytes => 19, ApiError::OutOfMemory => 20, ApiError::MaxKeysLimit => 21, ApiError::DuplicateKey => 22, ApiError::PermissionDenied => 23, ApiError::MissingKey => 24, ApiError::ThresholdViolation => 25, ApiError::KeyManagementThreshold => 26, ApiError::DeploymentThreshold => 27, ApiError::InsufficientTotalWeight => 28, ApiError::InvalidSystemContract => 29, ApiError::PurseNotCreated => 30, ApiError::Unhandled => 31, ApiError::BufferTooSmall => 32, ApiError::HostBufferEmpty => 33, ApiError::HostBufferFull => 34, ApiError::AllocLayout => 35, ApiError::ContractHeader(value) => HEADER_ERROR_OFFSET + u32::from(value), ApiError::Mint(value) => MINT_ERROR_OFFSET + u32::from(value), ApiError::ProofOfStake(value) => POS_ERROR_OFFSET + u32::from(value), ApiError::User(value) => RESERVED_ERROR_MAX + 1 + u32::from(value), } } } impl From<u32> for ApiError { fn from(value: u32) -> ApiError { match value { 1 => ApiError::None, 2 => ApiError::MissingArgument, 3 => ApiError::InvalidArgument, 4 => ApiError::Deserialize, 5 => ApiError::Read, 6 => ApiError::ValueNotFound, 7 => ApiError::ContractNotFound, 8 => ApiError::GetKey, 9 => ApiError::UnexpectedKeyVariant, 10 => ApiError::UnexpectedContractRefVariant, 11 => ApiError::InvalidPurseName, 12 => ApiError::InvalidPurse, 13 => ApiError::UpgradeContractAtURef, 14 => ApiError::Transfer, 15 => ApiError::NoAccessRights, 16 => ApiError::CLTypeMismatch, 17 => ApiError::EarlyEndOfStream, 18 => ApiError::Formatting, 19 => ApiError::LeftOverBytes, 20 => ApiError::OutOfMemory, 21 => ApiError::MaxKeysLimit, 22 => ApiError::DuplicateKey, 23 => ApiError::PermissionDenied, 24 => ApiError::MissingKey, 25 => ApiError::ThresholdViolation, 26 => ApiError::KeyManagementThreshold, 27 => ApiError::DeploymentThreshold, 28 => ApiError::InsufficientTotalWeight, 29 => ApiError::InvalidSystemContract, 30 => ApiError::PurseNotCreated, 31 => ApiError::Unhandled, 32 => ApiError::BufferTooSmall, 33 => ApiError::HostBufferEmpty, 34 => ApiError::HostBufferFull, 35 => ApiError::AllocLayout, USER_ERROR_MIN..=USER_ERROR_MAX => ApiError::User(value as u16), POS_ERROR_MIN..=POS_ERROR_MAX => ApiError::ProofOfStake(value as u8), MINT_ERROR_MIN..=MINT_ERROR_MAX => ApiError::Mint(value as u8), HEADER_ERROR_MIN..=HEADER_ERROR_MAX => ApiError::ContractHeader(value as u8), _ => ApiError::Unhandled, } } } impl Debug for ApiError { fn fmt(&self, f: &mut Formatter) -> fmt::Result { match self { ApiError::None => write!(f, "ApiError::None")?, ApiError::MissingArgument => write!(f, "ApiError::MissingArgument")?, ApiError::InvalidArgument => write!(f, "ApiError::InvalidArgument")?, ApiError::Deserialize => write!(f, "ApiError::Deserialize")?, ApiError::Read => write!(f, "ApiError::Read")?, ApiError::ValueNotFound => write!(f, "ApiError::ValueNotFound")?, ApiError::ContractNotFound => write!(f, "ApiError::ContractNotFound")?, ApiError::GetKey => write!(f, "ApiError::GetKey")?, ApiError::UnexpectedKeyVariant => write!(f, "ApiError::UnexpectedKeyVariant")?, ApiError::UnexpectedContractRefVariant => { write!(f, "ApiError::UnexpectedContractRefVariant")? } ApiError::InvalidPurseName => write!(f, "ApiError::InvalidPurseName")?, ApiError::InvalidPurse => write!(f, "ApiError::InvalidPurse")?, ApiError::UpgradeContractAtURef => write!(f, "ApiError::UpgradeContractAtURef")?, ApiError::Transfer => write!(f, "ApiError::Transfer")?, ApiError::NoAccessRights => write!(f, "ApiError::NoAccessRights")?, ApiError::CLTypeMismatch => write!(f, "ApiError::CLTypeMismatch")?, ApiError::EarlyEndOfStream => write!(f, "ApiError::EarlyEndOfStream")?, ApiError::Formatting => write!(f, "ApiError::Formatting")?, ApiError::LeftOverBytes => write!(f, "ApiError::LeftOverBytes")?, ApiError::OutOfMemory => write!(f, "ApiError::OutOfMemory")?, ApiError::MaxKeysLimit => write!(f, "ApiError::MaxKeysLimit")?, ApiError::DuplicateKey => write!(f, "ApiError::DuplicateKey")?, ApiError::PermissionDenied => write!(f, "ApiError::PermissionDenied")?, ApiError::MissingKey => write!(f, "ApiError::MissingKey")?, ApiError::ThresholdViolation => write!(f, "ApiError::ThresholdViolation")?, ApiError::KeyManagementThreshold => write!(f, "ApiError::KeyManagementThreshold")?, ApiError::DeploymentThreshold => write!(f, "ApiError::DeploymentThreshold")?, ApiError::InsufficientTotalWeight => write!(f, "ApiError::InsufficientTotalWeight")?, ApiError::InvalidSystemContract => write!(f, "ApiError::InvalidSystemContract")?, ApiError::PurseNotCreated => write!(f, "ApiError::PurseNotCreated")?, ApiError::Unhandled => write!(f, "ApiError::Unhandled")?, ApiError::BufferTooSmall => write!(f, "ApiError::BufferTooSmall")?, ApiError::HostBufferEmpty => write!(f, "ApiError::HostBufferEmpty")?, ApiError::HostBufferFull => write!(f, "ApiError::HostBufferFull")?, ApiError::AllocLayout => write!(f, "ApiError::AllocLayout")?, ApiError::ContractHeader(value) => write!(f, "ApiError::ContractHeader({})", value)?, ApiError::Mint(value) => write!(f, "ApiError::Mint({})", value)?, ApiError::ProofOfStake(value) => write!(f, "ApiError::ProofOfStake({})", value)?, ApiError::User(value) => write!(f, "ApiError::User({})", value)?, } write!(f, " [{}]", u32::from(*self)) } } impl fmt::Display for ApiError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { ApiError::User(value) => write!(f, "User error: {}", value), ApiError::ContractHeader(value) => write!(f, "Contract header error: {}", value), ApiError::Mint(value) => write!(f, "Mint error: {}", value), ApiError::ProofOfStake(value) => write!(f, "PoS error: {}", value), _ => <Self as Debug>::fmt(&self, f), } } } // This function is not intended to be used by third party crates. #[doc(hidden)] pub fn i32_from(result: Result<(), ApiError>) -> i32 { match result { Ok(()) => 0, Err(error) => u32::from(error) as i32, } } /// Converts an `i32` to a `Result<(), ApiError>`, where `0` represents `Ok(())`, and all other /// inputs are mapped to `Err(ApiError::<variant>)`. The full list of mappings can be found in the /// [docs for `ApiError`](ApiError#mappings). pub fn result_from(value: i32) -> Result<(), ApiError> { match value { 0 => Ok(()), _ => Err(ApiError::from(value as u32)), } } #[cfg(test)] mod tests { use std::{i32, u16, u8}; use super::*; fn round_trip(result: Result<(), ApiError>) { let code = i32_from(result); assert_eq!(result, result_from(code)); } #[test] fn error_values() { assert_eq!(65_024_u32, ApiError::Mint(0).into()); // MINT_ERROR_OFFSET == 65,024 assert_eq!(65_279_u32, ApiError::Mint(u8::MAX).into()); assert_eq!(65_280_u32, ApiError::ProofOfStake(0).into()); // POS_ERROR_OFFSET == 65,280 assert_eq!(65_535_u32, ApiError::ProofOfStake(u8::MAX).into()); assert_eq!(65_536_u32, ApiError::User(0).into()); // u16::MAX + 1 assert_eq!(131_071_u32, ApiError::User(u16::MAX).into()); // 2 * u16::MAX + 1 } #[test] fn error_descriptions() { assert_eq!("ApiError::GetKey [8]", &format!("{:?}", ApiError::GetKey)); assert_eq!("ApiError::GetKey [8]", &format!("{}", ApiError::GetKey)); assert_eq!( "ApiError::ContractHeader(0) [64768]", &format!("{:?}", ApiError::ContractHeader(0)) ); assert_eq!( "Contract header error: 0", &format!("{}", ApiError::ContractHeader(0)) ); assert_eq!( "Contract header error: 255", &format!("{}", ApiError::ContractHeader(u8::MAX)) ); assert_eq!( "ApiError::Mint(0) [65024]", &format!("{:?}", ApiError::Mint(0)) ); assert_eq!("Mint error: 0", &format!("{}", ApiError::Mint(0))); assert_eq!("Mint error: 255", &format!("{}", ApiError::Mint(u8::MAX))); assert_eq!( "ApiError::ProofOfStake(0) [65280]", &format!("{:?}", ApiError::ProofOfStake(0)) ); assert_eq!("PoS error: 0", &format!("{}", ApiError::ProofOfStake(0))); assert_eq!( "ApiError::ProofOfStake(255) [65535]", &format!("{:?}", ApiError::ProofOfStake(u8::MAX)) ); assert_eq!( "ApiError::User(0) [65536]", &format!("{:?}", ApiError::User(0)) ); assert_eq!("User error: 0", &format!("{}", ApiError::User(0))); assert_eq!( "ApiError::User(65535) [131071]", &format!("{:?}", ApiError::User(u16::MAX)) ); assert_eq!( "User error: 65535", &format!("{}", ApiError::User(u16::MAX)) ); } #[test] fn error_edge_cases() { assert_eq!(Err(ApiError::Unhandled), result_from(i32::MAX)); assert_eq!( Err(ApiError::ContractHeader(255)), result_from(MINT_ERROR_OFFSET as i32 - 1) ); assert_eq!(Err(ApiError::Unhandled), result_from(-1)); assert_eq!(Err(ApiError::Unhandled), result_from(i32::MIN)); } #[test] fn error_round_trips() { round_trip(Ok(())); round_trip(Err(ApiError::None)); round_trip(Err(ApiError::MissingArgument)); round_trip(Err(ApiError::InvalidArgument)); round_trip(Err(ApiError::Deserialize)); round_trip(Err(ApiError::Read)); round_trip(Err(ApiError::ValueNotFound)); round_trip(Err(ApiError::ContractNotFound)); round_trip(Err(ApiError::GetKey)); round_trip(Err(ApiError::UnexpectedKeyVariant)); round_trip(Err(ApiError::UnexpectedContractRefVariant)); round_trip(Err(ApiError::InvalidPurseName)); round_trip(Err(ApiError::InvalidPurse)); round_trip(Err(ApiError::UpgradeContractAtURef)); round_trip(Err(ApiError::Transfer)); round_trip(Err(ApiError::NoAccessRights)); round_trip(Err(ApiError::CLTypeMismatch)); round_trip(Err(ApiError::EarlyEndOfStream)); round_trip(Err(ApiError::Formatting)); round_trip(Err(ApiError::LeftOverBytes)); round_trip(Err(ApiError::OutOfMemory)); round_trip(Err(ApiError::MaxKeysLimit)); round_trip(Err(ApiError::DuplicateKey)); round_trip(Err(ApiError::PermissionDenied)); round_trip(Err(ApiError::MissingKey)); round_trip(Err(ApiError::ThresholdViolation)); round_trip(Err(ApiError::KeyManagementThreshold)); round_trip(Err(ApiError::DeploymentThreshold)); round_trip(Err(ApiError::InsufficientTotalWeight)); round_trip(Err(ApiError::InvalidSystemContract)); round_trip(Err(ApiError::PurseNotCreated)); round_trip(Err(ApiError::Unhandled)); round_trip(Err(ApiError::BufferTooSmall)); round_trip(Err(ApiError::HostBufferEmpty)); round_trip(Err(ApiError::HostBufferFull)); round_trip(Err(ApiError::AllocLayout)); round_trip(Err(ApiError::ContractHeader(0))); round_trip(Err(ApiError::ContractHeader(u8::MAX))); round_trip(Err(ApiError::Mint(0))); round_trip(Err(ApiError::Mint(u8::MAX))); round_trip(Err(ApiError::ProofOfStake(0))); round_trip(Err(ApiError::ProofOfStake(u8::MAX))); round_trip(Err(ApiError::User(0))); round_trip(Err(ApiError::User(u16::MAX))); } }