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
use crate::logic;
use crate::types::ReceiptIndex;
use crate::External;
use borsh::BorshDeserialize;
use near_crypto::PublicKey;
use near_primitives::receipt::DataReceiver;
use near_primitives::transaction::{
Action, AddKeyAction, CreateAccountAction, DeleteAccountAction, DeleteKeyAction,
DeployContractAction, FunctionCallAction, StakeAction, TransferAction,
};
use near_primitives::types::{Balance, Nonce};
use near_primitives_core::account::{AccessKey, AccessKeyPermission, FunctionCallPermission};
use near_primitives_core::hash::CryptoHash;
use near_primitives_core::types::{AccountId, Gas};
use near_primitives_core::types::{GasDistribution, GasWeight};
use near_vm_errors::HostError;
type ActionReceipts = Vec<(AccountId, ReceiptMetadata)>;
#[derive(Debug, Clone, PartialEq)]
pub struct ReceiptMetadata {
/// 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>,
}
#[derive(Default, Clone, PartialEq)]
pub(crate) struct ReceiptManager {
pub(crate) action_receipts: ActionReceipts,
gas_weights: Vec<(FunctionCallActionIndex, GasWeight)>,
}
/// Indexes the [`ReceiptManager`]'s action receipts and actions.
#[derive(Debug, Clone, Copy, PartialEq)]
struct FunctionCallActionIndex {
/// Index of [`ReceiptMetadata`] in the action receipts of [`ReceiptManager`].
receipt_index: usize,
/// Index of the [`Action`] within the [`ReceiptMetadata`].
action_index: usize,
}
fn get_fuction_call_action_mut(
action_receipts: &mut ActionReceipts,
index: FunctionCallActionIndex,
) -> &mut FunctionCallAction {
let FunctionCallActionIndex { receipt_index, action_index } = index;
if let Some(Action::FunctionCall(action)) = action_receipts
.get_mut(receipt_index)
.and_then(|(_, receipt)| receipt.actions.get_mut(action_index))
{
action
} else {
panic!(
"Invalid function call index \
(promise_index={receipt_index}, action_index={action_index})",
);
}
}
impl ReceiptManager {
pub(crate) fn get_receipt_receiver(&self, receipt_index: ReceiptIndex) -> &AccountId {
self.action_receipts
.get(receipt_index as usize)
.map(|(id, _)| id)
.expect("receipt index should be valid for getting receiver")
}
/// Appends an action and returns the index the action was inserted in the receipt
fn append_action(&mut self, receipt_index: ReceiptIndex, action: Action) -> usize {
let actions = &mut self
.action_receipts
.get_mut(receipt_index as usize)
.expect("receipt index should be present")
.1
.actions;
actions.push(action);
// Return index that action was inserted at
actions.len() - 1
}
/// Create a receipt which will be executed after all the receipts identified by
/// `receipt_indices` are complete.
///
/// If any of the [`RecepitIndex`]es do not refer to a known receipt, this function will fail
/// with an error.
///
/// # Arguments
///
/// * `generate_data_id` - function to generate a data id to connect receipt output to
/// * `receipt_indices` - a list of receipt indices the new receipt is depend on
/// * `receiver_id` - account id of the receiver of the receipt created
pub(crate) fn create_receipt(
&mut self,
ext: &mut dyn External,
receipt_indices: Vec<ReceiptIndex>,
receiver_id: AccountId,
) -> logic::Result<ReceiptIndex> {
let mut input_data_ids = vec![];
for receipt_index in receipt_indices {
let data_id = ext.generate_data_id();
self.action_receipts
.get_mut(receipt_index as usize)
.ok_or_else(|| HostError::InvalidReceiptIndex { receipt_index })?
.1
.output_data_receivers
.push(DataReceiver { data_id, receiver_id: receiver_id.clone() });
input_data_ids.push(data_id);
}
let new_receipt =
ReceiptMetadata { output_data_receivers: vec![], input_data_ids, actions: vec![] };
let new_receipt_index = self.action_receipts.len() as ReceiptIndex;
self.action_receipts.push((receiver_id, new_receipt));
Ok(new_receipt_index)
}
/// Attach the [`CreateAccountAction`] action to an existing receipt.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_create_account(
&mut self,
receipt_index: ReceiptIndex,
) -> logic::Result<()> {
self.append_action(receipt_index, Action::CreateAccount(CreateAccountAction {}));
Ok(())
}
/// Attach the [`DeployContractAction`] action to an existing receipt.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `code` - a Wasm code to attach
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_deploy_contract(
&mut self,
receipt_index: ReceiptIndex,
code: Vec<u8>,
) -> logic::Result<()> {
self.append_action(receipt_index, Action::DeployContract(DeployContractAction { code }));
Ok(())
}
/// Attach the [`FunctionCallAction`] action to an existing receipt. This method has similar
/// functionality to [`append_action_function_call`](Self::append_action_function_call) except
/// that it allows specifying a weight to use leftover gas from the current execution.
///
/// `prepaid_gas` and `gas_weight` can either be specified or both. If a `gas_weight` is
/// specified, the action should be allocated gas in
/// [`distribute_unused_gas`](Self::distribute_unused_gas).
///
/// For more information, see [crate::VMLogic::promise_batch_action_function_call_weight].
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `method_name` - a name of the contract method to call
/// * `arguments` - a Wasm code to attach
/// * `attached_deposit` - amount of tokens to transfer with the call
/// * `prepaid_gas` - amount of prepaid gas to attach to the call
/// * `gas_weight` - relative weight of unused gas to distribute to the function call action
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_function_call_weight(
&mut self,
receipt_index: ReceiptIndex,
method_name: Vec<u8>,
args: Vec<u8>,
attached_deposit: Balance,
prepaid_gas: Gas,
gas_weight: GasWeight,
) -> logic::Result<()> {
let action_index = self.append_action(
receipt_index,
Action::FunctionCall(FunctionCallAction {
method_name: String::from_utf8(method_name)
.map_err(|_| HostError::InvalidMethodName)?,
args,
gas: prepaid_gas,
deposit: attached_deposit,
}),
);
if gas_weight.0 > 0 {
self.gas_weights.push((
FunctionCallActionIndex { receipt_index: receipt_index as usize, action_index },
gas_weight,
));
}
Ok(())
}
/// Attach the [`TransferAction`] action to an existing receipt.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `amount` - amount of tokens to transfer
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_transfer(
&mut self,
receipt_index: ReceiptIndex,
deposit: Balance,
) -> logic::Result<()> {
self.append_action(receipt_index, Action::Transfer(TransferAction { deposit }));
Ok(())
}
/// Attach the [`StakeAction`] action to an existing receipt.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `stake` - amount of tokens to stake
/// * `public_key` - a validator public key
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_stake(
&mut self,
receipt_index: ReceiptIndex,
stake: Balance,
public_key: Vec<u8>,
) -> logic::Result<()> {
self.append_action(
receipt_index,
Action::Stake(StakeAction {
stake,
public_key: PublicKey::try_from_slice(&public_key)
.map_err(|_| HostError::InvalidPublicKey)?,
}),
);
Ok(())
}
/// Attach the [`AddKeyAction`] action to an existing receipt.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `public_key` - a public key for an access key
/// * `nonce` - a nonce
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_add_key_with_full_access(
&mut self,
receipt_index: ReceiptIndex,
public_key: Vec<u8>,
nonce: Nonce,
) -> logic::Result<()> {
self.append_action(
receipt_index,
Action::AddKey(AddKeyAction {
public_key: PublicKey::try_from_slice(&public_key)
.map_err(|_| HostError::InvalidPublicKey)?,
access_key: AccessKey { nonce, permission: AccessKeyPermission::FullAccess },
}),
);
Ok(())
}
/// Attach the [`AddKeyAction`] action an existing receipt.
///
/// The access key associated with the action will have the
/// [`AccessKeyPermission::FunctionCall`] permission scope.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `public_key` - a public key for an access key
/// * `nonce` - a nonce
/// * `allowance` - amount of tokens allowed to spend by this access key
/// * `receiver_id` - a contract witch will be allowed to call with this access key
/// * `method_names` - a list of method names is allowed to call with this access key (empty = any method)
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_add_key_with_function_call(
&mut self,
receipt_index: ReceiptIndex,
public_key: Vec<u8>,
nonce: Nonce,
allowance: Option<Balance>,
receiver_id: AccountId,
method_names: Vec<Vec<u8>>,
) -> logic::Result<()> {
self.append_action(
receipt_index,
Action::AddKey(AddKeyAction {
public_key: PublicKey::try_from_slice(&public_key)
.map_err(|_| HostError::InvalidPublicKey)?,
access_key: AccessKey {
nonce,
permission: AccessKeyPermission::FunctionCall(FunctionCallPermission {
allowance,
receiver_id: receiver_id.into(),
method_names: method_names
.into_iter()
.map(|method_name| {
String::from_utf8(method_name)
.map_err(|_| HostError::InvalidMethodName)
})
.collect::<std::result::Result<Vec<_>, _>>()?,
}),
},
}),
);
Ok(())
}
/// Attach the [`DeleteKeyAction`] action to an existing receipt.
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `public_key` - a public key for an access key to delete
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_delete_key(
&mut self,
receipt_index: ReceiptIndex,
public_key: Vec<u8>,
) -> logic::Result<()> {
self.append_action(
receipt_index,
Action::DeleteKey(DeleteKeyAction {
public_key: PublicKey::try_from_slice(&public_key)
.map_err(|_| HostError::InvalidPublicKey)?,
}),
);
Ok(())
}
/// Attach the [`DeleteAccountAction`] action to an existing receipt
///
/// # Arguments
///
/// * `receipt_index` - an index of Receipt to append an action
/// * `beneficiary_id` - an account id to which the rest of the funds of the removed account will be transferred
///
/// # Panics
///
/// Panics if the `receipt_index` does not refer to a known receipt.
pub(crate) fn append_action_delete_account(
&mut self,
receipt_index: ReceiptIndex,
beneficiary_id: AccountId,
) -> logic::Result<()> {
self.append_action(
receipt_index,
Action::DeleteAccount(DeleteAccountAction { beneficiary_id }),
);
Ok(())
}
/// Distribute the gas among the scheduled function calls that specify a gas weight.
///
/// Distributes the gas passed in by splitting it among weights defined in `gas_weights`.
/// This will sum all weights, retrieve the gas per weight, then update each function
/// to add the respective amount of gas. Once all gas is distributed, the remainder of
/// the gas not assigned due to precision loss is added to the last function with a weight.
///
/// # Arguments
///
/// * `gas` - amount of unused gas to distribute
///
/// # Returns
///
/// Function returns a [GasDistribution] that indicates how the gas was distributed.
pub(crate) fn distribute_unused_gas(&mut self, unused_gas: Gas) -> GasDistribution {
let gas_weight_sum: u128 =
self.gas_weights.iter().map(|(_, GasWeight(weight))| *weight as u128).sum();
if gas_weight_sum == 0 {
return GasDistribution::NoRatios;
}
let mut distribute_gas = |index: &FunctionCallActionIndex, assigned_gas: Gas| {
let FunctionCallAction { gas, .. } =
get_fuction_call_action_mut(&mut self.action_receipts, *index);
// Operation cannot overflow because the amount of assigned gas is a fraction of
// the unused gas and is using floor division.
*gas += assigned_gas;
};
let mut distributed = 0;
for (action_index, GasWeight(weight)) in &self.gas_weights {
// Multiplication is done in u128 with max values of u64::MAX so this cannot overflow.
// Division result can be truncated to 64 bits because gas_weight_sum >= weight.
let assigned_gas = (unused_gas as u128 * *weight as u128 / gas_weight_sum) as u64;
distribute_gas(action_index, assigned_gas as u64);
distributed += assigned_gas
}
// Distribute remaining gas to final action.
if let Some((last_idx, _)) = self.gas_weights.last() {
distribute_gas(last_idx, unused_gas - distributed);
}
self.gas_weights.clear();
GasDistribution::All
}
}