lib.rs 3.42 KB
Newer Older
Gav's avatar
Gav committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

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

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

//! Shareable Polkadot types.

#![warn(missing_docs)]

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

23
use runtime_primitives::{generic, AnySignature};
24
use primitives::ed25519;
25

Gav Wood's avatar
Gav Wood committed
26
pub use runtime_primitives::traits::{BlakeTwo256, Hash as HashT, Verify};
27

Gav's avatar
Gav committed
28
29
pub mod parachain;

30
pub use parity_codec::Compact;
31

32
/// An index to a block.
33
/// 32-bits will allow for 136 years of blocks assuming 1 block per second.
34
/// TODO: switch to u32 (https://github.com/paritytech/polkadot/issues/221)
35
36
pub type BlockNumber = u64;

Gav Wood's avatar
Gav Wood committed
37
38
/// Alias to 512-bit hash when used in the context of a signature on the relay chain.
/// Equipped with logic for possibly "unsigned" messages.
39
pub type Signature = AnySignature;
Gav Wood's avatar
Gav Wood committed
40

41
42
/// Alias to an sr25519 or ed25519 key.
pub type AccountId = <Signature as Verify>::Signer;
Gav's avatar
Gav committed
43

Gav Wood's avatar
Gav Wood committed
44
45
/// The type for looking up accounts. We don't expect more than 4 billion of them, but you
/// never know...
Gav Wood's avatar
Gav Wood committed
46
pub type AccountIndex = u32;
Gav Wood's avatar
Gav Wood committed
47

Black3HDF's avatar
Black3HDF committed
48
/// Identifier for a chain. 32-bit should be plenty.
49
pub type ChainId = u32;
Gav's avatar
Gav committed
50
51
52
53

/// A hash of some data used by the relay chain.
pub type Hash = primitives::H256;

Gav Wood's avatar
Gav Wood committed
54
/// Index of a transaction in the relay chain. 32-bit should be plenty.
Gav Wood's avatar
Gav Wood committed
55
pub type Nonce = u64;
Gav Wood's avatar
Gav Wood committed
56

57
58
59
60
61
62
/// Signature with which authorities sign blocks.
pub type SessionSignature = ed25519::Signature;

/// Identity that authorities use.
pub type SessionKey = ed25519::Public;

63
/// The balance of an account.
64
65
66
67
68
69
/// 128-bits (or 38 significant decimal figures) will allow for 10m currency (10^7) at a resolution
/// to all for one second's worth of an annualised 50% reward be paid to a unit holder (10^11 unit
/// denomination), or 10^18 total atomic units, to grow at 50%/year for 51 years (10^9 multiplier)
/// for an eventual total of 10^27 units (27 significant decimal figures).
/// We round denomination to 10^12 (12 sdf), and leave the other redundancy at the upper end so
/// that 32 bits may be multiplied with a balance in 128 bits without worrying about overflow.
Gav Wood's avatar
Gav Wood committed
70
pub type Balance = u128;
Gav Wood's avatar
Gav Wood committed
71

72
73
74
75
/// The aura crypto scheme defined via the keypair type.
#[cfg(feature = "std")]
pub type AuraPair = ed25519::Pair;

76
77
78
/// The Ed25519 pub key of an session that belongs to an Aura authority of the chain.
pub type AuraId = ed25519::Public;

79
80
81
82
83
84
85
/// The Parachain crypto scheme defined via the keypair type.
#[cfg(feature = "std")]
pub type ParachainPair = ed25519::Pair;

/// The Ed25519 public key used to authenticate signatures on parachain data.
pub type ParachainPublic = ed25519::Public;

86
/// Header type.
87
pub type Header = generic::Header<BlockNumber, BlakeTwo256>;
88
89
90
/// Block type.
pub type Block = generic::Block<Header, UncheckedExtrinsic>;
/// Block ID.
Gav Wood's avatar
Gav Wood committed
91
92
pub type BlockId = generic::BlockId<Block>;

93
/// Opaque, encoded, unchecked extrinsic.
94
pub use runtime_primitives::OpaqueExtrinsic as UncheckedExtrinsic;