(WIP) refactor(promise)!: refactor promises to schedule at end of function call and allow automatically assigning gas

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
 ## [unreleased]
-* Update `panic` and `panic_utf8` syscall signatures to indicate they do not return. [PR 492](https://github.com/near/near-sdk-rs/pull/492)
+- Update `panic` and `panic_utf8` syscall signatures to indicate they do not return. [PR 492](https://github.com/near/near-sdk-rs/pull/492)
 - Removes `PublicKey` generic on `env` promise batch calls. Functions now just take a reference to the `PublicKey`. [PR 495](https://github.com/near/near-sdk-rs/pull/495)
 - fix: Public keys can no longer be borsh deserialized from invalid bytes. [PR 502](https://github.com/near/near-sdk-rs/pull/502)
   - Adds `Hash` derive to `PublicKey`

HELP.md

@@ -474,14 +474,12 @@ Let's assume the calculator is deployed on `calc.near`, we can use the following
 
 ```rust
 const CALCULATOR_ACCOUNT_ID: &str = "calc.near";
-const NO_DEPOSIT: Balance = 0;
-const BASE_GAS: Gas = 5_000_000_000_000;
 
 #[near_bindgen]
 impl Contract {
     pub fn sum_a_b(&mut self, a: U128, b: U128) -> Promise {
         let calculator_account_id: AccountId = CALCULATOR_ACCOUNT_ID.to_string();
-        ext_calculator::sum(a, b, &calculator_account_id, NO_DEPOSIT, BASE_GAS)
+        ext_calculator::sum(a, b, calculator_account_id)
     }
 }
 ```

examples/cross-contract-high-level/src/lib.rs

@@ -59,12 +59,12 @@ impl CrossContract {
         let pivot = arr.len() / 2;
         let arr0 = arr[..pivot].to_vec();
         let arr1 = arr[pivot..].to_vec();
-        let prepaid_gas = env::prepaid_gas();
         let account_id = env::current_account_id();
 
-        ext::merge_sort(arr0, account_id.clone(), 0, prepaid_gas / 4)
-            .and(ext::merge_sort(arr1, account_id.clone(), 0, prepaid_gas / 4))
-            .then(ext::merge(account_id, 0, prepaid_gas / 4))
+        ext::merge_sort(arr0, account_id.clone())
+            .into_promise()
+            .and(ext::merge_sort(arr1, account_id.clone()).into())
+            .then(ext::merge(account_id).into())
             .into()
     }
 
@@ -119,23 +119,17 @@ impl CrossContract {
     //    }
 
     pub fn simple_call(&mut self, account_id: AccountId, message: String) {
-        ext_status_message::set_status(message, account_id, 0, env::prepaid_gas() / 2);
+        ext_status_message::set_status(message, account_id);
     }
     pub fn complex_call(&mut self, account_id: AccountId, message: String) -> Promise {
         // 1) call status_message to record a message from the signer.
         // 2) call status_message to retrieve the message of the signer.
         // 3) return that message as its own result.
         // Note, for a contract to simply call another contract (1) is sufficient.
-        let prepaid_gas = env::prepaid_gas();
         log!("complex_call");
-        ext_status_message::set_status(message, account_id.clone(), 0, prepaid_gas / 3).then(
-            ext_status_message::get_status(
-                env::signer_account_id(),
-                account_id,
-                0,
-                prepaid_gas / 3,
-            ),
-        )
+        ext_status_message::set_status(message, account_id.clone())
+            .into_promise()
+            .then(ext_status_message::get_status(env::signer_account_id(), account_id).into())
     }
 
     pub fn transfer_money(&mut self, account_id: AccountId, amount: u64) {

examples/fungible-token/test-contract-defi/src/lib.rs

@@ -5,16 +5,13 @@ use near_contract_standards::fungible_token::receiver::FungibleTokenReceiver;
 use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
 use near_sdk::json_types::U128;
 use near_sdk::{
-    env, ext_contract, log, near_bindgen, AccountId, Balance, Gas, PanicOnDefault,
-    PromiseOrValue,
+    env, ext_contract, log, near_bindgen, AccountId, Balance, Gas, PanicOnDefault, PromiseOrValue,
 };
 
 const BASE_GAS: u64 = 5_000_000_000_000;
 const PROMISE_CALL: u64 = 5_000_000_000_000;
 const GAS_FOR_FT_ON_TRANSFER: Gas = Gas(BASE_GAS + PROMISE_CALL);
 
-const NO_DEPOSIT: Balance = 0;
-
 #[near_bindgen]
 #[derive(BorshDeserialize, BorshSerialize, PanicOnDefault)]
 pub struct DeFi {
@@ -64,13 +61,9 @@ impl FungibleTokenReceiver for DeFi {
             _ => {
                 let prepaid_gas = env::prepaid_gas();
                 let account_id = env::current_account_id();
-                ext_self::value_please(
-                    msg,
-                    account_id,
-                    NO_DEPOSIT,
-                    prepaid_gas - GAS_FOR_FT_ON_TRANSFER,
-                )
-                .into()
+                ext_self::value_please(msg, account_id)
+                    .with_gas(prepaid_gas - GAS_FOR_FT_ON_TRANSFER)
+                    .into()
             }
         }
     }

examples/non-fungible-token/test-approval-receiver/src/lib.rs

@@ -5,16 +5,13 @@ use near_contract_standards::non_fungible_token::approval::NonFungibleTokenAppro
 use near_contract_standards::non_fungible_token::TokenId;
 use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
 use near_sdk::{
-    env, ext_contract, log, near_bindgen, AccountId, Balance, Gas, PanicOnDefault,
-    PromiseOrValue,
+    env, ext_contract, log, near_bindgen, AccountId, Gas, PanicOnDefault, PromiseOrValue,
 };
 
 const BASE_GAS: u64 = 5_000_000_000_000;
 const PROMISE_CALL: u64 = 5_000_000_000_000;
 const GAS_FOR_NFT_ON_APPROVE: Gas = Gas(BASE_GAS + PROMISE_CALL);
 
-const NO_DEPOSIT: Balance = 0;
-
 #[near_bindgen]
 #[derive(BorshDeserialize, BorshSerialize, PanicOnDefault)]
 pub struct ApprovalReceiver {
@@ -73,7 +70,8 @@ impl NonFungibleTokenApprovalReceiver for ApprovalReceiver {
             _ => {
                 let prepaid_gas = env::prepaid_gas();
                 let account_id = env::current_account_id();
-                ext_self::ok_go(msg, account_id, NO_DEPOSIT, prepaid_gas - GAS_FOR_NFT_ON_APPROVE)
+                ext_self::ok_go(msg, account_id)
+                    .with_gas(prepaid_gas - GAS_FOR_NFT_ON_APPROVE)
                     .into()
             }
         }

examples/non-fungible-token/test-token-receiver/src/lib.rs

@@ -5,16 +5,13 @@ use near_contract_standards::non_fungible_token::core::NonFungibleTokenReceiver;
 use near_contract_standards::non_fungible_token::TokenId;
 use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
 use near_sdk::{
-    env, ext_contract, log, near_bindgen, AccountId, Balance, Gas, PanicOnDefault,
-    PromiseOrValue,
+    env, ext_contract, log, near_bindgen, AccountId, Gas, PanicOnDefault, PromiseOrValue,
 };
 
 const BASE_GAS: u64 = 5_000_000_000_000;
 const PROMISE_CALL: u64 = 5_000_000_000_000;
 const GAS_FOR_NFT_ON_TRANSFER: Gas = Gas(BASE_GAS + PROMISE_CALL);
 
-const NO_DEPOSIT: Balance = 0;
-
 #[near_bindgen]
 #[derive(BorshDeserialize, BorshSerialize, PanicOnDefault)]
 pub struct TokenReceiver {
@@ -74,25 +71,17 @@ impl NonFungibleTokenReceiver for TokenReceiver {
             "return-it-later" => {
                 let prepaid_gas = env::prepaid_gas();
                 let account_id = env::current_account_id();
-                ext_self::ok_go(
-                    true,
-                    account_id,
-                    NO_DEPOSIT,
-                    prepaid_gas - GAS_FOR_NFT_ON_TRANSFER,
-                )
-                .into()
+                ext_self::ok_go(true, account_id)
+                    .with_gas(prepaid_gas - GAS_FOR_NFT_ON_TRANSFER)
+                    .into()
             }
             "keep-it-now" => PromiseOrValue::Value(false),
             "keep-it-later" => {
                 let prepaid_gas = env::prepaid_gas();
                 let account_id = env::current_account_id();
-                ext_self::ok_go(
-                    false,
-                    account_id,
-                    NO_DEPOSIT,
-                    prepaid_gas - GAS_FOR_NFT_ON_TRANSFER,
-                )
-                .into()
+                ext_self::ok_go(false, account_id)
+                    .with_gas(prepaid_gas - GAS_FOR_NFT_ON_TRANSFER)
+                    .into()
             }
             _ => env::panic_str("unsupported msg"),
         }

near-contract-standards/src/fungible_token/core_impl.rs

@@ -11,8 +11,6 @@ use near_sdk::{
 const GAS_FOR_RESOLVE_TRANSFER: Gas = Gas(5_000_000_000_000);
 const GAS_FOR_FT_TRANSFER_CALL: Gas = Gas(25_000_000_000_000 + GAS_FOR_RESOLVE_TRANSFER.0);
 
-const NO_DEPOSIT: Balance = 0;
-
 #[ext_contract(ext_self)]
 trait FungibleTokenResolver {
     fn ft_resolve_transfer(
@@ -176,17 +174,19 @@ impl FungibleTokenCore for FungibleToken {
             amount.into(),
             msg,
             receiver_id.clone(),
-            NO_DEPOSIT,
-            env::prepaid_gas() - GAS_FOR_FT_TRANSFER_CALL,
         )
-        .then(ext_self::ft_resolve_transfer(
-            sender_id,
-            receiver_id,
-            amount.into(),
-            env::current_account_id(),
-            NO_DEPOSIT,
-            GAS_FOR_RESOLVE_TRANSFER,
-        ))
+        .with_gas(env::prepaid_gas() - GAS_FOR_FT_TRANSFER_CALL)
+        .into_promise()
+        .then(
+            ext_self::ft_resolve_transfer(
+                sender_id,
+                receiver_id,
+                amount.into(),
+                env::current_account_id(),
+            )
+            .with_gas(GAS_FOR_RESOLVE_TRANSFER)
+            .into_promise(),
+        )
         .into()
     }
 

near-contract-standards/src/non_fungible_token/approval/approval_impl.rs

@@ -7,10 +7,9 @@ use crate::non_fungible_token::utils::{
     refund_approved_account_ids_iter, refund_deposit,
 };
 use crate::non_fungible_token::NonFungibleToken;
-use near_sdk::{assert_one_yocto, env, ext_contract, AccountId, Balance, Gas, Promise};
+use near_sdk::{assert_one_yocto, env, ext_contract, AccountId, Gas, Promise};
 
 const GAS_FOR_NFT_APPROVE: Gas = Gas(10_000_000_000_000);
-const NO_DEPOSIT: Balance = 0;
 
 fn expect_token_found<T>(option: Option<T>) -> T {
     option.unwrap_or_else(|| env::panic_str("Token not found"))
@@ -69,15 +68,9 @@ impl NonFungibleTokenApproval for NonFungibleToken {
 
         // if given `msg`, schedule call to `nft_on_approve` and return it. Else, return None.
         msg.map(|msg| {
-            ext_approval_receiver::nft_on_approve(
-                token_id,
-                owner_id,
-                approval_id,
-                msg,
-                account_id,
-                NO_DEPOSIT,
-                env::prepaid_gas() - GAS_FOR_NFT_APPROVE,
-            )
+            ext_approval_receiver::nft_on_approve(token_id, owner_id, approval_id, msg, account_id)
+                .with_gas(env::prepaid_gas() - GAS_FOR_NFT_APPROVE)
+                .into()
         })
     }
 

near-contract-standards/src/non_fungible_token/core/core_impl.rs

@@ -9,16 +9,14 @@ use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize};
 use near_sdk::collections::{LookupMap, TreeMap, UnorderedSet};
 use near_sdk::json_types::Base64VecU8;
 use near_sdk::{
-    assert_one_yocto, env, ext_contract, log, AccountId, Balance, BorshStorageKey, CryptoHash, Gas,
+    assert_one_yocto, env, ext_contract, log, AccountId, BorshStorageKey, CryptoHash, Gas,
     IntoStorageKey, PromiseOrValue, PromiseResult, StorageUsage,
 };
 use std::collections::HashMap;
 
 const GAS_FOR_RESOLVE_TRANSFER: Gas = Gas(5_000_000_000_000);
 const GAS_FOR_FT_TRANSFER_CALL: Gas = Gas(25_000_000_000_000 + GAS_FOR_RESOLVE_TRANSFER.0);
 
-const NO_DEPOSIT: Balance = 0;
-
 #[ext_contract(ext_self)]
 trait NFTResolver {
     fn nft_resolve_transfer(
@@ -312,18 +310,20 @@ impl NonFungibleTokenCore for NonFungibleToken {
             token_id.clone(),
             msg,
             receiver_id.clone(),
-            NO_DEPOSIT,
-            env::prepaid_gas() - GAS_FOR_FT_TRANSFER_CALL,
         )
-        .then(ext_self::nft_resolve_transfer(
-            old_owner,
-            receiver_id,
-            token_id,
-            old_approvals,
-            env::current_account_id(),
-            NO_DEPOSIT,
-            GAS_FOR_RESOLVE_TRANSFER,
-        ))
+        .with_gas(env::prepaid_gas() - GAS_FOR_FT_TRANSFER_CALL)
+        .into_promise()
+        .then(
+            ext_self::nft_resolve_transfer(
+                old_owner,
+                receiver_id,
+                token_id,
+                old_approvals,
+                env::current_account_id(),
+            )
+            .with_gas(GAS_FOR_RESOLVE_TRANSFER)
+            .into(),
+        )
         .into()
     }
 

near-sdk-macros/src/core_impl/code_generator/impl_item_method_info.rs

@@ -133,9 +133,11 @@ impl ImplItemMethodInfo {
                     };
                     quote! {
                     #contract_deser
-                    let result = #method_invocation;
-                    #value_ser
-                    near_sdk::env::value_return(&result);
+                    {
+                        let result = #method_invocation;
+                        #value_ser
+                        near_sdk::env::value_return(&result);
+                    }
                     #contract_ser
                     }
                 }
@@ -147,6 +149,10 @@ impl ImplItemMethodInfo {
                 #value
             }
         });
+
+        let schedule_function_calls = quote! {
+            near_sdk::schedule_queued_promises();
+        };
         quote! {
             #non_bindgen_attrs
             #[cfg(target_arch = "wasm32")]
@@ -160,6 +166,7 @@ impl ImplItemMethodInfo {
                 #callback_deser
                 #callback_vec_deser
                 #body
+                #schedule_function_calls
             }
         }
     }