gsigner 2.0.0

Universal cryptographic signer supporting secp256k1 (Ethereum), ed25519, and sr25519 (Substrate)
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
136
137
138
139
140
141
142
143
144
145

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

//! Universal cryptographic signer library supporting multiple signature schemes.
//!
//! This crate provides a unified interface for cryptographic signing operations
//! supporting secp256k1 (Ethereum), ed25519, and sr25519 (Substrate) signature schemes.
//!
//! # Features
//!
//! - `secp256k1` - Enable Ethereum/secp256k1 ECDSA support (enabled by default)
//! - `sr25519` - Enable Substrate/sr25519 Schnorrkel support (enabled by default)
//! - `ed25519` - Enable Substrate-compatible ed25519 support (enabled by default)
//! - `cli` - Enable command-line interface tools
//! - `codec` - Enable parity-scale-codec support for serialization
//! - `keyring` - Keyring support with primary key management
//! - `gprimitives` - Enable gprimitives integration (for ActorId conversions)
//! - `alloy-primitives` - Enable alloy-primitives integration
//! - `sp-core` - Enable sp-core integration (Substrate compatibility)
//! - `sp-runtime` - Enable sp-runtime integration (Substrate compatibility)
//!
//! # Examples
//!
//! ```rust,ignore
//! use gsigner::secp256k1;
//!
//! // Create an in-memory signer
//! let signer = secp256k1::Signer::memory();
//!
//! // Generate a new key
//! let public_key = signer.generate()?;
//!
//! // Sign some data
//! let signature = signer.sign(public_key, b"hello world")?;
//! ```

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

extern crate alloc;

pub mod address;

pub mod error;
pub mod ext;
#[cfg(feature = "secp256k1")]
pub mod hash;
#[cfg(feature = "peer-id")]
pub mod peer_id;
#[cfg(feature = "peer-id")]
pub use peer_id::ToPeerId;
pub mod scheme;
pub mod schemes;
#[cfg(all(feature = "std", feature = "keyring", feature = "serde"))]
pub mod signer;
pub mod utils;

#[cfg(feature = "cli")]
pub mod cli;

#[cfg(feature = "keyring")]
pub mod keyring;
#[cfg(feature = "keyring")]
pub use keyring::{KeyCodec, Keyring, KeyringScheme, KeystoreEntry, SubstrateKeystore};

#[cfg(all(feature = "std", feature = "keyring"))]
pub mod storage;

#[cfg(feature = "secp256k1")]
pub use address::Address;
#[cfg(feature = "secp256k1")]
pub use address::FromActorIdError;
#[cfg(any(feature = "sr25519", feature = "ed25519"))]
pub use address::{SubstrateAddress, SubstrateCryptoScheme};
pub use error::{Result, SignerError};
#[cfg(feature = "secp256k1")]
pub use ext::Secp256k1Ext;
#[cfg(any(feature = "sr25519", feature = "ed25519"))]
pub use ext::SubstrateAddressExt;
pub use ext::{PairExt, PublicExt};
pub use scheme::CryptoScheme;
#[cfg(feature = "keyring")]
pub use scheme::KeystoreOps;
#[cfg(all(feature = "std", feature = "keyring", feature = "serde"))]
pub use signer::Signer;
#[cfg(all(feature = "std", feature = "keyring"))]
pub use storage::{FilesystemBackend, MemoryBackend, StorageBackend, StorageError, StorageResult};

#[cfg(feature = "secp256k1")]
pub use schemes::secp256k1::{
    ContractSignature, Digest, PrivateKey, PublicKey, Signature, SignedData, SignedMessage,
    ToDigest, VerifiedData,
};

#[cfg(feature = "ed25519")]
pub use schemes::ed25519::Ed25519;

#[cfg(feature = "secp256k1")]
pub mod secp256k1 {
    //! Ergonomic re-exports for the secp256k1 scheme.

    pub use crate::schemes::secp256k1::*;
    #[cfg(all(feature = "std", feature = "keyring", feature = "serde"))]
    pub type Signer = crate::Signer<Secp256k1>;
}

#[cfg(feature = "sr25519")]
pub mod sr25519 {
    //! Ergonomic re-exports for the sr25519 scheme.

    pub use crate::schemes::sr25519::*;
    #[cfg(all(feature = "std", feature = "keyring", feature = "serde"))]
    pub type Signer = crate::Signer<Sr25519>;
}

#[cfg(feature = "ed25519")]
pub mod ed25519 {
    //! Ergonomic re-exports for the ed25519 scheme.

    pub use crate::schemes::ed25519::*;
    #[cfg(all(feature = "std", feature = "keyring", feature = "serde"))]
    pub type Signer = crate::Signer<Ed25519>;
}

/// Re-export commonly used types
pub mod prelude {
    pub use crate::{scheme::CryptoScheme, schemes};

    #[cfg(feature = "secp256k1")]
    pub use crate::Address;

    #[cfg(any(feature = "secp256k1", feature = "sr25519", feature = "ed25519"))]
    pub use crate::schemes::SchemeType;

    #[cfg(all(feature = "std", feature = "keyring", feature = "serde"))]
    pub use crate::Signer;

    #[cfg(feature = "secp256k1")]
    pub use crate::schemes::secp256k1::Secp256k1;

    #[cfg(feature = "sr25519")]
    pub use crate::schemes::sr25519::Sr25519;

    #[cfg(feature = "ed25519")]
    pub use crate::schemes::ed25519::Ed25519;
}