alloy-erc20 2.0.0

Interact with ERC-20 contracts using Alloy. 
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

use crate::{Token, TokenId};

use super::TokenStore;

/// A view into a single entry in a map, which may either be vacant or occupied.
#[derive(Debug)]
pub enum Entry<'a, S>
where
    S: TokenStore<'a>,
{
    /// An occupied entry.
    Occupied(OccupiedEntry<'a>),

    /// A vacant entry.
    Vacant(VacantEntry<'a, S>),
}

impl<'a, S> Entry<'a, S>
where
    S: TokenStore<'a>,
{
    /// Creates a new [`Entry`].
    pub fn new(chain_id: u64, id: TokenId, store: &'a mut S) -> Self {
        if store.contains(chain_id, id.clone()) {
            Self::Occupied(OccupiedEntry::new(chain_id, id, store))
        } else {
            Self::Vacant(VacantEntry::new(chain_id, id, store))
        }
    }
}

/// A view into an occupied entry in a [`TokenStore`].
///
/// This provides access to the token that is already stored.
#[derive(Debug)]
pub struct OccupiedEntry<'a> {
    value: &'a mut Token,
}

impl<'a> OccupiedEntry<'a> {
    pub fn new<S>(chain_id: u64, id: TokenId, store: &'a mut S) -> Self
    where
        S: TokenStore<'a>,
    {
        Self {
            value: store.get_mut(chain_id, id).unwrap(),
        }
    }

    /// Gets a reference to the value in the entry.
    pub const fn get(&self) -> &Token {
        self.value
    }

    /// Gets a mutable reference to the value in the entry.
    pub const fn get_mut(&mut self) -> &mut Token {
        self.value
    }

    /// Converts the `OccupiedEntry` into a mutable reference to the value in the entry
    /// with a lifetime bound to the map itself.
    pub const fn into_mut(self) -> &'a mut Token {
        self.value
    }
}

/// A view into a vacant entry in a [`TokenStore`].
///
/// This can be used to insert a new token into the store.
#[derive(Debug)]
pub struct VacantEntry<'a, S>
where
    S: TokenStore<'a>,
{
    chain_id: u64,
    id: TokenId,
    store: &'a mut S,
}

impl<'a, S> VacantEntry<'a, S>
where
    S: TokenStore<'a>,
{
    pub const fn new(chain_id: u64, id: TokenId, store: &'a mut S) -> Self {
        Self {
            chain_id,
            id,
            store,
        }
    }

    /// Gets a reference to the [`TokenId`] that would be used when inserting a value
    /// through the [`VacantEntry`].
    pub const fn id(&self) -> &TokenId {
        &self.id
    }

    /// Gets the chain id that would be used when inserting a value through
    /// the [`VacantEntry`]
    pub const fn chain_id(&self) -> u64 {
        self.chain_id
    }

    /// Inserts a token into the vacant entry and returns a mutable reference to it.
    ///
    /// # Arguments
    ///
    /// * `token` - The token to insert into the store
    ///
    /// # Returns
    ///
    /// A mutable reference to the newly inserted token
    pub fn insert(self, token: Token) -> &'a mut Token {
        self.store.insert(self.chain_id, token);
        self.store.get_mut(self.chain_id, self.id.clone()).unwrap()
    }
}