gsdk 1.10.0

Rust SDK of the Gear network
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

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

//! GSdk Results

use std::borrow::Borrow;

pub use crate::tx_status::{TxError, TxStatusExt, TxSuccess};

use gear_core::ids::ActorId;
use subxt::{
    error::DispatchError,
    ext::{scale_encode, subxt_rpcs},
};

/// Custom Result
pub type Result<T, E = Error> = std::result::Result<T, E>;

#[derive(Debug, thiserror::Error, derive_more::Unwrap)]
pub enum Error {
    #[error("the queried event not found")]
    EventNotFound,

    #[error("the queried storage entry not found")]
    StorageEntryNotFound,

    #[error("subscription has been died")]
    SubscriptionDied,

    #[error("program has been terminated")]
    ProgramTerminated,

    #[error("{0} is invalid")]
    InvalidPage(FailedPage),

    #[error("{0} was not found in the storage")]
    PageNotFound(FailedPage),

    #[error(transparent)]
    Tx(#[from] TxError),

    #[error("failed to parse URL: {0}")]
    InvalidUrl(#[from] url::ParseError),

    #[error(transparent)]
    ClientError(#[from] jsonrpsee::core::ClientError),

    #[error(transparent)]
    Subxt(Box<subxt::Error>),

    #[error(transparent)]
    Codec(#[from] subxt::ext::codec::Error),

    #[error(transparent)]
    SubxtRpc(#[from] subxt_rpcs::Error),

    #[error(transparent)]
    SecretString(#[from] sp_core::crypto::SecretStringError),

    #[error(transparent)]
    ScaleEncode(#[from] scale_encode::Error),

    #[error(transparent)]
    Crypto(#[from] sp_core::crypto::PublicError),

    #[error(transparent)]
    Metadata(#[from] subxt::error::MetadataError),

    #[error("runtime error: {0:?}")]
    Runtime(crate::RuntimeError),
}

#[derive(Debug, Clone, PartialEq, Eq, Hash, derive_more::Display)]
#[display("Page {index} of Program {program}")]
pub struct FailedPage {
    pub index: u32,
    pub program: ActorId,
}

impl FailedPage {
    pub fn new(index: u32, program: ActorId) -> Self {
        Self { index, program }
    }

    pub fn invalid(self) -> Error {
        Error::InvalidPage(self)
    }

    pub fn not_found(self) -> Error {
        Error::PageNotFound(self)
    }
}

impl From<crate::RuntimeError> for Error {
    fn from(error: crate::RuntimeError) -> Self {
        Self::Runtime(error)
    }
}

fn from_subxt_error<E: Borrow<subxt::Error> + Into<Box<subxt::Error>>>(error: E) -> Error {
    if let subxt::Error::Runtime(DispatchError::Module(err)) = error.borrow()
        && let Ok(runtime_error) = err.as_root_error()
    {
        Error::Runtime(runtime_error)
    } else {
        Error::Subxt(error.into())
    }
}

impl From<Box<subxt::Error>> for Error {
    fn from(error: Box<subxt::Error>) -> Self {
        from_subxt_error(error)
    }
}

impl From<subxt::Error> for Error {
    fn from(error: subxt::Error) -> Self {
        from_subxt_error(error)
    }
}