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
// This file is part of Astar.

// Copyright (C) Stake Technologies Pte.Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later

// Astar is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Astar is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Astar. If not, see <http://www.gnu.org/licenses/>.

// Copyright 2019-2022 PureStake Inc.
// Copyright 2022      Stake Technologies
// This file is part of AssetsERC20 package, originally developed by Purestake Inc.
// AssetsERC20 package used in Astar Network in terms of GPLv3.
//
// AssetsERC20 is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// AssetsERC20 is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with AssetsERC20.  If not, see <http://www.gnu.org/licenses/>.

#![cfg_attr(not(feature = "std"), no_std)]

use fp_evm::{ExitError, PrecompileHandle};
use frame_support::{
    dispatch::{GetDispatchInfo, PostDispatchInfo},
    traits::{
        fungibles::{
            approvals::Inspect as ApprovalInspect, metadata::Inspect as MetadataInspect, Inspect,
        },
        OriginTrait,
    },
    DefaultNoBound,
};
use pallet_evm::AddressMapping;
use precompile_utils::prelude::*;
use sp_runtime::traits::{Bounded, Dispatchable, StaticLookup};

use sp_core::{Get, MaxEncodedLen, H160, U256};
use sp_std::{
    convert::{TryFrom, TryInto},
    marker::PhantomData,
};

#[cfg(test)]
mod mock;
#[cfg(test)]
mod tests;

/// Solidity selector of the Transfer log, which is the Keccak of the Log signature.
pub const SELECTOR_LOG_TRANSFER: [u8; 32] = keccak256!("Transfer(address,address,uint256)");

/// Solidity selector of the Approval log, which is the Keccak of the Log signature.
pub const SELECTOR_LOG_APPROVAL: [u8; 32] = keccak256!("Approval(address,address,uint256)");

/// Alias for the Balance type for the provided Runtime and Instance.
pub type BalanceOf<Runtime, Instance = ()> = <Runtime as pallet_assets::Config<Instance>>::Balance;

/// Alias for the Asset Id type for the provided Runtime and Instance.
pub type AssetIdOf<Runtime, Instance = ()> = <Runtime as pallet_assets::Config<Instance>>::AssetId;

/// This trait ensure we can convert EVM address to AssetIds
/// We will require Runtime to have this trait implemented
pub trait AddressToAssetId<AssetId> {
    // Get assetId from address
    fn address_to_asset_id(address: H160) -> Option<AssetId>;

    // Get address from AssetId
    fn asset_id_to_address(asset_id: AssetId) -> H160;
}

/// The following distribution has been decided for the precompiles
/// 0-1023: Ethereum Mainnet Precompiles
/// 1024-2047 Precompiles that are not in Ethereum Mainnet but are neither Astar specific
/// 2048-4095 Astar specific precompiles
/// Asset precompiles can only fall between
///     0xFFFFFFFF00000000000000000000000000000000 - 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
/// The precompile for AssetId X, where X is a u128 (i.e.16 bytes), if 0XFFFFFFFF + Bytes(AssetId)
/// In order to route the address to Erc20AssetsPrecompile<R>, we first check whether the AssetId
/// exists in pallet-assets
/// We cannot do this right now, so instead we check whether the total supply is zero. If so, we
/// do not route to the precompiles

/// This means that every address that starts with 0xFFFFFFFF will go through an additional db read,
/// but the probability for this to happen is 2^-32 for random addresses
#[derive(Clone, DefaultNoBound)]
pub struct Erc20AssetsPrecompileSet<Runtime, Instance: 'static = ()>(
    PhantomData<(Runtime, Instance)>,
);

impl<Runtime, Instance> Erc20AssetsPrecompileSet<Runtime, Instance> {
    pub fn new() -> Self {
        Self(PhantomData)
    }
}

