Align transaction fields to transaction reference spec (#804)

algorand · Aug 11, 2023 · c079c61 · c079c61
1 parent 81ab6eb
commit c079c61
Show file tree

Hide file tree

Showing 32 changed files with 891 additions and 880 deletions.
diff --git a/examples/accounts.ts b/examples/accounts.ts
@@ -42,8 +42,8 @@ async function main() {
   // example: MULTISIG_CREATE
 
   const fundMsigTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: funder.addr,
-    to: multisigAddr,
+    sender: funder.addr,
+    receiver: multisigAddr,
     amount: 1_000_000,
     suggestedParams,
   });
@@ -53,8 +53,8 @@ async function main() {
 
   // example: MULTISIG_SIGN
   const msigTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: multisigAddr,
-    to: funder.addr,
+    sender: multisigAddr,
+    receiver: funder.addr,
     amount: 100,
     suggestedParams,
   });
@@ -88,8 +88,8 @@ async function main() {
   // rekey the original account to the new signer via a payment transaction
   // Note any transaction type can be used to rekey an account
   const rekeyTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct1.addr,
-    to: acct1.addr,
+    sender: acct1.addr,
+    receiver: acct1.addr,
     amount: 0,
     suggestedParams,
     rekeyTo: acct2.addr, // set the rekeyTo field to the new signer
@@ -110,8 +110,8 @@ async function main() {
   // the transaction is from originalAccount, but signed with newSigner private key
 
   const rekeyBack = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct1.addr,
-    to: acct1.addr,
+    sender: acct1.addr,
+    receiver: acct1.addr,
     amount: 0,
     suggestedParams,
     rekeyTo: acct1.addr,

diff --git a/examples/app.ts b/examples/app.ts
@@ -49,7 +49,7 @@ async function main() {
 
   // example: APP_CREATE
   const appCreateTxn = algosdk.makeApplicationCreateTxnFromObject({
-    from: creator.addr,
+    sender: creator.addr,
     approvalProgram: new Uint8Array(compiledApprovalProgram),
     clearProgram: new Uint8Array(compiledClearProgram),
     numGlobalByteSlices,
@@ -78,7 +78,7 @@ async function main() {
 
   // example: APP_OPTIN
   const appOptInTxn = algosdk.makeApplicationOptInTxnFromObject({
-    from: caller.addr,
+    sender: caller.addr,
     appIndex: appId,
     suggestedParams,
   });
@@ -95,7 +95,7 @@ async function main() {
 
   // example: APP_NOOP
   const appNoOpTxn = algosdk.makeApplicationNoOpTxnFromObject({
-    from: caller.addr,
+    sender: caller.addr,
     appIndex: appId,
     suggestedParams,
   });
@@ -113,7 +113,7 @@ async function main() {
   const anotherCaller = accounts[2];
 
   const anotherAppOptInTxn = algosdk.makeApplicationOptInTxnFromObject({
-    from: anotherCaller.addr,
+    sender: anotherCaller.addr,
     appIndex: appId,
     suggestedParams,
   });
@@ -130,7 +130,7 @@ async function main() {
   // example: APP_CALL
   const now = new Date().toString();
   const simpleAddTxn = algosdk.makeApplicationNoOpTxnFromObject({
-    from: caller.addr,
+    sender: caller.addr,
     suggestedParams,
     appIndex: appId,
     appArgs: [new TextEncoder().encode(now)],
@@ -175,7 +175,7 @@ async function main() {
 
   // example: APP_CLOSEOUT
   const appCloseOutTxn = algosdk.makeApplicationCloseOutTxnFromObject({
-    from: caller.addr,
+    sender: caller.addr,
     appIndex: appId,
     suggestedParams,
   });
@@ -198,7 +198,7 @@ async function main() {
   const compiledNewProgram = await compileProgram(algodClient, newProgram);
 
   const appUpdateTxn = algosdk.makeApplicationUpdateTxnFromObject({
-    from: creator.addr,
+    sender: creator.addr,
     suggestedParams,
     appIndex: appId,
     // updates must define both approval and clear programs, even if unchanged
@@ -218,7 +218,7 @@ async function main() {
 
   // example: APP_CLEAR
   const appClearTxn = algosdk.makeApplicationClearStateTxnFromObject({
-    from: anotherCaller.addr,
+    sender: anotherCaller.addr,
     suggestedParams,
     appIndex: appId,
   });
@@ -235,7 +235,7 @@ async function main() {
 
   // example: APP_DELETE
   const appDeleteTxn = algosdk.makeApplicationDeleteTxnFromObject({
-    from: creator.addr,
+    sender: creator.addr,
     suggestedParams,
     appIndex: appId,
   });

diff --git a/examples/asa.ts b/examples/asa.ts
@@ -17,7 +17,7 @@ async function main() {
   // example: ASSET_CREATE
   const suggestedParams = await algodClient.getTransactionParams().do();
   const txn = algosdk.makeAssetCreateTxnWithSuggestedParamsFromObject({
-    from: creator.addr,
+    sender: creator.addr,
     suggestedParams,
     defaultFrozen: false,
     unitName: 'rug',
@@ -61,7 +61,7 @@ async function main() {
   const manager = accounts[1];
 
   const configTxn = algosdk.makeAssetConfigTxnWithSuggestedParamsFromObject({
-    from: creator.addr,
+    sender: creator.addr,
     manager: manager.addr,
     freeze: manager.addr,
     clawback: manager.addr,
@@ -87,8 +87,8 @@ async function main() {
 
   // opt-in is simply a 0 amount transfer of the asset to oneself
   const optInTxn = algosdk.makeAssetTransferTxnWithSuggestedParamsFromObject({
-    from: receiver.addr,
-    to: receiver.addr,
+    sender: receiver.addr,
+    receiver: receiver.addr,
     suggestedParams,
     assetIndex,
     amount: 0,
@@ -101,8 +101,8 @@ async function main() {
 
   // example: ASSET_XFER
   const xferTxn = algosdk.makeAssetTransferTxnWithSuggestedParamsFromObject({
-    from: creator.addr,
-    to: receiver.addr,
+    sender: creator.addr,
+    receiver: receiver.addr,
     suggestedParams,
     assetIndex,
     amount: 1,
@@ -115,11 +115,11 @@ async function main() {
 
   // example: ASSET_FREEZE
   const freezeTxn = algosdk.makeAssetFreezeTxnWithSuggestedParamsFromObject({
-    from: manager.addr,
+    sender: manager.addr,
     suggestedParams,
     assetIndex,
-    // freezeState: false would unfreeze the account's asset holding
-    freezeState: true,
+    // assetFrozen: false would unfreeze the account's asset holding
+    assetFrozen: true,
     // freezeTarget is the account that is being frozen or unfrozen
     freezeTarget: receiver.addr,
   });
@@ -136,10 +136,10 @@ async function main() {
   // example: ASSET_CLAWBACK
   const clawbackTxn = algosdk.makeAssetTransferTxnWithSuggestedParamsFromObject(
     {
-      from: manager.addr,
-      to: creator.addr,
-      // revocationTarget is the account that is being clawed back from
-      revocationTarget: receiver.addr,
+      sender: manager.addr,
+      receiver: creator.addr,
+      // assetSender is the account that is being clawed back from
+      assetSender: receiver.addr,
       suggestedParams,
       assetIndex,
       amount: 1,
@@ -161,8 +161,8 @@ async function main() {
   // any account that can receive the asset.
   // note that closing to the asset creator will always succeed
   const optOutTxn = algosdk.makeAssetTransferTxnWithSuggestedParamsFromObject({
-    from: receiver.addr,
-    to: creator.addr,
+    sender: receiver.addr,
+    receiver: creator.addr,
     closeRemainderTo: creator.addr,
     suggestedParams,
     assetIndex,
@@ -180,7 +180,7 @@ async function main() {
 
   // example: ASSET_DELETE
   const deleteTxn = algosdk.makeAssetDestroyTxnWithSuggestedParamsFromObject({
-    from: manager.addr,
+    sender: manager.addr,
     suggestedParams,
     assetIndex,
   });

diff --git a/examples/atc.ts b/examples/atc.ts
@@ -27,7 +27,7 @@ async function main() {
   const compiledClearProgram = await compileProgram(client, clearProgram);
 
   const createTxn = algosdk.makeApplicationCreateTxnFromObject({
-    from: sender.addr,
+    sender: sender.addr,
     suggestedParams,
     onComplete: algosdk.OnApplicationComplete.NoOpOC,
     approvalProgram: compiledApprovalProgram,
@@ -61,9 +61,9 @@ async function main() {
   // example: ATC_ADD_TRANSACTION
   // construct a transaction
   const paymentTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: sender.addr,
+    sender: sender.addr,
     suggestedParams,
-    to: sender.addr,
+    receiver: sender.addr,
     amount: 1000,
   });
 

diff --git a/examples/atomics.ts b/examples/atomics.ts
@@ -16,15 +16,15 @@ async function main() {
   const suggestedParams = await client.getTransactionParams().do();
 
   const alicesTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct1.addr,
-    to: acct2.addr,
+    sender: acct1.addr,
+    receiver: acct2.addr,
     amount: 1e6,
     suggestedParams,
   });
 
   const bobsTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct2.addr,
-    to: acct1.addr,
+    sender: acct2.addr,
+    receiver: acct1.addr,
     amount: 1e6,
     suggestedParams,
   });

diff --git a/examples/codec.ts b/examples/codec.ts
@@ -35,8 +35,8 @@ async function main() {
 
   // example: CODEC_TRANSACTION_UNSIGNED
   const txn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: sender.addr,
-    to: receiver.addr,
+    sender: sender.addr,
+    receiver: receiver.addr,
     amount: 1e6,
     suggestedParams,
   });

diff --git a/examples/indexer.ts b/examples/indexer.ts
@@ -64,8 +64,8 @@ async function main() {
   const sender = accounts[0];
 
   const txn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: sender.addr,
-    to: sender.addr,
+    sender: sender.addr,
+    receiver: sender.addr,
     amount: 1e6,
     note: new TextEncoder().encode('Hello World!'),
     suggestedParams,

diff --git a/examples/lsig.ts b/examples/lsig.ts
@@ -33,8 +33,8 @@ async function main() {
   // example: LSIG_PASS_ARGS
 
   const fundSmartSigTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: funder.addr,
-    to: smartSig.address(),
+    sender: funder.addr,
+    receiver: smartSig.address(),
     amount: 1e6,
     suggestedParams,
   });
@@ -50,8 +50,8 @@ async function main() {
 
   // example: LSIG_SIGN_FULL
   const smartSigTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: smartSig.address(),
-    to: funder.addr,
+    sender: smartSig.address(),
+    receiver: funder.addr,
     amount: 0.1e6,
     suggestedParams,
   });
@@ -72,8 +72,8 @@ async function main() {
   smartSig.sign(userAccount.privateKey);
 
   const delegatedTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: userAccount.addr,
-    to: funder.addr,
+    sender: userAccount.addr,
+    receiver: funder.addr,
     amount: 0.1e6,
     suggestedParams,
   });

diff --git a/examples/overview.ts b/examples/overview.ts
@@ -22,9 +22,9 @@ async function main() {
   // example: TRANSACTION_PAYMENT_CREATE
   const suggestedParams = await algodClient.getTransactionParams().do();
   const ptxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-    from: acct.addr,
+    sender: acct.addr,
     suggestedParams,
-    to: acct2.addr,
+    receiver: acct2.addr,
     amount: 10000,
     note: new TextEncoder().encode('hello world'),
   });

diff --git a/examples/participation.ts b/examples/participation.ts
@@ -27,12 +27,12 @@ async function main() {
   // create transaction
   const onlineKeyreg = algosdk.makeKeyRegistrationTxnWithSuggestedParamsFromObject(
     {
-      from: addr,
+      sender: addr,
       voteKey,
       selectionKey,
       stateProofKey,
-      voteFirst: params.firstRound,
-      voteLast: params.firstRound + numRounds,
+      voteFirst: params.firstValid,
+      voteLast: params.firstValid + numRounds,
       voteKeyDilution: keyDilution,
       suggestedParams: params,
     }
@@ -47,7 +47,7 @@ async function main() {
   // create keyreg transaction to take this account offline
   const offlineKeyReg = algosdk.makeKeyRegistrationTxnWithSuggestedParamsFromObject(
     {
-      from: addr,
+      sender: addr,
       suggestedParams,
       nonParticipation: true,
     }

diff --git a/examples/utils.ts b/examples/utils.ts
@@ -110,7 +110,7 @@ export async function deployCalculatorApp(
   const clearBin = await compileProgram(algodClient, clearProgram);
   const suggestedParams = await algodClient.getTransactionParams().do();
   const appCreateTxn = algosdk.makeApplicationCreateTxnFromObject({
-    from: creator.addr,
+    sender: creator.addr,
     approvalProgram: approvalBin,
     clearProgram: clearBin,
     numGlobalByteSlices: 0,

diff --git a/src/client/v2/algod/algod.ts b/src/client/v2/algod/algod.ts
@@ -358,8 +358,8 @@ export default class AlgodClient extends ServiceClient {
    * const suggestedParams = await algodClient.getTransactionParams().do();
    * const amountInMicroAlgos = algosdk.algosToMicroalgos(2); // 2 Algos
    * const unsignedTxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({
-   *   from: senderAddress,
-   *   to: receiverAddress,
+   *   sender: senderAddress,
+   *   receiver: receiverAddress,
    *   amount: amountInMicroAlgos,
    *   suggestedParams: suggestedParams,
    * });

diff --git a/src/client/v2/algod/suggestedParams.ts b/src/client/v2/algod/suggestedParams.ts
@@ -14,8 +14,8 @@ export default class SuggestedParamsRequest extends JSONRequest<SuggestedParamsW
     return {
       flatFee: false,
       fee: body.fee,
-      firstRound: body['last-round'],
-      lastRound: body['last-round'] + 1000,
+      firstValid: body['last-round'],
+      lastValid: body['last-round'] + 1000,
       genesisID: body['genesis-id'],
       genesisHash: body['genesis-hash'],
       minFee: body['min-fee'],

diff --git a/src/composer.ts b/src/composer.ts
@@ -458,7 +458,7 @@ export class AtomicTransactionComposer {
 
     const appCall = {
       txn: makeApplicationCallTxnFromObject({
-        from: sender,
+        sender,
         appIndex: appID,
         appArgs: appArgsEncoded,
         accounts: foreignAccounts,