https://github.com/onflow/flow-js-testing

Testing framework to enable Cadence testing via a set of JavaScript methods and tools
https://github.com/onflow/flow-js-testing

blockchain cadence javascript smart-contracts testing

Last synced: 2 days ago
JSON representation

Testing framework to enable Cadence testing via a set of JavaScript methods and tools

• Host: GitHub
• URL: https://github.com/onflow/flow-js-testing
• Owner: onflow
• License: apache-2.0
• Created: 2020-10-01T16:48:44.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-27T22:06:21.000Z (about 2 months ago)
• Last Synced: 2024-10-09T20:02:49.909Z (about 1 month ago)
• Topics: blockchain, cadence, javascript, smart-contracts, testing
• Language: JavaScript
• Homepage: https://onflow.org
• Size: 1.35 MB
• Stars: 46
• Watchers: 31
• Forks: 33
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# DEPRECATED

The library is deprecated and is not supported/maintained anymore

Use [Cadence Testing Framework](https://cadence-lang.org/docs/testing-framework) instead



  

    

  

  

  


    Test your Flow applications written in Cadence with ease

    


    Read the docs

    


    


    Report Bug

    ·

    Contribute

    ·

    Installation

  



# JavaScript Testing Framework for Flow Network

This repository contains utility methods which, in conjunction with testing libraries like `Jest`,

can be used to speed up your productivity while building Flow dapps with Cadence.

## Requirements

### Node

We are assuming you are using this framework under Node environment. You will need at least version **12.0.0**

### Emulator

Most of the methods will not work, unless you have Flow Emulator running in the background.

You can install it alongside Flow CLI. Please refer to [Install Flow CLI](https://docs.onflow.org/flow-cli/install)

for instructions.

If you have it already installed, run the `flow init` in your terminal to create `flow.json` config file in the root directory of your tests.

In order to use the emulator within your tests, please refer to the [documentation](https://docs.onflow.org/flow-js-testing/emulator/).

## Playground Integration

Every Playground project has the ability to `export` it's content as a set of files with Cadence template code and

basic test environment "out of the box".

If you want to use this functionality:

- Press "Export" button in the top right corner

- Pick the name of the project - or keep auto-generated version

- Press "Export" button within popup window

Playground will create a `zip` file for you, which you can save wherever you like.