#[precompile_utils::precompile]
#[precompile::precompile_set]
#[precompile::test_concrete_types(mock::Runtime, ())]
impl<Runtime, Instance> Erc20AssetsPrecompileSet<Runtime, Instance>
where
    Instance: 'static,
    Runtime: pallet_assets::Config<Instance> + pallet_evm::Config + frame_system::Config,
    Runtime::RuntimeCall: Dispatchable<PostInfo = PostDispatchInfo> + GetDispatchInfo,
    Runtime::RuntimeCall: From<pallet_assets::Call<Runtime, Instance>>,
    <Runtime::RuntimeCall as Dispatchable>::RuntimeOrigin: From<Option<Runtime::AccountId>>,
    BalanceOf<Runtime, Instance>: TryFrom<U256> + Into<U256> + solidity::Codec,
    Runtime: AddressToAssetId<AssetIdOf<Runtime, Instance>>,
    <<Runtime as frame_system::Config>::RuntimeCall as Dispatchable>::RuntimeOrigin: OriginTrait,
    AssetIdOf<Runtime, Instance>: Copy,
{
    /// PrecompileSet discriminant. Allows to knows if the address maps to an asset id,
    /// and if this is the case which one.
    #[precompile::discriminant]
    fn discriminant(address: H160, gas: u64) -> DiscriminantResult<AssetIdOf<Runtime, Instance>> {
        let extra_cost = RuntimeHelper::<Runtime>::db_read_gas_cost();
        if gas < extra_cost {
            return DiscriminantResult::OutOfGas;
        }

        let asset_id = match Runtime::address_to_asset_id(address) {
            Some(asset_id) => asset_id,
            None => return DiscriminantResult::None(extra_cost),
        };

        if pallet_assets::Pallet::<Runtime, Instance>::maybe_total_supply(asset_id).is_some() {
            DiscriminantResult::Some(asset_id, extra_cost)
        } else {
            DiscriminantResult::None(extra_cost)
        }
    }

    #[precompile::public("totalSupply()")]
    #[precompile::view]
    fn total_supply(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
    ) -> EvmResult<U256> {
        // TODO: benchmark this function so we can measure ref time & PoV correctly
        // Storage item: Asset:
        // Blake2_128(16) + AssetId(16) + AssetDetails((4 * AccountId(32)) + (3 * Balance(16)) + 15)
        handle.record_db_read::<Runtime>(223)?;

        Ok(pallet_assets::Pallet::<Runtime, Instance>::total_issuance(asset_id).into())
    }

    #[precompile::public("balanceOf(address)")]
    #[precompile::view]
    fn balance_of(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        who: Address,
    ) -> EvmResult<U256> {
        // TODO: benchmark this function so we can measure ref time & PoV correctly
        // Storage item: Account:
        // Blake2_128(16) + AssetId(16) + Blake2_128(16) + AccountId(32) + AssetAccount(19 + Extra)
        handle.record_db_read::<Runtime>(
            99 + <Runtime as pallet_assets::Config<Instance>>::Extra::max_encoded_len(),
        )?;

        let who: H160 = who.into();

        // Fetch info.
        let amount: U256 = {
            let who: Runtime::AccountId = Runtime::AddressMapping::into_account_id(who);
            pallet_assets::Pallet::<Runtime, Instance>::balance(asset_id, &who).into()
        };

        // Build output.
        Ok(amount)
    }

    #[precompile::public("allowance(address,address)")]
    #[precompile::view]
    fn allowance(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        owner: Address,
        spender: Address,
    ) -> EvmResult<U256> {
        // TODO: benchmark this function so we can measure ref time & PoV correctly
        // Storage item: Approvals:
        // Blake2_128(16) + AssetId(16) + (2 * Blake2_128(16) + AccountId(32)) + Approval(32)
        handle.record_db_read::<Runtime>(148)?;

        let owner: H160 = owner.into();
        let spender: H160 = spender.into();

        // Fetch info.
        let amount: U256 = {
            let owner: Runtime::AccountId = Runtime::AddressMapping::into_account_id(owner);
            let spender: Runtime::AccountId = Runtime::AddressMapping::into_account_id(spender);

            // Fetch info.
            pallet_assets::Pallet::<Runtime, Instance>::allowance(asset_id, &owner, &spender).into()
        };

        // Build output.
        Ok(amount)
    }

    #[precompile::public("approve(address,uint256)")]
    fn approve(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        spender: Address,
        value: U256,
    ) -> EvmResult<bool> {
        handle.record_log_costs_manual(3, 32)?;

        let spender: H160 = spender.into();

        Self::approve_inner(asset_id, handle, handle.context().caller, spender, value)?;

        log3(
            handle.context().address,
            SELECTOR_LOG_APPROVAL,
            handle.context().caller,
            spender,
            solidity::encode_event_data(value),
        )
        .record(handle)?;

        // Build output.
        Ok(true)
    }

    fn approve_inner(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        owner: H160,
        spender: H160,
        value: U256,
    ) -> EvmResult {
        let owner = Runtime::AddressMapping::into_account_id(owner);
        let spender: Runtime::AccountId = Runtime::AddressMapping::into_account_id(spender);
        // Amount saturate if too high.
        let amount: BalanceOf<Runtime, Instance> =
            value.try_into().unwrap_or_else(|_| Bounded::max_value());

        // Storage item: Approvals:
        // Blake2_128(16) + AssetId(16) + (2 * Blake2_128(16) + AccountId(32)) + Approval(32)
        handle.record_db_read::<Runtime>(148)?;

        // If previous approval exists, we need to clean it
        if pallet_assets::Pallet::<Runtime, Instance>::allowance(asset_id, &owner, &spender)
            != 0u32.into()
        {
            RuntimeHelper::<Runtime>::try_dispatch(
                handle,
                Some(owner.clone()).into(),
                pallet_assets::Call::<Runtime, Instance>::cancel_approval {
                    id: asset_id.into(),
                    delegate: Runtime::Lookup::unlookup(spender.clone()),
                },
            )?;
        }
        // Dispatch call (if enough gas).
        RuntimeHelper::<Runtime>::try_dispatch(
            handle,
            Some(owner).into(),
            pallet_assets::Call::<Runtime, Instance>::approve_transfer {
                id: asset_id.into(),
                delegate: Runtime::Lookup::unlookup(spender),
                amount,
            },
        )?;

        Ok(())
    }

    #[precompile::public("transfer(address,uint256)")]
    fn transfer(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        to: Address,
        value: U256,
    ) -> EvmResult<bool> {
        handle.record_log_costs_manual(3, 32)?;

        let to: H160 = to.into();
        let value = Self::u256_to_amount(value).in_field("value")?;

        // Build call with origin.
        {
            let origin = Runtime::AddressMapping::into_account_id(handle.context().caller);
            let to = Runtime::AddressMapping::into_account_id(to);

            // Dispatch call (if enough gas).
            RuntimeHelper::<Runtime>::try_dispatch(
                handle,
                Some(origin).into(),
                pallet_assets::Call::<Runtime, Instance>::transfer {
                    id: asset_id.into(),
                    target: Runtime::Lookup::unlookup(to),
                    amount: value,
                },
            )?;
        }

        log3(
            handle.context().address,
            SELECTOR_LOG_TRANSFER,
            handle.context().caller,
            to,
            solidity::encode_event_data(value),
        )
        .record(handle)?;

        Ok(true)
    }

    #[precompile::public("transferFrom(address,address,uint256)")]
    fn transfer_from(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        from: Address,
        to: Address,
        value: U256,
    ) -> EvmResult<bool> {
        handle.record_log_costs_manual(3, 32)?;

        let from: H160 = from.into();
        let to: H160 = to.into();
        let value = Self::u256_to_amount(value).in_field("value")?;

        {
            let caller: Runtime::AccountId =
                Runtime::AddressMapping::into_account_id(handle.context().caller);
            let from: Runtime::AccountId = Runtime::AddressMapping::into_account_id(from.clone());
            let to: Runtime::AccountId = Runtime::AddressMapping::into_account_id(to);

            // If caller is "from", it can spend as much as it wants from its own balance.
            if caller != from {
                // Dispatch call (if enough gas).
                RuntimeHelper::<Runtime>::try_dispatch(
                    handle,
                    Some(caller).into(),
                    pallet_assets::Call::<Runtime, Instance>::transfer_approved {
                        id: asset_id.into(),
                        owner: Runtime::Lookup::unlookup(from),
                        destination: Runtime::Lookup::unlookup(to),
                        amount: value,
                    },
                )?;
            } else {
                // Dispatch call (if enough gas).
                RuntimeHelper::<Runtime>::try_dispatch(
                    handle,
                    Some(from).into(),
                    pallet_assets::Call::<Runtime, Instance>::transfer {
                        id: asset_id.into(),
                        target: Runtime::Lookup::unlookup(to),
                        amount: value,
                    },
                )?;
            }
        }

        log3(
            handle.context().address,
            SELECTOR_LOG_TRANSFER,
            from,
            to,
            solidity::encode_event_data(value),
        )
        .record(handle)?;

        // Build output.
        Ok(true)
    }

    #[precompile::public("name()")]
    #[precompile::view]
    fn name(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
    ) -> EvmResult<UnboundedBytes> {
        // Storage item: Metadata:
        // Blake2_128(16) + AssetId(16) + AssetMetadata[deposit(16) + name(StringLimit)
        // + symbol(StringLimit) + decimals(1) + is_frozen(1)]
        handle.record_db_read::<Runtime>(
            50 + (2 * <Runtime as pallet_assets::Config<Instance>>::StringLimit::get()) as usize,
        )?;

        let name = pallet_assets::Pallet::<Runtime, Instance>::name(asset_id)
            .as_slice()
            .into();

        Ok(name)
    }

    #[precompile::public("symbol()")]
    #[precompile::view]
    fn symbol(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
    ) -> EvmResult<UnboundedBytes> {
        // Storage item: Metadata:
        // Blake2_128(16) + AssetId(16) + AssetMetadata[deposit(16) + name(StringLimit)
        // + symbol(StringLimit) + decimals(1) + is_frozen(1)]
        handle.record_db_read::<Runtime>(
            50 + (2 * <Runtime as pallet_assets::Config<Instance>>::StringLimit::get()) as usize,
        )?;

        let symbol = pallet_assets::Pallet::<Runtime, Instance>::symbol(asset_id)
            .as_slice()
            .into();

        Ok(symbol)
    }

    #[precompile::public("decimals()")]
    #[precompile::view]
    fn decimals(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
    ) -> EvmResult<u8> {
        // Storage item: Metadata:
        // Blake2_128(16) + AssetId(16) + AssetMetadata[deposit(16) + name(StringLimit)
        // + symbol(StringLimit) + decimals(1) + is_frozen(1)]
        handle.record_db_read::<Runtime>(
            50 + (2 * <Runtime as pallet_assets::Config<Instance>>::StringLimit::get()) as usize,
        )?;

        Ok(pallet_assets::Pallet::<Runtime, Instance>::decimals(
            asset_id,
        ))
    }

    #[precompile::public("minimumBalance()")]
    #[precompile::view]
    fn minimum_balance(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
    ) -> EvmResult<U256> {
        // TODO: benchmark this function so we can measure ref time & PoV correctly
        // Storage item: AssetDetails:
        // Blake2_128(16) + AssetDetails((4 * AccountId(32)) + (3 * Balance(16)) + 15)
        handle.record_db_read::<Runtime>(207)?;

        Ok(pallet_assets::Pallet::<Runtime, Instance>::minimum_balance(asset_id).into())
    }

    #[precompile::public("mint(address,uint256)")]
    fn mint(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        to: Address,
        value: U256,
    ) -> EvmResult<bool> {
        handle.record_log_costs_manual(3, 32)?;

        let to: H160 = to.into();
        let value = Self::u256_to_amount(value).in_field("value")?;

        // Build call with origin.
        {
            let origin = Runtime::AddressMapping::into_account_id(handle.context().caller);
            let to = Runtime::AddressMapping::into_account_id(to);

            // Dispatch call (if enough gas).
            RuntimeHelper::<Runtime>::try_dispatch(
                handle,
                Some(origin).into(),
                pallet_assets::Call::<Runtime, Instance>::mint {
                    id: asset_id.into(),
                    beneficiary: Runtime::Lookup::unlookup(to),
                    amount: value,
                },
            )?;
        }

        log3(
            handle.context().address,
            SELECTOR_LOG_TRANSFER,
            H160::default(),
            to,
            solidity::encode_event_data(value),
        )
        .record(handle)?;

        Ok(true)
    }

    #[precompile::public("burn(address,uint256)")]
    fn burn(
        asset_id: AssetIdOf<Runtime, Instance>,
        handle: &mut impl PrecompileHandle,
        from: Address,
        value: U256,
    ) -> EvmResult<bool> {
        handle.record_log_costs_manual(3, 32)?;

        let from: H160 = from.into();
        let value = Self::u256_to_amount(value).in_field("value")?;

        // Build call with origin.
        {
            let origin = Runtime::AddressMapping::into_account_id(handle.context().caller);
            let from = Runtime::AddressMapping::into_account_id(from);

            // Dispatch call (if enough gas).
            RuntimeHelper::<Runtime>::try_dispatch(
                handle,
                Some(origin).into(),
                pallet_assets::Call::<Runtime, Instance>::burn {
                    id: asset_id.into(),
                    who: Runtime::Lookup::unlookup(from),
                    amount: value,
                },
            )?;
        }

        log3(
            handle.context().address,
            SELECTOR_LOG_TRANSFER,
            from,
            H160::default(),
            solidity::encode_event_data(value),
        )
        .record(handle)?;

        Ok(true)
    }

    fn u256_to_amount(value: U256) -> MayRevert<BalanceOf<Runtime, Instance>> {
        value
            .try_into()
            .map_err(|_| RevertReason::value_is_too_large("balance type").into())
    }
}