Merge pull request #91 from algorandfoundation/feat/feedback-features

feat: add stub implementations for additional 1.0 features

Author: boblat

README.md

@@ -169,7 +169,19 @@ After the setup, the examples provided using `vitest` can be converted to work w
 #### Contract Definition
 
 ```typescript
-import { arc4, assert, Bytes, GlobalState, gtxn, LocalState, op, Txn, uint64, Uint64 } from '@algorandfoundation/algorand-typescript'
+import {
+  arc4,
+  assert,
+  Bytes,
+  GlobalState,
+  gtxn,
+  LocalState,
+  op,
+  readonly,
+  Txn,
+  uint64,
+  Uint64,
+} from '@algorandfoundation/algorand-typescript'
 
 export default class VotingContract extends arc4.Contract {
   topic = GlobalState({ initialValue: 'default_topic', key: Bytes('topic') })
@@ -195,7 +207,7 @@ export default class VotingContract extends arc4.Contract {
     return true
   }
 
-  @arc4.abimethod({ readonly: true })
+  @readonly
   public getVotes(): uint64 {
     return this.votes.value
   }
@@ -262,7 +274,7 @@ This example demonstrates key aspects of testing with `algorand-typescript-testi
 
    - Use of `arc4.Contract` as the base class for the contract.
    - ABI methods defined using the `@arc4.abimethod` decorator.
-   - Readonly method annotation with `@arc4.abimethod({readonly: true})`.
+   - Readonly method annotation with `@arc4.abimethod({readonly: true})` or `@readonly`.
 
 2. Testing ARC4 Contracts:
 

docs/coverage.md

@@ -34,7 +34,7 @@ See which `algorand-typescript` stubs are implemented by the `algorand-typescrip
 | Txn                          | Emulated            |
 | Uint64                       | Native              |
 | abiCall                      | Mockable            |
-| arc4EncodedLength            | Native              |
+| sizeOf                       | Native              |
 | compile                      | Mockable            |
 | compileArc4                  | Mockable            |
 | decodeArc4                   | Native              |
@@ -72,6 +72,7 @@ See which `algorand-typescript` stubs are implemented by the `algorand-typescrip
 | arc4.abimethod               | Emulated            |
 | arc4.methodSelector          | Native              |
 | arc4.baremethod              | Emulated            |
+| arc4.readonly                | Emulated            |
 | gtxn.ApplicationCallTxn      | Emulated            |
 | gtxn.AssetConfigTxn          | Emulated            |
 | gtxn.AssetFreezeTxn          | Emulated            |

docs/readme.md

@@ -167,7 +167,19 @@ After the setup, the examples provided using `vitest` can be converted to work w
 #### Contract Definition
 
 ```typescript
-import { arc4, assert, Bytes, GlobalState, gtxn, LocalState, op, Txn, uint64, Uint64 } from '@algorandfoundation/algorand-typescript'
+import {
+  arc4,
+  assert,
+  Bytes,
+  GlobalState,
+  gtxn,
+  LocalState,
+  op,
+  readonly,
+  Txn,
+  uint64,
+  Uint64,
+} from '@algorandfoundation/algorand-typescript'
 
 export default class VotingContract extends arc4.Contract {
   topic = GlobalState({ initialValue: 'default_topic', key: Bytes('topic') })
@@ -193,7 +205,7 @@ export default class VotingContract extends arc4.Contract {
     return true
   }
 
-  @arc4.abimethod({ readonly: true })
+  @readonly
   public getVotes(): uint64 {
     return this.votes.value
   }
@@ -260,7 +272,7 @@ This example demonstrates key aspects of testing with `algorand-typescript-testi
 
    - Use of `arc4.Contract` as the base class for the contract.
    - ABI methods defined using the `@arc4.abimethod` decorator.
-   - Readonly method annotation with `@arc4.abimethod({readonly: true})`.
+   - Readonly method annotation with `@arc4.abimethod({readonly: true})` or `@readonly`.
 
 2. Testing ARC4 Contracts:
 

docs/tg-application-spy.md

