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
use crate::hash::CryptoHash;
use crate::serialize::dec_format;
use crate::transaction::{Action, TransferAction};
use crate::types::{AccountId, Balance, ShardId};
use borsh::{BorshDeserialize, BorshSerialize};
use serde_with::base64::Base64;
use serde_with::serde_as;
use std::borrow::Borrow;
use std::collections::HashMap;
use std::fmt;
use unc_crypto::{KeyType, PublicKey};
use unc_fmt::AbbrBytes;
pub use unc_vm_runner::logic::DataReceiver;
/// Receipts are used for a cross-shard communication.
/// Receipts could be 2 types (determined by a `ReceiptEnum`): `ReceiptEnum::Action` of `ReceiptEnum::Data`.
#[derive(
BorshSerialize,
BorshDeserialize,
Debug,
PartialEq,
Eq,
Clone,
serde::Serialize,
serde::Deserialize,
)]
pub struct Receipt {
/// An issuer account_id of a particular receipt.
/// `predecessor_id` could be either `Transaction` `signer_id` or intermediate contract's `account_id`.
pub predecessor_id: AccountId,
/// `receiver_id` is a receipt destination.
pub receiver_id: AccountId,
/// An unique id for the receipt
pub receipt_id: CryptoHash,
/// A receipt type
pub receipt: ReceiptEnum,
}
impl Borrow<CryptoHash> for Receipt {
fn borrow(&self) -> &CryptoHash {
&self.receipt_id
}
}
impl Receipt {
/// It's not a content hash, but receipt_id is unique.
pub fn get_hash(&self) -> CryptoHash {
self.receipt_id
}
/// Generates a receipt with a transfer from system for a given balance without a receipt_id.
/// This should be used for token refunds instead of gas refunds. It doesn't refund the
/// allowance of the access key. For gas refunds use `new_gas_refund`.
pub fn new_balance_refund(receiver_id: &AccountId, refund: Balance) -> Self {
Receipt {
predecessor_id: "system".parse().unwrap(),
receiver_id: receiver_id.clone(),
receipt_id: CryptoHash::default(),
receipt: ReceiptEnum::Action(ActionReceipt {
signer_id: "system".parse().unwrap(),
signer_public_key: PublicKey::empty(KeyType::ED25519),
gas_price: 0,
output_data_receivers: vec![],
input_data_ids: vec![],
actions: vec![Action::Transfer(TransferAction { deposit: refund })],
}),
}
}
/// Generates a receipt with a transfer action from system for a given balance without a
/// receipt_id. It contains `signer_id` and `signer_public_key` to indicate this is a gas
/// refund. The execution of this receipt will try to refund the allowance of the
/// access key with the given public key.
/// NOTE: The access key may be replaced by the owner, so the execution can't rely that the
/// access key is the same and it should use best effort for the refund.
pub fn new_gas_refund(
receiver_id: &AccountId,
refund: Balance,
signer_public_key: PublicKey,
) -> Self {
Receipt {
predecessor_id: "system".parse().unwrap(),
receiver_id: receiver_id.clone(),
receipt_id: CryptoHash::default(),
receipt: ReceiptEnum::Action(ActionReceipt {
signer_id: receiver_id.clone(),
signer_public_key,
gas_price: 0,
output_data_receivers: vec![],
input_data_ids: vec![],
actions: vec![Action::Transfer(TransferAction { deposit: refund })],
}),
}
}
}
/// Receipt could be either ActionReceipt or DataReceipt
#[derive(
BorshSerialize,
BorshDeserialize,
Clone,
Debug,
PartialEq,
Eq,
serde::Serialize,
serde::Deserialize,
)]
pub enum ReceiptEnum {
Action(ActionReceipt),
Data(DataReceipt),
}
/// ActionReceipt is derived from an Action from `Transaction or from Receipt`
#[derive(
BorshSerialize,
BorshDeserialize,
Debug,
PartialEq,
Eq,
Clone,
serde::Serialize,
serde::Deserialize,
)]
pub struct ActionReceipt {
/// A signer of the original transaction
pub signer_id: AccountId,
/// An access key which was used to sign the original transaction
pub signer_public_key: PublicKey,
/// A gas_price which has been used to buy gas in the original transaction
#[serde(with = "dec_format")]
pub gas_price: Balance,
/// If present, where to route the output data
pub output_data_receivers: Vec<DataReceiver>,
/// A list of the input data dependencies for this Receipt to process.
/// If all `input_data_ids` for this receipt are delivered to the account
/// that means we have all the `ReceivedData` input which will be than converted to a
/// `PromiseResult::Successful(value)` or `PromiseResult::Failed`
/// depending on `ReceivedData` is `Some(_)` or `None`
pub input_data_ids: Vec<CryptoHash>,
/// A list of actions to process when all input_data_ids are filled
pub actions: Vec<Action>,
}
/// An incoming (ingress) `DataReceipt` which is going to a Receipt's `receiver` input_data_ids
/// Which will be converted to `PromiseResult::Successful(value)` or `PromiseResult::Failed`
#[serde_as]
#[derive(
BorshSerialize,
BorshDeserialize,
Hash,
PartialEq,
Eq,
Clone,
serde::Serialize,
serde::Deserialize,
)]
pub struct DataReceipt {
pub data_id: CryptoHash,
#[serde_as(as = "Option<Base64>")]
pub data: Option<Vec<u8>>,
}
impl fmt::Debug for DataReceipt {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("DataReceipt")
.field("data_id", &self.data_id)
.field("data", &format_args!("{}", AbbrBytes(self.data.as_deref())))
.finish()
}
}
/// A temporary data which is created by processing of DataReceipt
/// stored in a state trie with a key = `account_id` + `data_id` until
/// `input_data_ids` of all incoming Receipts are satisfied
/// None means data retrieval was failed
#[derive(BorshSerialize, BorshDeserialize, Hash, PartialEq, Eq, Clone)]
pub struct ReceivedData {
pub data: Option<Vec<u8>>,
}
impl fmt::Debug for ReceivedData {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("ReceivedData")
.field("data", &format_args!("{}", AbbrBytes(self.data.as_deref())))
.finish()
}
}
/// Stores indices for a persistent queue for delayed receipts that didn't fit into a block.
#[derive(Default, BorshSerialize, BorshDeserialize, Clone, PartialEq, Debug)]
pub struct DelayedReceiptIndices {
// First inclusive index in the queue.
pub first_index: u64,
// Exclusive end index of the queue
pub next_available_index: u64,
}
impl DelayedReceiptIndices {
pub fn len(&self) -> u64 {
self.next_available_index - self.first_index
}
}
/// Map of shard to list of receipts to send to it.
pub type ReceiptResult = HashMap<ShardId, Vec<Receipt>>;