Change Transaction/PendingTransaction behaviors

CHANGELOG.md

@@ -19,11 +19,13 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Breaking changes
 
-- Fixed parity between `Mina.LocalBlockchain` and `Mina.Network` to have the same behaviors https://github.com/o1-labs/o1js/pull/1422
+- Fixed parity between `Mina.LocalBlockchain` and `Mina.Network` to have the same behaviors https://github.com/o1-labs/o1js/pull/1422 https://github.com/o1-labs/o1js/pull/1480
   - Changed the `TransactionId` type to `Transaction`. Additionally added `PendingTransaction` and `RejectedTransaction` types to better represent the state of a transaction.
-  - `transaction.send()` no longer throws an error if the transaction was not successful for `Mina.LocalBlockchain` and `Mina.Network`. Instead, it returns a `PendingTransaction` object that contains the error. Use `transaction.sendOrThrowIfError` to throw the error if the transaction was not successful.
-  - `transaction.wait()` no longer throws an error if the transaction was not successful for `Mina.LocalBlockchain` and `Mina.Network`. Instead, it returns either a `IncludedTransaction` or `RejectedTransaction`. Use `transaction.waitOrThrowIfError` to throw the error if the transaction was not successful.
+  - `Transaction.safeSend()` and `PendingTransaction.safeWait()` are introduced to return a `IncludedTransaction` or `RejectedTransaction` object without throwing errors.
+  - `transaction.send()` throws an error if the transaction was not successful for both `Mina.LocalBlockchain` and `Mina.Network` and returns a `PendingTransaction` object if it was successful. Use `transaction.safeSend` to send a transaction that will not throw an error and either return a `PendingTransaction` or `RejectedTransaction`.
+  - `transaction.wait()` throws an error if the transaction was not successful for both `Mina.LocalBlockchain` and `Mina.Network` and returns a `IncludedTransaction` object if it was successful. Use `transaction.safeWait` to send a transaction that will not throw an error and either return a `IncludedTransaction` or `RejectedTransaction`.
   - `transaction.hash()` is no longer a function, it is now a property that returns the hash of the transaction.
+  - Changed `Transaction.isSuccess` to `Transaction.status` to better represent the state of a transaction.
 - Improved efficiency of computing `AccountUpdate.callData` by packing field elements into as few field elements as possible https://github.com/o1-labs/o1js/pull/1458
   - This leads to a large reduction in the number of constraints used when inputs to a zkApp method are many field elements (e.g. a long list of `Bool`s)
 - Return events in the `LocalBlockchain` in reverse chronological order (latest events at the beginning) to match the behavior of the `Network` https://github.com/o1-labs/o1js/pull/1460

src/examples/zkapps/dex/run-live.ts

