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
//! All operation types that are generated/used when making transactions or view calls.
use crate::error::{ErrorKind, RpcErrorCode};
use crate::result::{Execution, ExecutionFinalResult, Result, ViewResultDetails};
use crate::rpc::client::{
send_batch_tx_and_retry, send_batch_tx_async_and_retry, DEFAULT_CALL_DEPOSIT,
DEFAULT_CALL_FN_GAS,
};
use crate::rpc::query::{Query, ViewFunction};
use crate::types::{
AccessKey, AccountId, Gas, InMemorySigner, KeyType, NearToken, PublicKey, SecretKey,
};
use crate::worker::Worker;
use crate::{Account, CryptoHash, Network};
use near_account_id::ParseAccountError;
use near_gas::NearGas;
use near_jsonrpc_client::errors::{JsonRpcError, JsonRpcServerError};
use near_jsonrpc_client::methods::tx::RpcTransactionError;
use near_primitives::transaction::{
Action, AddKeyAction, CreateAccountAction, DeleteAccountAction, DeleteKeyAction,
DeployContractAction, FunctionCallAction, StakeAction, TransferAction,
};
use near_primitives::views::FinalExecutionOutcomeView;
use std::convert::TryInto;
use std::fmt;
use std::future::IntoFuture;
use std::pin::Pin;
use std::task::Poll;
const MAX_GAS: NearGas = NearGas::from_tgas(300);
/// A set of arguments we can provide to a transaction, containing
/// the function name, arguments, the amount of gas to use and deposit.
#[derive(Debug)]
pub struct Function {
pub(crate) name: String,
pub(crate) args: Result<Vec<u8>>,
pub(crate) deposit: NearToken,
pub(crate) gas: Gas,
}
impl Function {
/// Initialize a new instance of [`Function`], tied to a specific function on a
/// contract that lives directly on a contract we've specified in [`Transaction`].
pub fn new(name: &str) -> Self {
Self {
name: name.into(),
args: Ok(vec![]),
deposit: DEFAULT_CALL_DEPOSIT,
gas: DEFAULT_CALL_FN_GAS,
}
}
/// Provide the arguments for the call. These args are serialized bytes from either
/// a JSON or Borsh serializable set of arguments. To use the more specific versions
/// with better quality of life, use `args_json` or `args_borsh`.
pub fn args(mut self, args: Vec<u8>) -> Self {
if self.args.is_err() {
return self;
}
self.args = Ok(args);
self
}
/// Similar to `args`, specify an argument that is JSON serializable and can be
/// accepted by the equivalent contract. Recommend to use something like
/// `serde_json::json!` macro to easily serialize the arguments.
pub fn args_json<U: serde::Serialize>(mut self, args: U) -> Self {
match serde_json::to_vec(&args) {
Ok(args) => self.args = Ok(args),
Err(e) => self.args = Err(ErrorKind::DataConversion.custom(e)),
}
self
}
/// Similar to `args`, specify an argument that is borsh serializable and can be
/// accepted by the equivalent contract.
pub fn args_borsh<U: borsh::BorshSerialize>(mut self, args: U) -> Self {
match args.try_to_vec() {
Ok(args) => self.args = Ok(args),
Err(e) => self.args = Err(ErrorKind::DataConversion.custom(e)),
}
self
}
/// Specify the amount of tokens to be deposited where `deposit` is the amount of
/// tokens in yocto near.
pub fn deposit(mut self, deposit: NearToken) -> Self {
self.deposit = deposit;
self
}
/// Specify the amount of gas to be used.
pub fn gas(mut self, gas: Gas) -> Self {
self.gas = gas;
self
}
/// Use the maximum amount of gas possible to perform this function call into the contract.
pub fn max_gas(self) -> Self {
self.gas(MAX_GAS)
}
}
/// A builder-like object that will allow specifying various actions to be performed
/// in a single transaction. For details on each of the actions, find them in
/// [NEAR transactions](https://docs.near.org/docs/concepts/transaction).
///
/// All actions are performed on the account specified by `receiver_id`. This object
/// is most commonly constructed from [`Account::batch`] or [`Contract::batch`],
/// where `receiver_id` is specified in the `Account::batch` while `Contract::id()`
/// is used by default for `Contract::batch`.
///
/// [`Contract::batch`]: crate::Contract::batch
pub struct Transaction {
worker: Worker<dyn Network>,
signer: InMemorySigner,
receiver_id: AccountId,
// Result used to defer errors in argument parsing to later when calling into transact
actions: Result<Vec<Action>>,
}
impl Transaction {
pub(crate) fn new(
worker: Worker<dyn Network>,
signer: InMemorySigner,
receiver_id: AccountId,
) -> Self {
Self {
worker,
signer,
receiver_id,
actions: Ok(Vec::new()),
}
}
/// Adds a key to the `receiver_id`'s account, where the public key can be used
/// later to delete the same key.
pub fn add_key(mut self, pk: PublicKey, ak: AccessKey) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(
AddKeyAction {
public_key: pk.into(),
access_key: ak.into(),
}
.into(),
);
}
self
}
/// Call into the `receiver_id`'s contract with the specific function arguments.
pub fn call(mut self, function: Function) -> Self {
let args = match function.args {
Ok(args) => args,
Err(err) => {
self.actions = Err(err);
return self;
}
};
if let Ok(actions) = &mut self.actions {
actions.push(Action::FunctionCall(FunctionCallAction {
method_name: function.name.to_string(),
args,
deposit: function.deposit.as_yoctonear(),
gas: function.gas.as_gas(),
}));
}
self
}
/// Create a new account with the account id being `receiver_id`.
pub fn create_account(mut self) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(CreateAccountAction {}.into());
}
self
}
/// Deletes the `receiver_id`'s account. The beneficiary specified by
/// `beneficiary_id` will receive the funds of the account deleted.
pub fn delete_account(mut self, beneficiary_id: &AccountId) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(
DeleteAccountAction {
beneficiary_id: beneficiary_id.clone(),
}
.into(),
);
}
self
}
/// Deletes a key from the `receiver_id`'s account, where the public key is
/// associated with the access key to be deleted.
pub fn delete_key(mut self, pk: PublicKey) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(DeleteKeyAction { public_key: pk.0 }.into());
}
self
}
/// Deploy contract code or WASM bytes to the `receiver_id`'s account.
pub fn deploy(mut self, code: &[u8]) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(DeployContractAction { code: code.into() }.into());
}
self
}
/// An action which stakes the signer's tokens and setups a validator public key.
pub fn stake(mut self, stake: NearToken, pk: PublicKey) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(
StakeAction {
stake: stake.as_yoctonear(),
public_key: pk.0,
}
.into(),
);
}
self
}
/// Transfer `deposit` amount from `signer`'s account into `receiver_id`'s account.
pub fn transfer(mut self, deposit: NearToken) -> Self {
if let Ok(actions) = &mut self.actions {
actions.push(
TransferAction {
deposit: deposit.as_yoctonear(),
}
.into(),
);
}
self
}
async fn transact_raw(self) -> Result<FinalExecutionOutcomeView> {
let view = send_batch_tx_and_retry(
self.worker.client(),
&self.signer,
&self.receiver_id,
self.actions?,
)
.await?;
if !self.worker.tx_callbacks.is_empty() {
let total_gas_burnt = view.transaction_outcome.outcome.gas_burnt
+ view
.receipts_outcome
.iter()
.map(|t| t.outcome.gas_burnt)
.sum::<u64>();
for callback in self.worker.tx_callbacks {
callback(Gas::from_gas(total_gas_burnt))?;
}
}
Ok(view)
}
/// Process the transaction, and return the result of the execution.
pub async fn transact(self) -> Result<ExecutionFinalResult> {
self.transact_raw()
.await
.map(ExecutionFinalResult::from_view)
.map_err(crate::error::Error::from)
}
/// Send the transaction to the network to be processed. This will be done asynchronously
/// without waiting for the transaction to complete. This returns us a [`TransactionStatus`]
/// for which we can call into [`status`] and/or `.await` to retrieve info about whether
/// the transaction has been completed or not. Note that `.await` will wait till completion
/// of the transaction.
///
/// [`status`]: TransactionStatus::status
pub async fn transact_async(self) -> Result<TransactionStatus> {
send_batch_tx_async_and_retry(self.worker, &self.signer, &self.receiver_id, self.actions?)
.await
}
}
/// Similar to a [`Transaction`], but more specific to making a call into a contract.
/// Note, only one call can be made per `CallTransaction`.
pub struct CallTransaction {
worker: Worker<dyn Network>,
signer: InMemorySigner,
contract_id: AccountId,
function: Function,
}
impl CallTransaction {
pub(crate) fn new(
worker: Worker<dyn Network>,
contract_id: AccountId,
signer: InMemorySigner,
function: &str,
) -> Self {
Self {
worker,
signer,
contract_id,
function: Function::new(function),
}
}
/// Provide the arguments for the call. These args are serialized bytes from either
/// a JSON or Borsh serializable set of arguments. To use the more specific versions
/// with better quality of life, use `args_json` or `args_borsh`.
pub fn args(mut self, args: Vec<u8>) -> Self {
self.function = self.function.args(args);
self
}
/// Similar to `args`, specify an argument that is JSON serializable and can be
/// accepted by the equivalent contract. Recommend to use something like
/// `serde_json::json!` macro to easily serialize the arguments.
pub fn args_json<U: serde::Serialize>(mut self, args: U) -> Self {
self.function = self.function.args_json(args);
self
}
/// Similar to `args`, specify an argument that is borsh serializable and can be
/// accepted by the equivalent contract.
pub fn args_borsh<U: borsh::BorshSerialize>(mut self, args: U) -> Self {
self.function = self.function.args_borsh(args);
self
}
/// Specify the amount of tokens to be deposited where `deposit` is the amount of
/// tokens in yocto near.
pub fn deposit(mut self, deposit: NearToken) -> Self {
self.function = self.function.deposit(deposit);
self
}
/// Specify the amount of gas to be used where `gas` is the amount of gas in yocto near.
pub fn gas(mut self, gas: NearGas) -> Self {
self.function = self.function.gas(gas);
self
}
/// Use the maximum amount of gas possible to perform this transaction.
pub fn max_gas(self) -> Self {
self.gas(MAX_GAS)
}
/// Finally, send the transaction to the network. This will consume the `CallTransaction`
/// object and return us the execution details, along with any errors if the transaction
/// failed in any process along the way.
pub async fn transact(self) -> Result<ExecutionFinalResult> {
let txn = self
.worker
.client()
.call(
&self.signer,
&self.contract_id,
self.function.name.to_string(),
self.function.args?,
self.function.gas.as_gas(),
self.function.deposit,
)
.await
.map(ExecutionFinalResult::from_view)
.map_err(crate::error::Error::from)?;
for callback in self.worker.tx_callbacks.iter() {
callback(txn.total_gas_burnt)?;
}
Ok(txn)
}
/// Send the transaction to the network to be processed. This will be done asynchronously
/// without waiting for the transaction to complete. This returns us a [`TransactionStatus`]
/// for which we can call into [`status`] and/or `.await` to retrieve info about whether
/// the transaction has been completed or not. Note that `.await` will wait till completion
/// of the transaction.
///
/// [`status`]: TransactionStatus::status
pub async fn transact_async(self) -> Result<TransactionStatus> {
send_batch_tx_async_and_retry(
self.worker,
&self.signer,
&self.contract_id,
vec![FunctionCallAction {
args: self.function.args?,
method_name: self.function.name,
gas: self.function.gas.as_gas(),
deposit: self.function.deposit.as_yoctonear(),
}
.into()],
)
.await
}
/// Instead of transacting the transaction, call into the specified view function.
pub async fn view(self) -> Result<ViewResultDetails> {
Query::new(
self.worker.client(),
ViewFunction {
account_id: self.contract_id.clone(),
function: self.function,
},
)
.await
}
}
/// Similar to a [`Transaction`], but more specific to creating an account.
/// This transaction will create a new account with the specified `receiver_id`
pub struct CreateAccountTransaction<'a, 'b> {
worker: &'a Worker<dyn Network>,
signer: InMemorySigner,
parent_id: AccountId,
new_account_id: &'b str,
initial_balance: NearToken,
secret_key: Option<SecretKey>,
}
impl<'a, 'b> CreateAccountTransaction<'a, 'b> {
pub(crate) fn new(
worker: &'a Worker<dyn Network>,
signer: InMemorySigner,
parent_id: AccountId,
new_account_id: &'b str,
) -> Self {
Self {
worker,
signer,
parent_id,
new_account_id,
initial_balance: NearToken::from_yoctonear(100000000000000000000000u128),
secret_key: None,
}
}
/// Specifies the initial balance of the new account. Amount directly taken out
/// from the caller/signer of this transaction.
pub fn initial_balance(mut self, initial_balance: NearToken) -> Self {
self.initial_balance = initial_balance;
self
}
/// Set the secret key of the new account.
pub fn keys(mut self, secret_key: SecretKey) -> Self {
self.secret_key = Some(secret_key);
self
}
/// Send the transaction to the network. This will consume the `CreateAccountTransaction`
/// and give us back the details of the execution and finally the new [`Account`] object.
pub async fn transact(self) -> Result<Execution<Account>> {
let sk = self
.secret_key
.unwrap_or_else(|| SecretKey::from_seed(KeyType::ED25519, "subaccount.seed"));
let id: AccountId = format!("{}.{}", self.new_account_id, self.parent_id)
.try_into()
.map_err(|e: ParseAccountError| ErrorKind::DataConversion.custom(e))?;
let outcome = self
.worker
.client()
.create_account(&self.signer, &id, sk.public_key(), self.initial_balance)
.await?;
let signer = InMemorySigner::from_secret_key(id, sk);
let account = Account::new(signer, self.worker.clone());
let details = ExecutionFinalResult::from_view(outcome);
for callback in self.worker.tx_callbacks.iter() {
callback(details.total_gas_burnt)?;
}
Ok(Execution {
result: account,
details,
})
}
}
/// `TransactionStatus` object relating to an [`asynchronous transaction`] on the network.
/// Used to query into the status of the Transaction for whether it has completed or not.
///
/// [`asynchronous transaction`]: https://docs.near.org/api/rpc/transactions#send-transaction-async
#[must_use]
pub struct TransactionStatus {
worker: Worker<dyn Network>,
sender_id: AccountId,
hash: CryptoHash,
}
impl TransactionStatus {
pub(crate) fn new(
worker: Worker<dyn Network>,
id: AccountId,
hash: near_primitives::hash::CryptoHash,
) -> Self {
Self {
worker,
sender_id: id,
hash: CryptoHash(hash.0),
}
}
/// Checks the status of the transaction. If an `Err` is returned, then the transaction
/// is in an unexpected state. The error should have further context. Otherwise, if an
/// `Ok` value with [`Poll::Pending`] is returned, then the transaction has not finished.
pub async fn status(&self) -> Result<Poll<ExecutionFinalResult>> {
let result = self
.worker
.client()
.tx_async_status(
&self.sender_id,
near_primitives::hash::CryptoHash(self.hash.0),
)
.await
.map(ExecutionFinalResult::from_view);
match result {
Ok(result) => Ok(Poll::Ready(result)),
Err(err) => match err {
JsonRpcError::ServerError(JsonRpcServerError::HandlerError(
RpcTransactionError::UnknownTransaction { .. },
)) => Ok(Poll::Pending),
other => Err(RpcErrorCode::BroadcastTxFailure.custom(other)),
},
}
}
/// Wait until the completion of the transaction by polling [`TransactionStatus::status`].
pub(crate) async fn wait(self) -> Result<ExecutionFinalResult> {
loop {
match self.status().await? {
Poll::Ready(val) => break Ok(val),
Poll::Pending => (),
}
tokio::time::sleep(std::time::Duration::from_millis(300)).await;
}
}
/// Get the [`AccountId`] of the account that initiated this transaction.
pub fn sender_id(&self) -> &AccountId {
&self.sender_id
}
/// Reference [`CryptoHash`] to the submitted transaction, pending completion.
pub fn hash(&self) -> &CryptoHash {
&self.hash
}
}
impl fmt::Debug for TransactionStatus {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("TransactionStatus")
.field("sender_id", &self.sender_id)
.field("hash", &self.hash)
.finish()
}
}
impl IntoFuture for TransactionStatus {
type Output = Result<ExecutionFinalResult>;
type IntoFuture = Pin<Box<dyn std::future::Future<Output = Self::Output>>>;
fn into_future(self) -> Self::IntoFuture {
Box::pin(async { self.wait().await })
}
}