gstd 1.10.0

Gear programs standard library
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

// This file is part of Gear.

// Copyright (C) 2021-2025 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program 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.

// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.

use crate::{ActorId, CodeId, MessageId, util::with_optimized_encode};
use gcore::errors::Result;
use gstd_codegen::wait_create_program_for_reply;
use scale_info::scale::Encode;

/// Same as [`create_program_bytes`](super::create_program_bytes), but allows
/// initialize program with the encodable payload.
#[wait_create_program_for_reply]
pub fn create_program<E: Encode>(
    code_id: CodeId,
    salt: impl AsRef<[u8]>,
    payload: E,
    value: u128,
) -> Result<(MessageId, ActorId)> {
    with_optimized_encode(payload, |buffer| {
        super::create_program_bytes(code_id, salt, buffer, value)
    })
}

/// Same as [`create_program`], but creates a new program after the `delay`
/// expressed in block count.
pub fn create_program_delayed<E: Encode>(
    code_id: CodeId,
    salt: impl AsRef<[u8]>,
    payload: E,
    value: u128,
    delay: u32,
) -> Result<(MessageId, ActorId)> {
    with_optimized_encode(payload, |buffer| {
        super::create_program_bytes_delayed(code_id, salt, buffer, value, delay)
    })
}

/// Same as [`create_program`], but with an explicit gas limit.
#[cfg(not(feature = "ethexe"))]
#[wait_create_program_for_reply]
pub fn create_program_with_gas<E: Encode>(
    code_id: CodeId,
    salt: impl AsRef<[u8]>,
    payload: E,
    gas_limit: u64,
    value: u128,
) -> Result<(MessageId, ActorId)> {
    with_optimized_encode(payload, |buffer| {
        super::create_program_bytes_with_gas(code_id, salt, buffer, gas_limit, value)
    })
}

/// Same as [`create_program_with_gas`], but creates a new program after the
/// `delay` expressed in block count.
#[cfg(not(feature = "ethexe"))]
pub fn create_program_with_gas_delayed<E: Encode>(
    code_id: CodeId,
    salt: impl AsRef<[u8]>,
    payload: E,
    gas_limit: u64,
    value: u128,
    delay: u32,
) -> Result<(MessageId, ActorId)> {
    with_optimized_encode(payload, |buffer| {
        super::create_program_bytes_with_gas_delayed(code_id, salt, buffer, gas_limit, value, delay)
    })
}