@@ -286,7 +286,7 @@ async function ensureFundedAccount(privateKeyBase58: string) {
 }
 
 function logPendingTransaction(pendingTx: Mina.PendingTransaction) {
-  if (!pendingTx.isSuccess) throw Error('transaction failed');
+  if (pendingTx.status === 'rejected') throw Error('transaction failed');
   console.log(
     'tx sent: ' +
       (useCustomLocalNetwork

src/examples/zkapps/dex/run.ts

@@ -237,9 +237,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
         (USER_DX * oldBalances.total.lqXY) / oldBalances.dex.X
     );
   } else {
-    await expect(tx.sendOrThrowIfError()).rejects.toThrow(
-      /Update_not_permitted_timing/
-    );
+    await expect(tx.send()).rejects.toThrow(/Update_not_permitted_timing/);
   }
 
   /**
@@ -254,14 +252,14 @@ async function main({ withVesting }: { withVesting: boolean }) {
   });
   await tx.prove();
   tx.sign([keys.user2]);
-  await expect(tx.sendOrThrowIfError()).rejects.toThrow(/Overflow/);
+  await expect(tx.send()).rejects.toThrow(/Overflow/);
   console.log('supplying with insufficient tokens (should fail)');
   tx = await Mina.transaction(addresses.user, () => {
     dex.supplyLiquidityBase(UInt64.from(1e9), UInt64.from(1e9));
   });
   await tx.prove();
   tx.sign([keys.user]);
-  await expect(tx.sendOrThrowIfError()).rejects.toThrow(/Overflow/);
+  await expect(tx.send()).rejects.toThrow(/Overflow/);
 
   /**
    * - Resulting operation will overflow the SC’s receiving token by type or by any other applicable limits;
@@ -280,7 +278,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
     );
   });
   await tx.prove();
-  await tx.sign([feePayerKey, keys.tokenY]).sendOrThrowIfError();
+  await tx.sign([feePayerKey, keys.tokenY]).send();
   console.log('supply overflowing liquidity');
   await expect(async () => {
     tx = await Mina.transaction(addresses.tokenX, () => {
@@ -291,7 +289,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
     });
     await tx.prove();
     tx.sign([keys.tokenX]);
-    await tx.sendOrThrowIfError();
+    await tx.send();
   }).rejects.toThrow();
 
   /**
@@ -318,7 +316,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
     dex.supplyLiquidity(UInt64.from(10));
   });
   await tx.prove();
-  await expect(tx.sign([keys.tokenX]).sendOrThrowIfError()).rejects.toThrow(
+  await expect(tx.sign([keys.tokenX]).send()).rejects.toThrow(
     /Update_not_permitted_balance/
   );
 
@@ -345,9 +343,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
     });
     await tx.prove();
     tx.sign([keys.user]);
-    await expect(tx.sendOrThrowIfError()).rejects.toThrow(
-      /Source_minimum_balance_violation/
-    );
+    await expect(tx.send()).rejects.toThrow(/Source_minimum_balance_violation/);
 
     // another slot => now it should work
     Local.incrementGlobalSlot(1);
@@ -456,7 +452,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
   });
   await tx.prove();
   tx.sign([keys.user, keys.user2]);
-  await expect(tx.sendOrThrowIfError()).rejects.toThrow(
+  await expect(tx.send()).rejects.toThrow(
     /Account_balance_precondition_unsatisfied/
   );
 
@@ -491,9 +487,7 @@ async function main({ withVesting }: { withVesting: boolean }) {
     dex.redeemLiquidity(UInt64.from(1n));
   });
   await tx.prove();
-  await expect(tx.sign([keys.user2]).sendOrThrowIfError()).rejects.toThrow(
-    /Overflow/
-  );
+  await expect(tx.sign([keys.user2]).send()).rejects.toThrow(/Overflow/);
   [oldBalances, balances] = [balances, getTokenBalances()];
 
   /**

src/examples/zkapps/dex/upgradability.ts

@@ -123,9 +123,9 @@ async function atomicActionsTest({ withVesting }: { withVesting: boolean }) {
   });
   await tx.prove();
 
-  await expect(
-    tx.sign([feePayerKey, keys.dex]).sendOrThrowIfError()
-  ).rejects.toThrow(/Cannot update field 'delegate'/);
+  await expect(tx.sign([feePayerKey, keys.dex]).send()).rejects.toThrow(
+    /Cannot update field 'delegate'/
+  );
 
   console.log('changing delegate permission back to normal');
 
@@ -185,9 +185,9 @@ async function atomicActionsTest({ withVesting }: { withVesting: boolean }) {
     fieldUpdate.requireSignature();
   });
   await tx.prove();
-  await expect(
-    tx.sign([feePayerKey, keys.dex]).sendOrThrowIfError()
-  ).rejects.toThrow(/Cannot update field 'delegate'/);
+  await expect(tx.sign([feePayerKey, keys.dex]).send()).rejects.toThrow(
+    /Cannot update field 'delegate'/
+  );
 
   /**
    * # Atomic Actions 3
@@ -461,9 +461,9 @@ async function upgradeabilityTests({ withVesting }: { withVesting: boolean }) {
     modifiedDex.deploy(); // cannot deploy new VK because its forbidden
   });
   await tx.prove();
-  await expect(
-    tx.sign([feePayerKey, keys.dex]).sendOrThrowIfError()
-  ).rejects.toThrow(/Cannot update field 'verificationKey'/);
+  await expect(tx.sign([feePayerKey, keys.dex]).send()).rejects.toThrow(
+    /Cannot update field 'verificationKey'/
+  );
 
   console.log('trying to invoke modified swap method');
   // method should still be valid since the upgrade was forbidden

src/examples/zkapps/hello-world/run-live.ts

@@ -59,7 +59,7 @@ let transaction = await Mina.transaction(
 transaction.sign([senderKey, zkAppKey]);
 console.log('Sending the transaction.');
 let pendingTx = await transaction.send();
-if (pendingTx.hash !== undefined) {
+if (pendingTx.status === 'pending') {
   console.log(`Success! Deploy transaction sent.
 Your smart contract will be deployed
 as soon as the transaction is included in a block.
@@ -77,7 +77,7 @@ transaction = await Mina.transaction({ sender, fee: transactionFee }, () => {
 await transaction.sign([senderKey]).prove();
 console.log('Sending the transaction.');
 pendingTx = await transaction.send();
-if (pendingTx.hash !== undefined) {
+if (pendingTx.status === 'pending') {
   console.log(`Success! Update transaction sent.
 Your smart contract state will be updated
 as soon as the transaction is included in a block.

src/examples/zkapps/hello-world/run.ts

@@ -27,7 +27,7 @@ txn = await Mina.transaction(feePayer1.publicKey, () => {
   AccountUpdate.fundNewAccount(feePayer1.publicKey);
   zkAppInstance.deploy();
 });
-await txn.sign([feePayer1.privateKey, zkAppPrivateKey]).sendOrThrowIfError();
+await txn.sign([feePayer1.privateKey, zkAppPrivateKey]).send();
 
 const initialState =
   Mina.getAccount(zkAppAddress).zkapp?.appState?.[0].toString();
@@ -45,7 +45,7 @@ txn = await Mina.transaction(feePayer1.publicKey, () => {
   zkAppInstance.update(Field(4), adminPrivateKey);
 });
 await txn.prove();
-await txn.sign([feePayer1.privateKey]).sendOrThrowIfError();
+await txn.sign([feePayer1.privateKey]).send();
 
 currentState = Mina.getAccount(zkAppAddress).zkapp?.appState?.[0].toString();
 
@@ -70,7 +70,7 @@ try {
     zkAppInstance.update(Field(16), wrongAdminPrivateKey);
   });
   await txn.prove();
-  await txn.sign([feePayer1.privateKey]).sendOrThrowIfError();
+  await txn.sign([feePayer1.privateKey]).send();
 } catch (err: any) {
   handleError(err, 'Account_delegate_precondition_unsatisfied');
 }
@@ -91,7 +91,7 @@ try {
     zkAppInstance.update(Field(30), adminPrivateKey);
   });
   await txn.prove();
-  await txn.sign([feePayer1.privateKey]).sendOrThrowIfError();
+  await txn.sign([feePayer1.privateKey]).send();
 } catch (err: any) {
   handleError(err, 'assertEquals');
 }
@@ -118,7 +118,7 @@ try {
     }
   );
   await txn.prove();
-  await txn.sign([feePayer1.privateKey]).sendOrThrowIfError();
+  await txn.sign([feePayer1.privateKey]).send();
 } catch (err: any) {
   handleError(err, 'assertEquals');
 }
@@ -134,7 +134,7 @@ txn2 = await Mina.transaction({ sender: feePayer2.publicKey, fee: '2' }, () => {
   zkAppInstance.update(Field(16), adminPrivateKey);
 });
 await txn2.prove();
-await txn2.sign([feePayer2.privateKey]).sendOrThrowIfError();
+await txn2.sign([feePayer2.privateKey]).send();
 
 currentState = Mina.getAccount(zkAppAddress).zkapp?.appState?.[0].toString();
 
@@ -151,7 +151,7 @@ txn3 = await Mina.transaction({ sender: feePayer3.publicKey, fee: '1' }, () => {
   zkAppInstance.update(Field(256), adminPrivateKey);
 });
 await txn3.prove();
-await txn3.sign([feePayer3.privateKey]).sendOrThrowIfError();
+await txn3.sign([feePayer3.privateKey]).send();
 
 currentState = Mina.getAccount(zkAppAddress).zkapp?.appState?.[0].toString();
 
@@ -174,7 +174,7 @@ try {
     }
   );
   await txn4.prove();
-  await txn4.sign([feePayer4.privateKey]).sendOrThrowIfError();
+  await txn4.sign([feePayer4.privateKey]).send();
 } catch (err: any) {
   handleError(err, 'assertEquals');
 }

src/lib/account-update.unit-test.ts

@@ -120,7 +120,7 @@ function createAccountUpdate() {
     AccountUpdate.fundNewAccount(feePayer);
   });
   tx.sign();
-  await expect(tx.sendOrThrowIfError()).rejects.toThrow(
+  await expect(tx.send()).rejects.toThrow(
     'Check signature: Invalid signature on fee payer for key'
   );
 }

src/lib/caller.unit-test.ts

@@ -27,6 +27,6 @@ let tx = await Mina.transaction(privateKey, () => {
 });
 
 // according to this test, the child doesn't get token permissions
-await expect(tx.sendOrThrowIfError()).rejects.toThrow(
+await expect(tx.send()).rejects.toThrow(
   'can not use or pass on token permissions'
 );