@@ -170,7 +170,7 @@ spy.onAbiCall(methodSelector('greet(string)string'), (itxnContext) => {
 **3. Strongly typed ABI calls**
 
 ```ts
-const result = abiCall(Hello.prototype.greet, {
+const result = abiCall<typeof Hello.prototype.greet>({
   appId: app,
   args: ['abi'],
 }).returnValue

docs/tg-contract-testing.md

@@ -47,7 +47,7 @@ class SimpleVotingContract extends arc4.Contract {
     return this.votes.value
   }
 
-  @arc4.abimethod({ readonly: true })
+  @readonly
   getVotes(): uint64 {
     return this.votes.value
   }

docs/tg-transactions.md

@@ -376,7 +376,7 @@ export class Hello extends Contract {
 
 export class HelloFactoryTyped extends Contract {
   test_compile_contract(app: Application) {
-    const result2 = abiCall(Hello.prototype.greet, {
+    const result2 = abiCall<typeof Hello.prototype.greet>({
       appId: app,
       args: ['abi'],
     }).returnValue

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

@@ -1,5 +1,5 @@
 import type { gtxn, uint64 } from '@algorandfoundation/algorand-typescript'
-import { arc4, assert, Bytes, GlobalState, LocalState, op, Txn, Uint64 } from '@algorandfoundation/algorand-typescript'
+import { arc4, assert, Bytes, GlobalState, LocalState, op, readonly, Txn, Uint64 } from '@algorandfoundation/algorand-typescript'
 
 export default class VotingContract extends arc4.Contract {
   topic = GlobalState({ initialValue: Bytes('default_topic'), key: Bytes('topic') })
@@ -25,7 +25,7 @@ export default class VotingContract extends arc4.Contract {
     return new arc4.Bool(true)
   }
 
-  @arc4.abimethod({ readonly: true })
+  @readonly
   public getVotes(): arc4.Uint64 {
     return new arc4.Uint64(this.votes.value)
   }

examples/local-storage/contract.algo.ts

@@ -1,5 +1,5 @@
 import type { Account, bytes, uint64 } from '@algorandfoundation/algorand-typescript'
-import { Bytes, Global, LocalState, Txn, arc4, assert, contract } from '@algorandfoundation/algorand-typescript'
+import { Bytes, Global, LocalState, Txn, arc4, assert, contract, readonly } from '@algorandfoundation/algorand-typescript'
 
 /**
  * A contract demonstrating local storage functionality.
@@ -55,7 +55,7 @@ export default class LocalStorage extends arc4.Contract {
    * - [4] boolean: The value of localBool
    * - [5] Address: The value of localAccount converted to Address type
    */
-  @arc4.abimethod({ readonly: true })
+  @readonly
   public readLocalState(): [uint64, uint64, bytes, string, boolean, arc4.Address] {
     const sender = Txn.sender
     // Convert Account reference type to native Address type for return value

examples/marketplace/contract.algo.ts

@@ -1,5 +1,5 @@
 import type { Asset, gtxn, uint64 } from '@algorandfoundation/algorand-typescript'
-import { arc4, assert, BoxMap, clone, Global, itxn, op, Txn } from '@algorandfoundation/algorand-typescript'
+import { arc4, assert, BoxMap, clone, Global, itxn, op, readonly, Txn } from '@algorandfoundation/algorand-typescript'
 
 export class ListingKey extends arc4.Struct<{
   owner: arc4.Address
@@ -52,7 +52,7 @@ export default class DigitalMarketplace extends arc4.Contract {
     return amountToBePaid
   }
 
-  @arc4.abimethod({ readonly: true })
+  @readonly
   getListingsMbr(): uint64 {
     return this.listingsBoxMbr()
   }

examples/precompiled/precompiled-typed.algo.ts

@@ -2,7 +2,7 @@ import { assert, Contract, Global, itxn, Txn } from '@algorandfoundation/algoran
 import { abiCall, compileArc4, methodSelector } from '@algorandfoundation/algorand-typescript/arc4'
 import {
   Hello,
-  HelloStubbed,
+  type HelloStubbed,
   HelloTemplate,
   HelloTemplateCustomPrefix,
   LargeProgram,
@@ -24,14 +24,15 @@ export class HelloFactoryTyped extends Contract {
     }).returnValue
     assert(result === 'hello world')
 
-    const result2 = abiCall(Hello.prototype.greet, {
+    const result2 = abiCall({
+      method: Hello.prototype.greet,
       appId: app,
       args: ['abi'],
     }).returnValue
 
     assert(result2 === 'hello abi')
 
-    const result3 = abiCall(HelloStubbed.prototype.greet, {
+    const result3 = abiCall<typeof HelloStubbed.prototype.greet>({
       appId: app,
       args: ['stubbed'],
     }).returnValue