lib.rs 3.73 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
23
// 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)]
#![cfg_attr(not(feature = "std"), feature(alloc))]

24
extern crate parity_codec as codec;
Gav's avatar
Gav committed
25
extern crate substrate_primitives as primitives;
26
27
extern crate sr_primitives as runtime_primitives;
extern crate sr_std as rstd;
28
extern crate sr_version;
29
extern crate polkadot_parachain;
30

Gav's avatar
Gav committed
31
32
33
#[cfg(test)]
extern crate substrate_serializer;

34
#[macro_use]
35
extern crate parity_codec_derive;
36

Gav Wood's avatar
Gav Wood committed
37
38
39
40
41
42
43
#[cfg(feature = "std")]
#[macro_use]
extern crate serde_derive;

#[cfg(feature = "std")]
extern crate serde;

44
45
46
#[macro_use]
extern crate substrate_client;

Gav Wood's avatar
Gav Wood committed
47
use rstd::prelude::*;
48
use runtime_primitives::{generic, traits::Extrinsic, AnySignature};
49

Gav Wood's avatar
Gav Wood committed
50
pub use runtime_primitives::traits::{BlakeTwo256, Hash as HashT, Verify};
51
use primitives::ed25519;
52

Gav's avatar
Gav committed
53
54
pub mod parachain;

55
56
pub use codec::Compact;

57
58
#[cfg(feature = "std")]
use primitives::bytes;
59
60

/// An index to a block.
61
62
/// 32-bits will allow for 136 years of blocks assuming 1 block per second.
/// TODO: switch to u32
63
64
pub type BlockNumber = u64;

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

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

Gav Wood's avatar
Gav Wood committed
72
73
/// 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
74
pub type AccountIndex = u32;
Gav Wood's avatar
Gav Wood committed
75

76
77
/// Indentifier for a chain. 32-bit should be plenty.
pub type ChainId = u32;
Gav's avatar
Gav committed
78
79
80
81

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

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

85
86
87
88
89
90
/// Signature with which authorities sign blocks.
pub type SessionSignature = ed25519::Signature;

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

91
/// The balance of an account.
92
93
94
95
96
97
/// 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
98
pub type Balance = u128;
Gav Wood's avatar
Gav Wood committed
99

100
/// Header type.
Gav Wood's avatar
Gav Wood committed
101
pub type Header = generic::Header<BlockNumber, BlakeTwo256, generic::DigestItem<Hash, SessionKey, SessionSignature>>;
102
103
104
/// Block type.
pub type Block = generic::Block<Header, UncheckedExtrinsic>;
/// Block ID.
Gav Wood's avatar
Gav Wood committed
105
106
pub type BlockId = generic::BlockId<Block>;

107
/// Opaque, encoded, unchecked extrinsic.
108
#[derive(PartialEq, Eq, Clone, Default, Encode, Decode)]
Gav Wood's avatar
Gav Wood committed
109
#[cfg_attr(feature = "std", derive(Serialize, Deserialize, Debug))]
110
pub struct UncheckedExtrinsic(#[cfg_attr(feature = "std", serde(with="bytes"))] pub Vec<u8>);
111

112
impl Extrinsic for UncheckedExtrinsic {}