Examples: Rename to use functions (#28)

Author: PedroAraoz

README.md

@@ -20,7 +20,7 @@
 
 ## Content
 
-This repository provides working examples of tasks that can be automated using Mimic Protocol.
+This repository provides working examples of functions that can be automated using Mimic Protocol.
 
 ## Setup
 

examples/01-simple-transfer/manifest.yaml

@@ -1,3 +1,3 @@
 version: 1.0.0
 name: Simple transfer
-description: Automated task to execute transfers of 1 USDC with 0.1 USDC fee
+description: Automated function to execute transfers of 1 USDC with 0.1 USDC fee

examples/01-simple-transfer/src/task.ts …mples/01-simple-transfer/src/function.tsexamples/01-simple-transfer/src/task.ts renamed to examples/01-simple-transfer/src/function.ts examples/01-simple-transfer/src/task.ts renamed to examples/01-simple-transfer/src/function.ts

@@ -1,9 +1,9 @@
 import { OpType } from '@mimicprotocol/sdk'
-import { Context, runTask, Transfer } from '@mimicprotocol/test-ts'
+import { Context, runFunction, Transfer } from '@mimicprotocol/test-ts'
 import { expect } from 'chai'
 
-describe('Task', () => {
-  const taskDir = './build'
+describe('Function', () => {
+  const functionDir = './build'
 
   const context: Context = {
     user: '0x756f45e3fa69347a9a973a725e3c98bc4db0b5a0',
@@ -12,7 +12,7 @@ describe('Task', () => {
   }
 
   it('produces the expected intents', async () => {
-    const result = await runTask(taskDir, context)
+    const result = await runFunction(functionDir, context)
     expect(result.success).to.be.true
     expect(result.timestamp).to.be.equal(context.timestamp)
 

…es/01-simple-transfer/tests/task.spec.ts …1-simple-transfer/tests/function.spec.tsexamples/01-simple-transfer/tests/task.spec.ts renamed to examples/01-simple-transfer/tests/function.spec.ts examples/01-simple-transfer/tests/task.spec.ts renamed to examples/01-simple-transfer/tests/function.spec.ts

@@ -1,6 +1,6 @@
 version: 1.0.0
 name: Simple transfer with inputs
-description: Automated task to execute parameterized transfers
+description: Automated function to execute parameterized transfers
 inputs:
   - chainId: uint32
   - token: address

examples/02-simple-transfer-with-inputs/manifest.yaml

@@ -1,14 +1,14 @@
 import { fp, OpType, randomEvmAddress } from '@mimicprotocol/sdk'
-import { Context, EvmCallQueryMock, runTask, Transfer } from '@mimicprotocol/test-ts'
+import { Context, EvmCallQueryMock, runFunction, Transfer } from '@mimicprotocol/test-ts'
 import { expect } from 'chai'
 import { Interface } from 'ethers'
 
 import ERC20Abi from '../abis/ERC20.json'
 
 const ERC20Interface = new Interface(ERC20Abi)
 
-describe('Task', () => {
-  const taskDir = './build'
+describe('Function', () => {
+  const functionDir = './build'
 
   const context: Context = {
     user: randomEvmAddress(),
@@ -36,7 +36,7 @@ describe('Task', () => {
   ]
 
   it('produces the expected intents', async () => {
-    const result = await runTask(taskDir, context, { inputs, calls })
+    const result = await runFunction(functionDir, context, { inputs, calls })
     expect(result.success).to.be.true
     expect(result.timestamp).to.be.equal(context.timestamp)
 

…-simple-transfer-with-inputs/src/task.ts …ple-transfer-with-inputs/src/function.tsexamples/02-simple-transfer-with-inputs/src/task.ts renamed to examples/02-simple-transfer-with-inputs/src/function.ts examples/02-simple-transfer-with-inputs/src/task.ts renamed to examples/02-simple-transfer-with-inputs/src/function.ts

@@ -1,6 +1,6 @@
 version: 1.0.0
 name: Transfer based on threshold
-description: Automated task to execute parameterized transfers based on balance threshold
+description: Automated function to execute parameterized transfers based on balance threshold
 inputs:
   - chainId: uint32
   - token: address

…-transfer-with-inputs/tests/task.spec.ts …nsfer-with-inputs/tests/function.spec.tsexamples/02-simple-transfer-with-inputs/tests/task.spec.ts renamed to examples/02-simple-transfer-with-inputs/tests/function.spec.ts examples/02-simple-transfer-with-inputs/tests/task.spec.ts renamed to examples/02-simple-transfer-with-inputs/tests/function.spec.ts

@@ -1,14 +1,14 @@
 import { fp, OpType, randomEvmAddress } from '@mimicprotocol/sdk'
-import { Context, EvmCallQueryMock, runTask, Transfer } from '@mimicprotocol/test-ts'
+import { Context, EvmCallQueryMock, runFunction, Transfer } from '@mimicprotocol/test-ts'
 import { expect } from 'chai'
 import { Interface } from 'ethers'
 
 import ERC20Abi from '../abis/ERC20.json'
 
 const ERC20Interface = new Interface(ERC20Abi)
 
-describe('Task', () => {
-  const taskDir = './build'
+describe('Function', () => {
+  const functionDir = './build'
 
   const context: Context = {
     user: randomEvmAddress(),
@@ -50,7 +50,7 @@ describe('Task', () => {
     const calls = buildCalls(balance)
 
     it('produces the expected intents', async () => {
-      const result = await runTask(taskDir, context, { inputs, calls })
+      const result = await runFunction(functionDir, context, { inputs, calls })
       expect(result.success).to.be.true
       expect(result.timestamp).to.be.equal(context.timestamp)
 
@@ -77,7 +77,7 @@ describe('Task', () => {
     const calls = buildCalls(balance)
 
     it('does not produce any intent', async () => {
-      const result = await runTask(taskDir, context, { inputs, calls })
+      const result = await runFunction(functionDir, context, { inputs, calls })
       expect(result.success).to.be.true
       expect(result.intents).to.be.empty
     })