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
use dharitri_codec::{TopDecode, TopEncode};

use super::{BigIntApi, BigUintApi, EllipticCurveApi, ErrorApi, StorageReadApi, StorageWriteApi};
use crate::{
    types::{Address, ArgBuffer, AsyncCall, BoxedBytes, CodeMetadata, TokenIdentifier, Vec},
    HexCallDataSerializer,
};

pub const DCT_TRANSFER_STRING: &[u8] = b"DCTTransfer";
pub const DCT_NFT_TRANSFER_STRING: &[u8] = b"DCTNFTTransfer";

const PERCENTAGE_TOTAL: u64 = 10_000;

/// API that groups methods that either send MOAX or DCT, or that call other contracts.
pub trait SendApi: ErrorApi + Clone + Sized {
    /// The type of the payment arguments.
    /// Not named `BigUint` to avoid name collisions in types that implement multiple API traits.
    type AmountType: BigUintApi + 'static;

    /// Not used by `SendApi`, but forwarded to the proxy traits.
    type ProxyBigInt: BigIntApi + 'static;

    type ProxyEllipticCurve: EllipticCurveApi<BigUint = Self::AmountType> + 'static;

    /// Not used by `SendApi`, but forwarded to the proxy traits.
    type ProxyStorage: StorageReadApi + StorageWriteApi + ErrorApi + Clone + 'static;

    /// Required for DCTNFTTransfer.
    /// Same as the implementation from BlockchainApi.
    fn get_sc_address(&self) -> Address;

    /// To be used internally by the SendApi implementation.
    /// Do not use directly from contracts. It might be removed from this trait at some point or reworked.
    fn get_gas_left(&self) -> u64;

    /// Used internally for sell_nft.
    /// Do not use directly from contracts.
    fn get_dct_token_data(
        &self,
        address: &Address,
        token: &TokenIdentifier,
        nonce: u64,
    ) -> crate::types::DctTokenData<Self::AmountType>;

    /// Sends MOAX to a given address, directly.
    /// Used especially for sending MOAX to regular accounts.
    fn direct_moax(&self, to: &Address, amount: &Self::AmountType, data: &[u8]);

    /// Sends MOAX to an address (optionally) and executes like an async call, but without callback.
    fn direct_moax_execute(
        &self,
        to: &Address,
        amount: &Self::AmountType,
        gas_limit: u64,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    ) -> Result<(), &'static [u8]>;

    /// Sends DCT to an address and executes like an async call, but without callback.
    fn direct_dct_execute(
        &self,
        to: &Address,
        token: &TokenIdentifier,
        amount: &Self::AmountType,
        gas_limit: u64,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    ) -> Result<(), &'static [u8]>;

    /// Sends DCT NFT to an address and executes like an async call, but without callback.
    #[allow(clippy::too_many_arguments)]
    fn direct_dct_nft_execute(
        &self,
        to: &Address,
        token: &TokenIdentifier,
        nonce: u64,
        amount: &Self::AmountType,
        gas_limit: u64,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    ) -> Result<(), &'static [u8]>;

    /// Sends either MOAX, DCT or NFT to the target address,
    /// depending on the token identifier and nonce
    fn direct(
        &self,
        to: &Address,
        token: &TokenIdentifier,
        nonce: u64,
        amount: &Self::AmountType,
        data: &[u8],
    ) {
        if token.is_moax() {
            self.direct_moax(to, amount, data);
        } else if nonce == 0 {
            let _ = self.direct_dct_execute(to, token, amount, 0, data, &ArgBuffer::new());
        } else {
            let _ =
                self.direct_dct_nft_execute(to, token, nonce, amount, 0, data, &ArgBuffer::new());
        }
    }

    /// Sends an asynchronous call to another contract.
    /// Calling this method immediately terminates tx execution.
    /// Using it directly is generally discouraged.
    ///
    /// The data is expected to be of the form `functionName@<arg1-hex>@<arg2-hex>@...`.
    /// Use a `HexCallDataSerializer` to prepare this field.
    fn async_call_raw(&self, to: &Address, amount: &Self::AmountType, data: &[u8]) -> !;

    /// Sends an asynchronous call to another contract, with either MOAX or DCT value.
    /// The `token` argument decides which one it will be.
    /// Calling this method immediately terminates tx execution.
    fn async_call(&self, async_call: AsyncCall<Self>) -> ! {
        self.async_call_raw(
            &async_call.to,
            &async_call.moax_payment,
            async_call.hex_data.as_slice(),
        )
    }

