odra-modules 2.9.1

Collection of reusable Odra modules.
Documentation 
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

//! Erc721 standard implementation.
use odra::casper_types::{bytesrepr::Bytes, U256};
use odra::prelude::*;

pub mod erc721_base;
pub mod extensions;
pub mod owned_erc721_with_metadata;

/// The ERC-721 interface as defined in the standard.
pub trait Erc721 {
    /// Returns the amount of tokens owned by `owner`.
    fn balance_of(&self, owner: &Address) -> U256;
    /// Returns the `owner` of the `token_id` token.
    ///
    /// Reverts if token_id does not exist.
    fn owner_of(&self, token_id: &U256) -> Address;
    /// Safely transfers `token_id` token from `from` to `to`, checking the recipient contract uses
    /// [Erc721Receiver](crate::erc721_receiver::Erc721Receiver).
    ///
    /// Emits a [Transfer](crate::erc721::events::Transfer) event.
    fn safe_transfer_from(&mut self, from: &Address, to: &Address, token_id: &U256);
    /// Safely transfers `token_id` token from `from` to `to`, checking the recipient contract uses
    /// [Erc721Receiver](crate::erc721_receiver::Erc721Receiver), passes additional data.
    ///
    /// Emits a [Transfer](crate::erc721::events::Transfer) event.
    fn safe_transfer_from_with_data(
        &mut self,
        from: &Address,
        to: &Address,
        token_id: &U256,
        data: &Bytes
    );
    /// Transfers a specific NFT `tokenId` from one account `from` to another `to`.
    fn transfer_from(&mut self, from: &Address, to: &Address, token_id: &U256);
    /// Grants permission to `approved` to transfer `token_id` token. The approval is cleared when the token is transferred.
    ///
    /// Only a single account can be approved at a time, so approving None clears the previous approval.
    fn approve(&mut self, approved: &Option<Address>, token_id: &U256);
    /// Approves or removes operator for the caller. Operators can call `transfer_from` or `safe_transfer_from` for all
    /// tokens owned by the caller.
    ///
    /// The operator cannot be the caller.
    ///
    /// Emits a [ApprovalForAll](crate::erc721::events::ApprovalForAll) event.
    fn set_approval_for_all(&mut self, operator: &Address, approved: bool);
    /// Returns the address approved for `token_id` token.
    ///
    /// Reverts if token_id does not exist.
    fn get_approved(&self, token_id: &U256) -> Option<Address>;
    /// Returns if the `operator` is allowed to manage all of the tokens of `owner`.
    fn is_approved_for_all(&self, owner: &Address, operator: &Address) -> bool;
}

/// Erc721-related Odra events.
pub mod events {
    use odra::casper_event_standard;
    use odra::casper_types::U256;
    use odra::prelude::*;

    /// Emitted when the `token_id` token is transferred (also minted or burned).
    #[odra::event]
    pub struct Transfer {
        /// The address of the sender.
        pub from: Option<Address>,
        /// The address of the receiver.
        pub to: Option<Address>,
        /// The token id.
        pub token_id: U256
    }

    /// Emitted when the `owner` approves `approved` to operate on the `token_id` token.
    #[odra::event]
    pub struct Approval {
        /// The owner of the tokens.
        pub owner: Address,
        /// The operator that is approved.
        pub approved: Option<Address>,
        /// The token id.
        pub token_id: U256
    }

    /// Emitted when the `owner` approves or revokes `operator`.
    #[odra::event]
    pub struct ApprovalForAll {
        /// The owner of the tokens.
        pub owner: Address,
        /// The operator that is approved or revoked.
        pub operator: Address,
        /// The approval status.
        pub approved: bool
    }
}

/// Erc721-related Odra errors.
pub mod errors {
    use odra::prelude::OdraError;

    /// Possible errors in the context of Erc721 token.
    #[odra::odra_error]
    pub enum Error {
        /// Token is invalid in the given context or does not exist.
        InvalidTokenId = 30_000,
        /// Address in not eligible to operate on the token.
        NotAnOwnerOrApproved = 30_001,
        /// The owner cannot be approved.
        ApprovalToCurrentOwner = 30_002,
        /// The caller cannot approve self.
        ApproveToCaller = 30_003,
        /// Token transfer ends with an error
        TransferFailed = 30_004
    }
}