gsdk 2.0.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

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

//! Gear api with signer

pub use self::{pair_signer::PairSigner, tx_output::TxOutput};

use crate::{Api, backtrace::Backtrace, config::GearConfig, result::Result};
use sp_core::{Pair as PairT, sr25519::Pair};
use sp_keyring::AccountKeyring;
use sp_runtime::AccountId32;
use std::sync::Arc;

mod calls;
mod pair_signer;
mod rpc;
mod storage;
mod tx_output;
mod utils;

pub type Signer = PairSigner<GearConfig, Pair>;

/// Signed Gear API wrapper.
#[derive(derive_more::Debug, Clone, derive_more::Into, derive_more::AsRef, derive_more::Deref)]
pub struct SignedApi {
    #[into]
    #[as_ref]
    #[deref]
    api: Api,

    /// Current signer.
    #[debug("<signer>")]
    signer: Arc<PairSigner<GearConfig, Pair>>,

    nonce: Option<u64>,
    backtrace: Backtrace,
}

impl Api {
    /// Attaches a signer to the API.
    pub fn signed(self, suri: &str, passwd: Option<&str>) -> Result<SignedApi> {
        SignedApi::new(self, suri, passwd)
    }

    /// Constructs an API wrapper signed as a debug account.
    pub fn signed_dev(self, account: AccountKeyring) -> SignedApi {
        SignedApi::with_pair(self, account.pair())
    }

    /// Construct an API wrapper signed as `//Alice` dev account.
    pub fn signed_as_alice(self) -> SignedApi {
        self.signed_dev(AccountKeyring::Alice)
    }
}

impl SignedApi {
    pub fn with_pair(api: Api, pair: Pair) -> Self {
        Self {
            api,
            signer: PairSigner::new(pair).into(),
            nonce: None,
            backtrace: Backtrace::default(),
        }
    }

    /// Constructs new signed API.
    pub fn new(api: Api, suri: &str, passwd: Option<&str>) -> Result<Self> {
        Ok(Self::with_pair(api, Pair::from_string(suri, passwd)?))
    }

    /// Returns a reference to the inner unsigned API wrapper.
    pub fn unsigned(&self) -> &Api {
        &self.api
    }

    /// Returns a reference to the inner signer.
    pub fn signer(&self) -> &Signer {
        &self.signer
    }

    /// Returns the address of the current signer.
    pub fn account_id(&self) -> &AccountId32 {
        self.signer.account_id()
    }

    /// Returns the backtrace of the signed API.
    pub fn backtrace(&self) -> &Backtrace {
        &self.backtrace
    }

    /// Sets nonce of the signer.
    pub fn set_nonce(&mut self, nonce: u64) {
        self.nonce = Some(nonce);
    }
}