    /// Performs a simple DCT/NFT transfer, but via async call.  
    /// As with any async call, this immediately terminates the execution of the current call.  
    /// So only use as the last call in your endpoint.  
    /// If you want to perform multiple transfers, use `self.send().direct()` instead.  
    /// Note that MOAX can NOT be transfered with this function.  
    fn transfer_dct_via_async_call(
        &self,
        to: &Address,
        token: &TokenIdentifier,
        nonce: u64,
        amount: &Self::AmountType,
        data: &[u8],
    ) -> ! {
        if nonce == 0 {
            let mut serializer = HexCallDataSerializer::new(DCT_TRANSFER_STRING);
            serializer.push_argument_bytes(token.as_dct_identifier());
            serializer.push_argument_bytes(amount.to_bytes_be().as_slice());
            if !data.is_empty() {
                serializer.push_argument_bytes(data);
            }

            self.async_call_raw(to, &Self::AmountType::zero(), serializer.as_slice())
        } else {
            let mut serializer = HexCallDataSerializer::new(DCT_NFT_TRANSFER_STRING);
            serializer.push_argument_bytes(token.as_dct_identifier());
            serializer.push_argument_bytes(&nonce.to_be_bytes()[..]);
            serializer.push_argument_bytes(amount.to_bytes_be().as_slice());
            serializer.push_argument_bytes(to.as_bytes());
            if !data.is_empty() {
                serializer.push_argument_bytes(data);
            }

            self.async_call_raw(
                &self.get_sc_address(),
                &Self::AmountType::zero(),
                serializer.as_slice(),
            );
        }
    }

    /// Deploys a new contract in the same shard.
    /// Unlike `async_call_raw`, the deployment is synchronous and tx execution continues afterwards.
    /// Also unlike `async_call_raw`, it uses an argument buffer to pass arguments
    /// If the deployment fails, Option::None is returned
    fn deploy_contract(
        &self,
        gas: u64,
        amount: &Self::AmountType,
        code: &BoxedBytes,
        code_metadata: CodeMetadata,
        arg_buffer: &ArgBuffer,
    ) -> Option<Address>;

    /// Deploys a new contract in the same shard by re-using the code of an already deployed source contract.
    /// The deployment is done synchronously and the new contract's address is returned.
    /// If the deployment fails, Option::None is returned
    fn deploy_from_source_contract(
        &self,
        gas: u64,
        amount: &Self::AmountType,
        source_contract_address: &Address,
        code_metadata: CodeMetadata,
        arg_buffer: &ArgBuffer,
    ) -> Option<Address>;

    /// Upgrades a child contract of the currently executing contract.
    /// The upgrade is synchronous, and the current transaction will fail if the upgrade fails.
    /// The child contract's new init function will be called with the provided arguments
    fn upgrade_contract(
        &self,
        sc_address: &Address,
        gas: u64,
        amount: &Self::AmountType,
        code: &BoxedBytes,
        code_metadata: CodeMetadata,
        arg_buffer: &ArgBuffer,
    );

    fn change_owner_address(&self, child_sc_address: &Address, new_owner: &Address) {
        let mut arg_buffer = ArgBuffer::new();
        arg_buffer.push_argument_bytes(new_owner.as_bytes());

        let _ = self.execute_on_dest_context_raw(
            self.get_gas_left(),
            child_sc_address,
            &Self::AmountType::zero(),
            b"ChangeOwnerAddress",
            &arg_buffer,
        );
    }

    /// Same shard, in-line execution of another contract.
    fn execute_on_dest_context_raw(
        &self,
        gas: u64,
        address: &Address,
        value: &Self::AmountType,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    ) -> Vec<BoxedBytes>;

    /// Same shard, in-line execution of another contract.
    /// Allows the contract to specify which result range to extract as sync call result.
    /// This is a workaround to handle nested sync calls.
    /// Please do not use this method unless there is absolutely no other option.
    /// Will be eliminated after some future Arwen hook redesign.
    /// `range_closure` takes the number of results before, the number of results after,
    /// and is expected to return the start index (inclusive) and end index (exclusive).
    fn execute_on_dest_context_raw_custom_result_range<F>(
        &self,
        gas: u64,
        address: &Address,
        value: &Self::AmountType,
        function: &[u8],
        arg_buffer: &ArgBuffer,
        range_closure: F,
    ) -> Vec<BoxedBytes>
    where
        F: FnOnce(usize, usize) -> (usize, usize);

    fn execute_on_dest_context_by_caller_raw(
        &self,
        gas: u64,
        address: &Address,
        value: &Self::AmountType,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    ) -> Vec<BoxedBytes>;

    fn execute_on_same_context_raw(
        &self,
        gas: u64,
        address: &Address,
        value: &Self::AmountType,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    );

    /// Used to store data between async call and callback.
    fn storage_store_tx_hash_key(&self, data: &[u8]);

    /// Used to store data between async call and callback.
    fn storage_load_tx_hash_key(&self) -> BoxedBytes;

    /// Allows synchronously calling a local function by name. Execution is resumed afterwards.
    /// You should never have to call this function directly.
    /// Use the other specific methods instead.
    fn call_local_dct_built_in_function(
        &self,
        gas: u64,
        function: &[u8],
        arg_buffer: &ArgBuffer,
    ) -> Vec<BoxedBytes>;

