diff --git a/.github/workflows/npm-release.yml b/.github/workflows/npm-release.yml index 15db82eb..d368b414 100644 --- a/.github/workflows/npm-release.yml +++ b/.github/workflows/npm-release.yml @@ -41,10 +41,10 @@ jobs: - name: Install dependencies run: yarn install --ignore-scripts - - name: Build essentials (sdk + helpers) - run: yarn build:essentials + - name: Build + run: yarn build - - name: Create Release PR or Publish (SDK) + - name: Create Release PR or Publish id: changesets uses: changesets/action@v1 with: diff --git a/.gitignore b/.gitignore index 9c97bbd4..a0d218e3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ node_modules dist -.env +.env \ No newline at end of file diff --git a/packages/test-ts/README.md b/packages/test-ts/README.md index 02425a01..333bae1b 100644 --- a/packages/test-ts/README.md +++ b/packages/test-ts/README.md @@ -2,7 +2,7 @@ Mimic Protocol -

Blockchain automation protocol

+

Blockchain development platform

@@ -23,7 +23,7 @@ --- -## Content +## Content This package provides tooling and helpers to write and run tests for Mimic Protocol tasks using TypeScript. It includes: @@ -33,7 +33,7 @@ This package provides tooling and helpers to write and run tests for Mimic Proto ## Setup -To set up this project you'll need [git](https://git-scm.com) and [yarn](https://classic.yarnpkg.com) installed. +To set up this project you'll need [git](https://git-scm.com) and [yarn](https://classic.yarnpkg.com) installed. Install the library from the root of the monorepo: @@ -53,24 +53,24 @@ $ yarn Here’s an example of how to test a Mimic task: ```ts -import { runTask } from '@mimicprotocol/test-ts' -import { expect } from 'chai' +import { runTask } from "@mimicprotocol/test-ts"; +import { expect } from "chai"; -const taskDir = './my-task' -const context = { user: '0x...', settler: '0x...', timestamp: Date.now() } -const inputs = { token: '0x...', amount: '10000000' } +const taskDir = "./my-task"; +const context = { user: "0x...", settler: "0x...", timestamp: Date.now() }; +const inputs = { token: "0x...", amount: "10000000" }; -const intents = await runTask(taskDir, context, { inputs }) +const intents = await runTask(taskDir, context, { inputs }); -expect(intents).to.be.an('array').that.is.not.empty -expect(intents).to.have.lengthOf(1) +expect(intents).to.be.an("array").that.is.not.empty; +expect(intents).to.have.lengthOf(1); -expect(intents[0].type).to.be.equal('transfer') -expect(intents[0].settler).to.be.equal(context.settler) +expect(intents[0].type).to.be.equal("transfer"); +expect(intents[0].settler).to.be.equal(context.settler); -expect(intents[0].transfers).to.have.lengthOf(1) -expect(intents[0].transfers[0].token).to.be.equal(inputs.token) -expect(intents[0].transfers[0].amount).to.be.equal(inputs.amount) +expect(intents[0].transfers).to.have.lengthOf(1); +expect(intents[0].transfers[0].token).to.be.equal(inputs.token); +expect(intents[0].transfers[0].amount).to.be.equal(inputs.amount); ``` For full task testing guide and examples please visit [docs.mimic.fi](https://docs.mimic.fi/) @@ -87,7 +87,6 @@ for the safety of the protocol, please contact us through