Merge pull request #47 from algorandfoundation/fix/docs-typos

fix: typo in docs and remove unnecessary calls to Uint64 function

Author: boblat

docs/code/index/functions/addEqualityTesters.md

@@ -8,7 +8,7 @@
 
 > **addEqualityTesters**(`params`): `void`
 
-Defined in: [src/set-up.ts:141](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/src/set-up.ts#L141)
+Defined in: [src/set-up.ts:159](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/src/set-up.ts#L159)
 
 Adds custom equality testers for Algorand types to vitest's expect function.
 This allows vitest to properly compare Algorand types such as uint64, biguint, and bytes

docs/testing-guide/avm-types.md

@@ -76,14 +76,14 @@ const asset = algots.Asset(1001)
 const randomAsset = ctx.any.asset({
   clawback: ctx.any.account(), // Optional: Clawback address
   creator: ctx.any.account(), // Optional: Creator account
-  decimals: algots.Uint64(6), // Optional: Number of decimals
+  decimals: 6, // Optional: Number of decimals
   defaultFrozen: false, // Optional: Default frozen state
   freeze: ctx.any.account(), // Optional: Freeze address
   manager: ctx.any.account(), // Optional: Manager address
   metadataHash: ctx.any.bytes(32), // Optional: Metadata hash
   name: algots.Bytes(ctx.any.string()), // Optional: Asset name
   reserve: ctx.any.account(), // Optional: Reserve address
-  total: algots.Uint64(1000000), // Optional: Total supply
+  total: 1000000, // Optional: Total supply
   unitName: algots.Bytes(ctx.any.string()), // Optional: Unit name
   url: algots.Bytes(ctx.any.string()), // Optional: Asset URL
 })
@@ -95,14 +95,14 @@ const asset = ctx.ledger.getAsset(randomAsset.id)
 ctx.ledger.patchAssetData(randomAsset, {
   clawback: ctx.any.account(), // Optional: New clawback address
   creator: ctx.any.account(), // Optional: Creator account
-  decimals: algots.Uint64(6), // Optional: New number of decimals
+  decimals: 6, // Optional: New number of decimals
   defaultFrozen: false, // Optional: Default frozen state
   freeze: ctx.any.account(), // Optional: New freeze address
   manager: ctx.any.account(), // Optional: New manager address
   metadataHash: ctx.any.bytes(32), // Optional: New metadata hash
   name: algots.Bytes(ctx.any.string()), // Optional: New asset name
   reserve: ctx.any.account(), // Optional: New reserve address
-  total: algots.Uint64(1000000), // Optional: New total supply
+  total: 1000000, // Optional: New total supply
   unitName: algots.Bytes(ctx.any.string()), // Optional: Unit name
   url: algots.Bytes(ctx.any.string()), // Optional: New asset URL
 })
@@ -171,11 +171,11 @@ const application = algots.Application()
 const randomApp = ctx.any.application({
   approvalProgram: algots.Bytes(''), // Optional: Specify a custom approval program
   clearStateProgram: algots.Bytes(''), // Optional: Specify a custom clear state program
-  globalNumUint: algots.Uint64(1), // Optional: Number of global uint values
-  globalNumBytes: algots.Uint64(1), // Optional: Number of global byte values
-  localNumUint: algots.Uint64(1), // Optional: Number of local uint values
-  localNumBytes: algots.Uint64(1), // Optional: Number of local byte values
-  extraProgramPages: algots.Uint64(1), // Optional: Number of extra program pages
+  globalNumUint: 1, // Optional: Number of global uint values
+  globalNumBytes: 1, // Optional: Number of global byte values
+  localNumUint: 1, // Optional: Number of local uint values
+  localNumBytes: 1, // Optional: Number of local byte values
+  extraProgramPages: 1, // Optional: Number of extra program pages
   creator: ctx.defaultSender, // Optional: Specify the creator account
 })
 
@@ -187,11 +187,11 @@ ctx.ledger.patchApplicationData(randomApp, {
   application: {
     approvalProgram: algots.Bytes(''), //  Optional: New approval program
     clearStateProgram: algots.Bytes(''), // Optional: New clear state program
-    globalNumUint: algots.Uint64(1), // Optional: New number of global uint values
-    globalNumBytes: algots.Uint64(1), // Optional: New number of global byte values
-    localNumUint: algots.Uint64(1), // Optional: New number of local uint values
-    localNumBytes: algots.Uint64(1), // Optional: New number of local byte values
-    extraProgramPages: algots.Uint64(1), // Optional: New number of extra program pages
+    globalNumUint: 1, // Optional: New number of global uint values
+    globalNumBytes: 1, // Optional: New number of global byte values
+    localNumUint: 1, // Optional: New number of local uint values
+    localNumBytes: 1, // Optional: New number of local byte values
+    extraProgramPages: 1, // Optional: New number of extra program pages
     creator: ctx.defaultSender, // Optional: New creator account
   },
 })

docs/testing-guide/contract-testing.md

@@ -37,7 +37,7 @@ class SimpleVotingContract extends arc4.Contract {
 
   @arc4.abimethod()
   vote(): uint64 {
-    assert(this.voted(Txn.sender).value === Uint64(0), 'Account has already voted')
+    assert(this.voted(Txn.sender).value === 0, 'Account has already voted')
     this.votes.value = this.votes.value + 1
     this.voted(Txn.sender).value = Uint64(1)
     return this.votes.value

docs/testing-guide/opcodes.md

@@ -89,8 +89,8 @@ class MyContract extends arc4.Contract {
 // Create the context manager for snippets below
 const ctx = new TestExecutionContext()
 ctx.ledger.patchGlobalData({
-  minTxnFee: Uint64(1000),
-  minBalance: Uint64(100000),
+  minTxnFee: 1000,
+  minBalance: 100000,
 })
 
 const contract = ctx.contract.create(MyContract)
@@ -140,7 +140,7 @@ class AssetContract extends arc4.Contract {
 const ctx = new TestExecutionContext()
 
 const contract = ctx.contract.create(AssetContract)
-const asset = ctx.any.asset({ total: Uint64(1000000) })
+const asset = ctx.any.asset({ total: 1000000 })
 const account = ctx.any.account({ optedAssetBalances: new Map([[asset.id, Uint64(5000)]]) })
 
 const result = contract.checkAssetHolding(account, asset)
@@ -215,7 +215,7 @@ class AccountParamsContract extends arc4.Contract {
 const ctx = new TestExecutionContext()
 
 const contract = ctx.contract.create(AccountParamsContract)
-const account = ctx.any.account({ balance: Uint64(1000000) })
+const account = ctx.any.account({ balance: 1000000 })
 
 const balance = contract.getAccountBalance(account)
 expect(balance).toEqual(Uint64(1000000))
@@ -264,7 +264,7 @@ class AssetParamsContract extends arc4.Contract {
 const ctx = new TestExecutionContext()
 
 const contract = ctx.contract.create(AssetParamsContract)
-const asset = ctx.any.asset({ total: Uint64(1000000), decimals: Uint64(6) })
+const asset = ctx.any.asset({ total: 1000000, decimals: 6 })
 const total = contract.getAssetTotal(asset.id)
 expect(total).toEqual(1000000)
 ```

docs/testing-guide/transactions.md

@@ -19,15 +19,15 @@ Refers to test implementation of transaction stubs available under `algots.gtxn.
 const payTxn = ctx.any.txn.payment({
   sender: ctx.any.account(), // Optional: Defaults to context's default sender if not provided
   receiver: ctx.any.account(), // Required
-  amount: algots.Uint64(1000000), // Required
+  amount: 1000000, // Required
 })
 
 // Generate a random asset transfer transaction
 const assetTransferTxn = ctx.any.txn.assetTransfer({
   sender: ctx.any.account(), // Optional: Defaults to context's default sender if not provided
   assetReceiver: ctx.any.account(), // Required
-  xferAsset: ctx.any.asset({ assetId: algots.Uint64(1) }), // Required
-  assetAmount: algots.Uint64(1000), // Required
+  xferAsset: ctx.any.asset({ assetId: 1 }), // Required
+  assetAmount: 1000, // Required
 })
 
 // Generate a random application call transaction
@@ -64,9 +64,9 @@ const keyRegTxn = ctx.any.txn.keyRegistration({
   sender: ctx.any.account(), // Optional: Defaults to context's default sender if not provided
   voteKey: algots.Bytes('vote_pk'), // Optional: Defaults to empty bytes if not provided
   selectionKey: algots.Bytes('selection_pk'), // Optional: Defaults to empty bytes if not provided
-  voteFirst: algots.Uint64(1), // Optional: Defaults to 0 if not provided
-  voteLast: algots.Uint64(1000), // Optional: Defaults to 0 if not provided
-  voteKeyDilution: algots.Uint64(10000), // Optional: Defaults to 0 if not provided
+  voteFirst: 1, // Optional: Defaults to 0 if not provided
+  voteLast: 1000, // Optional: Defaults to 0 if not provided
+  voteKeyDilution: 10000, // Optional: Defaults to 0 if not provided
 })
 
 // Generate a random asset freeze transaction
@@ -133,7 +133,7 @@ class MyContract extends arc4.Contract {
     itxn
       .payment({
         receiver: Txn.sender,
-        amount: Uint64(1),
+        amount: 1,
       })
       .submit()
   }

examples/arc4-simple-voting/contract.algo.ts

@@ -12,8 +12,8 @@ export default class VotingContract extends arc4.Contract {
   }
   @arc4.abimethod()
   public vote(pay: gtxn.PaymentTxn): arc4.Bool {
-    assert(op.Global.groupSize === Uint64(2), 'Expected 2 transactions')
-    assert(pay.amount === Uint64(10_000), 'Incorrect payment amount')
+    assert(op.Global.groupSize === 2, 'Expected 2 transactions')
+    assert(pay.amount === 10_000, 'Incorrect payment amount')
     assert(pay.sender === Txn.sender, 'Payment sender must match transaction sender')
 
     if (this.voted(Txn.sender).hasValue) {

examples/arc4-simple-voting/contract.spec.ts

@@ -16,7 +16,7 @@ describe('Voting contract', () => {
     const voter = ctx.defaultSender
     const payment = ctx.any.txn.payment({
       sender: voter,
-      amount: Uint64(10_000),
+      amount: 10_000,
     })
 
     const result = contract.vote(payment)

examples/marketplace/contract.spec.ts

@@ -1,4 +1,4 @@
-import { arc4, Bytes, Uint64 } from '@algorandfoundation/algorand-typescript'
+import { arc4, Bytes } from '@algorandfoundation/algorand-typescript'
 import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
 import { interpretAsArc4 } from '@algorandfoundation/algorand-typescript/arc4'
 import { afterEach } from 'node:test'
@@ -16,19 +16,19 @@ describe('DigitalMarketplace', () => {
 
   test('first deposit', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
 
     // Arrange
     const testApp = ctx.ledger.getApplicationForContract(contract)
 
     // Act
     contract.firstDeposit(
-      ctx.any.txn.payment({ receiver: testApp.address, amount: Uint64(50500) }),
+      ctx.any.txn.payment({ receiver: testApp.address, amount: 50500 }),
       ctx.any.txn.assetTransfer({
         xferAsset: testAsset,
         assetReceiver: testApp.address,
-        assetAmount: Uint64(10),
+        assetAmount: 10,
       }),
       ctx.any.arc4.uintN64(),
       testNonce,
@@ -46,7 +46,7 @@ describe('DigitalMarketplace', () => {
 
   test('deposit', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
 
     // Arrange
@@ -72,7 +72,7 @@ describe('DigitalMarketplace', () => {
       ctx.any.txn.assetTransfer({
         xferAsset: testAsset,
         assetReceiver: testApp.address,
-        assetAmount: Uint64(10),
+        assetAmount: 10,
       }),
       testNonce,
     )
@@ -83,7 +83,7 @@ describe('DigitalMarketplace', () => {
 
   test('setPrice', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
     // Arrange
     const testUnitaryPrice = ctx.any.arc4.uintN64()
@@ -113,7 +113,7 @@ describe('DigitalMarketplace', () => {
 
   test('buy', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
     // Arrange
     const testOwner = new arc4.Address(ctx.defaultSender)
@@ -153,7 +153,7 @@ describe('DigitalMarketplace', () => {
 
   test('withdraw', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
 
     // Arrange
@@ -194,7 +194,7 @@ describe('DigitalMarketplace', () => {
 
   test('bid', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
 
     // Arrange
@@ -245,7 +245,7 @@ describe('DigitalMarketplace', () => {
 
   test('acceptBid', () => {
     const contract = ctx.contract.create(DigitalMarketplace)
-    const testAsset = ctx.any.asset({ decimals: Uint64(TEST_DECIMALS) })
+    const testAsset = ctx.any.asset({ decimals: TEST_DECIMALS })
     const testNonce = ctx.any.arc4.uintN64()
     // Arrange
     const owner = ctx.defaultSender

examples/proof-of-attendance/contract.spec.ts

@@ -1,4 +1,4 @@
-import { Account, Bytes, op, Uint64 } from '@algorandfoundation/algorand-typescript'
+import { Account, Bytes, op } from '@algorandfoundation/algorand-typescript'
 import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
 import { afterEach, describe, expect, it, test } from 'vitest'
 import ProofOfAttendance from './contract.algo'
@@ -64,8 +64,8 @@ describe('ProofOfAttendance', () => {
       assetCloseTo: Account(ZERO_ADDRESS),
       rekeyTo: Account(ZERO_ADDRESS),
       xferAsset: dummyPoa,
-      fee: Uint64(0),
-      assetAmount: Uint64(0),
+      fee: 0,
+      assetAmount: 0,
     })
     ctx.ledger.setBox(contract, keyPrefix.concat(ctx.defaultSender.bytes), op.itob(dummyPoa.id))
 

examples/scratch-storage/contract.algo.ts

@@ -7,7 +7,7 @@ export class ScratchSlotsContract extends arc4.Contract {
   public storeData(): boolean {
     op.Scratch.store(1, Uint64(5))
     op.Scratch.store(2, Bytes('Hello World'))
-    assert(op.Scratch.loadUint64(1) === Uint64(5))
+    assert(op.Scratch.loadUint64(1) === 5)
     assert(op.Scratch.loadBytes(2) === Bytes('Hello World'))
     return true
   }
@@ -16,7 +16,7 @@ export class ScratchSlotsContract extends arc4.Contract {
 @contract({ scratchSlots: [1, 2] })
 export class SimpleScratchSlotsContract extends BaseContract {
   approvalProgram(): uint64 {
-    assert(op.Scratch.loadUint64(1) === Uint64(5))
+    assert(op.Scratch.loadUint64(1) === 5)
     assert(op.Scratch.loadBytes(2) === Bytes('Hello World'))
     return Uint64(1)
   }