    /// Allows synchronous minting of DCT/SFT (depending on nonce). Execution is resumed afterwards.
    /// Note that the SC must have the DCTLocalMint or DCTNftAddQuantity roles set,
    /// or this will fail with "action is not allowed"
    /// For SFTs, you must use `self.send().dct_nft_create()` before adding additional quantity.
    /// This function cannot be used for NFTs.
    fn dct_local_mint(&self, token: &TokenIdentifier, nonce: u64, amount: &Self::AmountType) {
        let mut arg_buffer = ArgBuffer::new();
        let func_name: &[u8];

        arg_buffer.push_argument_bytes(token.as_dct_identifier());

        if nonce == 0 {
            func_name = b"DCTLocalMint";
        } else {
            func_name = b"DCTNFTAddQuantity";
            arg_buffer.push_argument_bytes(&nonce.to_be_bytes()[..]);
        }

        arg_buffer.push_argument_bytes(amount.to_bytes_be().as_slice());

        let _ = self.call_local_dct_built_in_function(self.get_gas_left(), func_name, &arg_buffer);
    }

    /// Allows synchronous burning of DCT/SFT/NFT (depending on nonce). Execution is resumed afterwards.
    /// Note that the SC must have the DCTLocalBurn or DCTNftBurn roles set,
    /// or this will fail with "action is not allowed"
    fn dct_local_burn(&self, token: &TokenIdentifier, nonce: u64, amount: &Self::AmountType) {
        let mut arg_buffer = ArgBuffer::new();
        let func_name: &[u8];

        arg_buffer.push_argument_bytes(token.as_dct_identifier());

        if nonce == 0 {
            func_name = b"DCTLocalBurn";
        } else {
            func_name = b"DCTNFTBurn";
            arg_buffer.push_argument_bytes(&nonce.to_be_bytes()[..]);
        }

        arg_buffer.push_argument_bytes(amount.to_bytes_be().as_slice());

        let _ = self.call_local_dct_built_in_function(self.get_gas_left(), func_name, &arg_buffer);
    }

    /// Creates a new NFT token of a certain type (determined by `token_identifier`).  
    /// `attributes` can be any serializable custom struct.  
    /// This is a built-in function, so the smart contract execution is resumed after.
    /// Must have DCTNftCreate role set, or this will fail with "action is not allowed".
    /// Returns the nonce of the newly created NFT.
    #[allow(clippy::too_many_arguments)]
    fn dct_nft_create<T: dharitri_codec::TopEncode>(
        &self,
        token: &TokenIdentifier,
        amount: &Self::AmountType,
        name: &BoxedBytes,
        royalties: &Self::AmountType,
        hash: &BoxedBytes,
        attributes: &T,
        uris: &[BoxedBytes],
    ) -> u64 {
        let mut arg_buffer = ArgBuffer::new();
        arg_buffer.push_argument_bytes(token.as_dct_identifier());
        arg_buffer.push_argument_bytes(amount.to_bytes_be().as_slice());
        arg_buffer.push_argument_bytes(name.as_slice());
        arg_buffer.push_argument_bytes(royalties.to_bytes_be().as_slice());
        arg_buffer.push_argument_bytes(hash.as_slice());

        let mut top_encoded_attributes = Vec::new();
        let _ = attributes.top_encode(&mut top_encoded_attributes);
        arg_buffer.push_argument_bytes(top_encoded_attributes.as_slice());

        // The API function has the last argument as variadic,
        // so we top-encode each and send as separate argument
        for uri in uris {
            let mut top_encoded_uri = Vec::new();
            let _ = uri.top_encode(&mut top_encoded_uri);

            arg_buffer.push_argument_bytes(top_encoded_uri.as_slice());
        }

        let output = self.call_local_dct_built_in_function(
            self.get_gas_left(),
            b"DCTNFTCreate",
            &arg_buffer,
        );

        u64::top_decode(output[0].as_slice()).unwrap_or_default()
    }

    /// Sends thr NFTs to the buyer address and calculates and sends the required royalties to the NFT creator.
    /// Returns the payment amount left after sending royalties.
    #[allow(clippy::too_many_arguments)]
    fn sell_nft(
        &self,
        nft_id: &TokenIdentifier,
        nft_nonce: u64,
        nft_amount: &Self::AmountType,
        buyer: &Address,
        payment_token: &TokenIdentifier,
        payment_nonce: u64,
        payment_amount: &Self::AmountType,
    ) -> Self::AmountType {
        let nft_token_data = self.get_dct_token_data(&self.get_sc_address(), nft_id, nft_nonce);
        let royalties_amount =
            payment_amount.clone() * nft_token_data.royalties / PERCENTAGE_TOTAL.into();

        self.direct(buyer, nft_id, nft_nonce, nft_amount, &[]);

        if royalties_amount > 0 {
            self.direct(
                &nft_token_data.creator,
                payment_token,
                payment_nonce,
                &royalties_amount,
                &[],
            );

            payment_amount.clone() - royalties_amount
        } else {
            payment_amount.clone()
        }
    }
}