feat: simplify the starter example (#26)

* feat: remove access modifier from starter hello world contract
* feat: remove some unnecessary config files from the starter template

---------

Co-authored-by: Neil Campbell <neil.campbell@makerx.com.au>

Author: gabrielkuettel

examples/production/smart_contracts/hello_world/contract.algo.ts

@@ -2,10 +2,6 @@ import { Contract } from '@algorandfoundation/algorand-typescript'
 
 export class HelloWorld extends Contract {
   public hello(name: string): string {
-    return `${this.getHello()} ${name}`
-  }
-
-  private getHello() {
-    return 'Hello'
+    return `Hello, ${name}`
   }
 }

examples/production/smart_contracts/hello_world/contract.e2e.spec.ts

@@ -14,14 +14,17 @@ describe('HelloWorld contract', () => {
     })
     registerDebugEventHandlers()
   })
-  beforeEach(localnet.beforeEach)
+  beforeEach(localnet.newScope)
 
   const deploy = async (account: Address) => {
     const factory = localnet.algorand.client.getTypedAppFactory(HelloWorldFactory, {
       defaultSender: account,
     })
 
-    const { appClient } = await factory.deploy({ onUpdate: 'append', onSchemaBreak: 'append' })
+    const { appClient } = await factory.deploy({
+      onUpdate: 'append',
+      onSchemaBreak: 'append',
+    })
     return { client: appClient }
   }
 
@@ -31,7 +34,7 @@ describe('HelloWorld contract', () => {
 
     const result = await client.send.hello({ args: { name: 'World' } })
 
-    expect(result.return).toBe('Hello World')
+    expect(result.return).toBe('Hello, World')
   })
 
   test('simulate says hello with correct budget consumed', async () => {
@@ -43,8 +46,8 @@ describe('HelloWorld contract', () => {
       .hello({ args: { name: 'Jane' } })
       .simulate()
 
-    expect(result.returns[0]).toBe('Hello World')
-    expect(result.returns[1]).toBe('Hello Jane')
+    expect(result.returns[0]).toBe('Hello, World')
+    expect(result.returns[1]).toBe('Hello, Jane')
     expect(result.simulateResponse.txnGroups[0].appBudgetConsumed).toBeLessThan(100)
   })
 })

examples/production/smart_contracts/hello_world/contract.spec.ts

@@ -9,6 +9,6 @@ describe('HelloWorld contract', () => {
 
     const result = contract.hello('Sally')
 
-    expect(result).toBe('Hello Sally')
+    expect(result).toBe('Hello, Sally')
   })
 })

examples/starter/smart_contracts/hello_world/contract.algo.ts

@@ -1,11 +1,7 @@
 import { Contract } from '@algorandfoundation/algorand-typescript'
 
 export class HelloWorld extends Contract {
-  public hello(name: string): string {
-    return `${this.getHello()} ${name}`
-  }
-
-  private getHello() {
-    return 'Hello'
+  hello(name: string): string {
+    return `Hello, ${name}`
   }
 }

template_content/.algokit/generators/create_contract/smart_contracts/{% raw %}{{ contract_name }}{% endraw %}/contract.algo.ts.j2

@@ -1,11 +1,7 @@
 import { Contract } from '@algorandfoundation/algorand-typescript'
 
 export class {{ contract_name.split('_')|map('capitalize')|join }} extends Contract {
-  public hello(name: string): string {
-    return `${this.getHello()} ${name}`
-  }
-
-  private getHello() {
-    return 'Hello'
+  {% if preset_name != 'starter' %}public {% endif %}hello(name: string): string {
+    return `Hello, ${name}`
   }
 }

template_content/.algokit/generators/create_contract/smart_contracts/{% raw %}{{ contract_name }}{% endraw %}/{% raw %}{% if include_tests %}contract.e2e.spec.ts{% endif %}.j2{% endraw %}

@@ -12,7 +12,7 @@ describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () =>
       // traceAll: true,
     })
   })
-  beforeEach(localnet.beforeEach)
+  beforeEach(localnet.newScope)
 
   const deploy = async (account: Address) => {
     const factory = localnet.algorand.client.getTypedAppFactory({{ contract_name.split('_')|map('capitalize')|join }}Factory, {

template_content/.editorconfig

@@ -1,11 +1,7 @@
 import { Contract } from '@algorandfoundation/algorand-typescript'
 
 export class {{ contract_name.split('_')|map('capitalize')|join }} extends Contract {
-  public hello(name: string): string {
-    return `${this.getHello()} ${name}`
-  }
-
-  private getHello() {
-    return 'Hello'
+  {% if preset_name != 'starter' %}public {% endif %}hello(name: string): string {
+    return `Hello, ${name}`
   }
 }

template_content/.npmrc

@@ -14,14 +14,17 @@ describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () =>
     })
     registerDebugEventHandlers()
   })
-  beforeEach(localnet.beforeEach)
+  beforeEach(localnet.newScope)
 
   const deploy = async (account: Address) => {
     const factory = localnet.algorand.client.getTypedAppFactory({{ contract_name.split('_')|map('capitalize')|join }}Factory, {
       defaultSender: account,
     })
 
-    const { appClient } = await factory.deploy({ onUpdate: 'append', onSchemaBreak: 'append' })
+    const { appClient } = await factory.deploy({
+      onUpdate: 'append',
+      onSchemaBreak: 'append',
+    })
     return { client: appClient }
   }
 
@@ -31,7 +34,7 @@ describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () =>
 
     const result = await client.send.hello({ args: { name: 'World' } })
 
-    expect(result.return).toBe('Hello World')
+    expect(result.return).toBe('Hello, World')
   })
 
   test('simulate says hello with correct budget consumed', async () => {
@@ -43,8 +46,8 @@ describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () =>
       .hello({ args: { name: 'Jane' } })
       .simulate()
 
-    expect(result.returns[0]).toBe('Hello World')
-    expect(result.returns[1]).toBe('Hello Jane')
+    expect(result.returns[0]).toBe('Hello, World')
+    expect(result.returns[1]).toBe('Hello, Jane')
     expect(result.simulateResponse.txnGroups[0].appBudgetConsumed).toBeLessThan(100)
   })
 })

template_content/smart_contracts/{{ contract_name }}/contract.algo.ts.jinja

@@ -9,6 +9,6 @@ describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () =>
 
     const result = contract.hello('Sally')
 
-    expect(result).toBe('Hello Sally')
+    expect(result).toBe('Hello, Sally')
   })
 })