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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
use std::cmp::max;
use std::convert::AsRef;
use std::fmt;
use chrono;
use chrono::DateTime;
use rand::distributions::Alphanumeric;
use rand::{thread_rng, Rng};
use serde;
use crate::hash::{hash, CryptoHash};
use crate::receipt::Receipt;
use crate::transaction::SignedTransaction;
use crate::types::{NumSeats, NumShards, ShardId};
use crate::version::{
ProtocolVersion, CORRECT_RANDOM_VALUE_PROTOCOL_VERSION, CREATE_HASH_PROTOCOL_VERSION,
CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION,
};
use unc_crypto::{ED25519PublicKey, Secp256K1PublicKey};
use unc_primitives_core::account::id::{AccountId, AccountType};
use std::mem::size_of;
use std::ops::Deref;
pub mod min_heap;
/// Number of nano seconds in a second.
const NS_IN_SECOND: u64 = 1_000_000_000;
/// A data structure for tagging data as already being validated to prevent
/// redundant work.
///
/// # Example
///
/// ```ignore
/// struct Foo;
/// struct Error;
///
/// /// Performs expensive validation of `foo`.
/// fn validate_foo(foo: &Foo) -> Result<bool, Error>;
///
/// fn do_stuff(foo: Foo) {
/// let foo = MaybeValidated::from(foo);
/// do_stuff_with_foo(&foo);
/// if foo.validate_with(validate_foo) {
/// println!("^_^");
/// }
/// }
///
/// fn do_stuff_with_foo(foo: &MaybeValidated<Foo) {
/// // …
/// if maybe_do_something && foo.validate_with(validate_foo) {
/// println!("@_@");
/// }
/// // …
/// }
/// ```
#[derive(Clone)]
pub struct MaybeValidated<T> {
validated: std::cell::Cell<bool>,
payload: T,
}
impl<T> MaybeValidated<T> {
/// Creates new MaybeValidated object marking payload as validated. No
/// verification is performed; it’s caller’s responsibility to make sure the
/// payload has indeed been validated.
///
/// # Example
///
/// ```
/// use unc_primitives::utils::MaybeValidated;
///
/// let value = MaybeValidated::from_validated(42);
/// assert!(value.is_validated());
/// assert_eq!(Ok(true), value.validate_with::<(), _>(|_| panic!()));
/// ```
pub fn from_validated(payload: T) -> Self {
Self { validated: std::cell::Cell::new(true), payload }
}
/// Validates payload with given `validator` function and returns result of
/// the validation. If payload has already been validated returns
/// `Ok(true)`. Note that this method changes the internal validated flag
/// so it’s probably incorrect to call it with different `validator`
/// functions.
///
/// # Example
///
/// ```
/// use unc_primitives::utils::MaybeValidated;
///
/// let value = MaybeValidated::from(42);
/// assert_eq!(Err(()), value.validate_with(|_| Err(())));
/// assert_eq!(Ok(false), value.validate_with::<(), _>(|v| Ok(*v == 24)));
/// assert!(!value.is_validated());
/// assert_eq!(Ok(true), value.validate_with::<(), _>(|v| Ok(*v == 42)));
/// assert!(value.is_validated());
/// assert_eq!(Ok(true), value.validate_with::<(), _>(|_| panic!()));
/// ```
pub fn validate_with<E, F: FnOnce(&T) -> Result<bool, E>>(
&self,
validator: F,
) -> Result<bool, E> {
if self.validated.get() {
Ok(true)
} else {
let res = validator(&self.payload);
self.validated.set(*res.as_ref().unwrap_or(&false));
res
}
}
/// Marks the payload as valid. No verification is performed; it’s caller’s
/// responsibility to make sure the payload has indeed been validated.
pub fn mark_as_valid(&self) {
self.validated.set(true);
}
/// Applies function to the payload (whether it’s been validated or not) and
/// returns new object with result of the function as payload. Validated
/// state is not changed.
///
/// # Example
///
/// ```
/// use unc_primitives::utils::MaybeValidated;
///
/// let value = MaybeValidated::from(42);
/// assert_eq!("42", value.map(|v| v.to_string()).into_inner());
/// ```
pub fn map<U, F: FnOnce(T) -> U>(self, validator: F) -> MaybeValidated<U> {
MaybeValidated { validated: self.validated, payload: validator(self.payload) }
}
/// Returns a new object storing reference to this object’s payload. Note
/// that the two objects do not share the validated state so calling
/// `validate_with` on one of them does not affect the other.
///
/// # Example
///
/// ```
/// use unc_primitives::utils::MaybeValidated;
///
/// let value = MaybeValidated::from(42);
/// let value_as_ref = value.as_ref();
/// assert_eq!(Ok(true), value_as_ref.validate_with::<(), _>(|&&v| Ok(v == 42)));
/// assert!(value_as_ref.is_validated());
/// assert!(!value.is_validated());
/// ```
pub fn as_ref(&self) -> MaybeValidated<&T> {
MaybeValidated { validated: self.validated.clone(), payload: &self.payload }
}
/// Returns whether the payload has been validated.
pub fn is_validated(&self) -> bool {
self.validated.get()
}
/// Extracts the payload whether or not it’s been validated.
pub fn into_inner(self) -> T {
self.payload
}
/// Returns a reference to the payload
pub fn get_inner(&self) -> &T {
&self.payload
}
}
impl<T> From<T> for MaybeValidated<T> {
/// Creates new MaybeValidated object marking payload as not validated.
fn from(payload: T) -> Self {
Self { validated: std::cell::Cell::new(false), payload }
}
}
impl<T: Sized> Deref for MaybeValidated<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.payload
}
}
pub fn get_block_shard_id(block_hash: &CryptoHash, shard_id: ShardId) -> Vec<u8> {
let mut res = Vec::with_capacity(40);
res.extend_from_slice(block_hash.as_ref());
res.extend_from_slice(&shard_id.to_le_bytes());
res
}
pub fn get_block_shard_id_rev(
key: &[u8],
) -> Result<(CryptoHash, ShardId), Box<dyn std::error::Error + Send + Sync>> {
if key.len() != 40 {
return Err(
std::io::Error::new(std::io::ErrorKind::InvalidInput, "Invalid key length").into()
);
}
let (block_hash_bytes, shard_id_bytes) = key.split_at(32);
let block_hash = CryptoHash::try_from(block_hash_bytes)?;
let shard_id = ShardId::from_le_bytes(shard_id_bytes.try_into()?);
Ok((block_hash, shard_id))
}
pub fn get_outcome_id_block_hash(outcome_id: &CryptoHash, block_hash: &CryptoHash) -> Vec<u8> {
let mut res = Vec::with_capacity(64);
res.extend_from_slice(outcome_id.as_ref());
res.extend_from_slice(block_hash.as_ref());
res
}
pub fn get_outcome_id_block_hash_rev(key: &[u8]) -> std::io::Result<(CryptoHash, CryptoHash)> {
if key.len() != 64 {
return Err(std::io::Error::new(std::io::ErrorKind::InvalidData, "Invalid key length"));
}
let outcome_id = CryptoHash::try_from(&key[..32]).unwrap();
let block_hash = CryptoHash::try_from(&key[32..]).unwrap();
Ok((outcome_id, block_hash))
}
/// Creates a new Receipt ID from a given signed transaction and a block hash.
/// This method is backward compatible, so it takes the current protocol version.
pub fn create_receipt_id_from_transaction(
protocol_version: ProtocolVersion,
signed_transaction: &SignedTransaction,
prev_block_hash: &CryptoHash,
block_hash: &CryptoHash,
) -> CryptoHash {
create_hash_upgradable(
protocol_version,
&signed_transaction.get_hash(),
prev_block_hash,
block_hash,
0,
)
}
/// Creates a new Receipt ID from a given receipt, a block hash and a new receipt index.
/// This method is backward compatible, so it takes the current protocol version.
pub fn create_receipt_id_from_receipt(
protocol_version: ProtocolVersion,
receipt: &Receipt,
prev_block_hash: &CryptoHash,
block_hash: &CryptoHash,
receipt_index: usize,
) -> CryptoHash {
create_hash_upgradable(
protocol_version,
&receipt.receipt_id,
prev_block_hash,
block_hash,
receipt_index as u64,
)
}
/// Creates a new action_hash from a given receipt, a block hash and an action index.
/// This method is backward compatible, so it takes the current protocol version.
pub fn create_action_hash(
protocol_version: ProtocolVersion,
receipt: &Receipt,
prev_block_hash: &CryptoHash,
block_hash: &CryptoHash,
action_index: usize,
) -> CryptoHash {
// Action hash uses the same input as a new receipt ID, so to avoid hash conflicts we use the
// salt starting from the `u64` going backward.
let salt = u64::MAX.wrapping_sub(action_index as u64);
create_hash_upgradable(protocol_version, &receipt.receipt_id, prev_block_hash, block_hash, salt)
}
/// Creates a new `data_id` from a given action hash, a block hash and a data index.
/// This method is backward compatible, so it takes the current protocol version.
pub fn create_data_id(
protocol_version: ProtocolVersion,
action_hash: &CryptoHash,
prev_block_hash: &CryptoHash,
block_hash: &CryptoHash,
data_index: usize,
) -> CryptoHash {
create_hash_upgradable(
protocol_version,
action_hash,
prev_block_hash,
block_hash,
data_index as u64,
)
}
/// Creates a unique random seed to be provided to `VMContext` from a give `action_hash` and
/// a given `random_seed`.
/// This method is backward compatible, so it takes the current protocol version.
pub fn create_random_seed(
protocol_version: ProtocolVersion,
action_hash: CryptoHash,
random_seed: CryptoHash,
) -> Vec<u8> {
let res = if protocol_version < CORRECT_RANDOM_VALUE_PROTOCOL_VERSION {
action_hash
} else if protocol_version < CREATE_HASH_PROTOCOL_VERSION {
random_seed
} else {
// Generates random seed from random_seed and action_hash.
// Since every action hash is unique, the seed will be unique per receipt and even
// per action within a receipt.
const BYTES_LEN: usize = size_of::<CryptoHash>() + size_of::<CryptoHash>();
let mut bytes: Vec<u8> = Vec::with_capacity(BYTES_LEN);
bytes.extend_from_slice(action_hash.as_ref());
bytes.extend_from_slice(random_seed.as_ref());
hash(&bytes)
};
res.as_ref().to_vec()
}
/// Creates a new CryptoHash ID based on the protocol version.
/// Before `CREATE_HASH_PROTOCOL_VERSION` it uses `create_nonce_with_nonce` with
/// just `base` and `salt`. But after `CREATE_HASH_PROTOCOL_VERSION` it uses
/// `extra_hash` in addition to the `base` and `salt`.
/// E.g. this `extra_hash` can be a block hash to distinguish receipts between forks.
fn create_hash_upgradable(
protocol_version: ProtocolVersion,
base: &CryptoHash,
extra_hash_old: &CryptoHash,
extra_hash: &CryptoHash,
salt: u64,
) -> CryptoHash {
if protocol_version < CREATE_HASH_PROTOCOL_VERSION {
create_nonce_with_nonce(base, salt)
} else {
const BYTES_LEN: usize =
size_of::<CryptoHash>() + size_of::<CryptoHash>() + size_of::<u64>();
let mut bytes: Vec<u8> = Vec::with_capacity(BYTES_LEN);
bytes.extend_from_slice(base.as_ref());
let extra_hash_used =
if protocol_version < CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION {
extra_hash_old
} else {
extra_hash
};
bytes.extend_from_slice(extra_hash_used.as_ref());
bytes.extend(index_to_bytes(salt));
hash(&bytes)
}
}
/// Deprecated. Please use `create_hash_upgradable`
fn create_nonce_with_nonce(base: &CryptoHash, salt: u64) -> CryptoHash {
let mut nonce: Vec<u8> = base.as_ref().to_owned();
nonce.extend(index_to_bytes(salt));
hash(&nonce)
}
pub fn index_to_bytes(index: u64) -> [u8; 8] {
index.to_le_bytes()
}
/// A wrapper around Option<T> that provides native Display trait.
/// Simplifies propagating automatic Display trait on parent structs.
pub struct DisplayOption<T>(pub Option<T>);
impl<T: fmt::Display> fmt::Display for DisplayOption<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.0 {
Some(ref v) => write!(f, "Some({})", v),
None => write!(f, "None"),
}
}
}
impl<T> DisplayOption<T> {
pub fn into(self) -> Option<T> {
self.0
}
}
impl<T> AsRef<Option<T>> for DisplayOption<T> {
fn as_ref(&self) -> &Option<T> {
&self.0
}
}
impl<T: fmt::Display> From<Option<T>> for DisplayOption<T> {
fn from(o: Option<T>) -> Self {
DisplayOption(o)
}
}
/// Macro to either return value if the result is Ok, or exit function logging error.
#[macro_export]
macro_rules! unwrap_or_return {
($obj: expr, $ret: expr) => {
match $obj {
Ok(value) => value,
Err(err) => {
tracing::error!(target: "client", "Unwrap error: {}", err);
return $ret;
}
}
};
($obj: expr) => {
match $obj {
Ok(value) => value,
Err(err) => {
tracing::error!(target: "client", "Unwrap error: {}", err);
return;
}
}
};
}
/// Converts timestamp in ns into DateTime UTC time.
pub fn from_timestamp(timestamp: u64) -> DateTime<chrono::Utc> {
let secs = (timestamp / NS_IN_SECOND) as i64;
let nsecs = (timestamp % NS_IN_SECOND) as u32;
DateTime::from_timestamp(secs, nsecs).unwrap()
}
/// Converts DateTime UTC time into timestamp in ns.
pub fn to_timestamp(time: DateTime<chrono::Utc>) -> u64 {
// The unwrap will be safe for all dates between 1678 and 2261.
time.timestamp_nanos_opt().unwrap() as u64
}
/// Compute number of seats per shard for given total number of seats and number of shards.
pub fn get_num_seats_per_shard(num_shards: NumShards, num_seats: NumSeats) -> Vec<NumSeats> {
(0..num_shards)
.map(|shard_id| {
let remainder =
num_seats.checked_rem(num_shards).expect("num_shards ≠ 0 is guaranteed here");
let quotient =
num_seats.checked_div(num_shards).expect("num_shards ≠ 0 is guaranteed here");
let num = quotient
.checked_add(if shard_id < remainder { 1 } else { 0 })
.expect("overflow is impossible here");
max(num, 1)
})
.collect()
}
/// Generate random string of given length
pub fn generate_random_string(len: usize) -> String {
let bytes = thread_rng().sample_iter(&Alphanumeric).take(len).collect();
String::from_utf8(bytes).unwrap()
}
pub struct Serializable<'a, T>(&'a T);
impl<'a, T> fmt::Display for Serializable<'a, T>
where
T: serde::Serialize,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{:?}", serde_json::to_string(&self.0).unwrap())
}
}
/// Wrap an object that implements Serialize into another object
/// that implements Display. When used display in this object
/// it shows its json representation. It is used to display complex
/// objects using tracing.
///
/// tracing::debug!(target: "diagnostic", value=%ser(&object));
pub fn ser<T>(object: &T) -> Serializable<'_, T>
where
T: serde::Serialize,
{
Serializable(object)
}
/// From `unc-account-id` version `1.0.0-alpha.2`, `is_implicit` returns true for ETH-implicit accounts.
/// This function is a wrapper for `is_implicit` method so that we can easily differentiate its behavior
/// based on whether ETH-implicit accounts are enabled.
pub fn account_is_implicit(account_id: &AccountId, eth_implicit_accounts_enabled: bool) -> bool {
if eth_implicit_accounts_enabled {
account_id.get_account_type().is_implicit()
} else {
account_id.get_account_type() == AccountType::NearImplicitAccount
}
}
/// Returns hex-encoded copy of the public key.
/// This is a UNC-implicit account ID which can be controlled by the corresponding ED25519 private key.
pub fn derive_unc_implicit_account_id(public_key: &ED25519PublicKey) -> AccountId {
hex::encode(public_key).parse().unwrap()
}
/// Returns '0x' + keccak256(public_key)[12:32].hex().
/// This is an ETH-implicit account ID which can be controlled by the corresponding Secp256K1 private key.
pub fn derive_eth_implicit_account_id(public_key: &Secp256K1PublicKey) -> AccountId {
use sha3::Digest;
let pk_hash = sha3::Keccak256::digest(&public_key);
format!("0x{}", hex::encode(&pk_hash[12..32])).parse().unwrap()
}
#[cfg(test)]
mod tests {
use super::*;
use unc_crypto::{KeyType, PublicKey};
#[test]
fn test_derive_unc_implicit_account_id() {
let public_key = PublicKey::from_seed(KeyType::ED25519, "test");
let expected: AccountId =
"bb4dc639b212e075a751685b26bdcea5920a504181ff2910e8549742127092a0".parse().unwrap();
let account_id = derive_unc_implicit_account_id(public_key.unwrap_as_ed25519());
assert_eq!(account_id, expected);
}
#[test]
fn test_derive_eth_implicit_account_id() {
let public_key = PublicKey::from_seed(KeyType::SECP256K1, "test");
let expected: AccountId = "0x96791e923f8cf697ad9c3290f2c9059f0231b24c".parse().unwrap();
let account_id = derive_eth_implicit_account_id(public_key.unwrap_as_secp256k1());
assert_eq!(account_id, expected);
}
#[test]
fn test_num_chunk_producers() {
for num_seats in 1..50 {
for num_shards in 1..50 {
let assignment = get_num_seats_per_shard(num_shards, num_seats);
assert_eq!(assignment.iter().sum::<u64>(), max(num_seats, num_shards));
}
}
}
#[test]
fn test_create_hash_upgradable() {
let base = hash(b"atata");
let extra_base = hash(b"hohoho");
let other_extra_base = hash(b"banana");
let salt = 3;
assert_eq!(
create_nonce_with_nonce(&base, salt),
create_hash_upgradable(
CREATE_HASH_PROTOCOL_VERSION - 1,
&base,
&extra_base,
&extra_base,
salt,
)
);
assert_ne!(
create_nonce_with_nonce(&base, salt),
create_hash_upgradable(
CREATE_HASH_PROTOCOL_VERSION,
&base,
&extra_base,
&extra_base,
salt,
)
);
assert_ne!(
create_hash_upgradable(
CREATE_HASH_PROTOCOL_VERSION,
&base,
&extra_base,
&extra_base,
salt,
),
create_hash_upgradable(
CREATE_HASH_PROTOCOL_VERSION,
&base,
&other_extra_base,
&other_extra_base,
salt,
)
);
assert_ne!(
create_hash_upgradable(
CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION - 1,
&base,
&extra_base,
&other_extra_base,
salt,
),
create_hash_upgradable(
CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION,
&base,
&extra_base,
&other_extra_base,
salt,
)
);
assert_eq!(
create_hash_upgradable(
CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION,
&base,
&extra_base,
&other_extra_base,
salt,
),
create_hash_upgradable(
CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION,
&base,
&other_extra_base,
&other_extra_base,
salt
)
);
}
}