Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/l00k/devphase
Development tool for Phala Phat contracts.
https://github.com/l00k/devphase
Last synced: 3 months ago
JSON representation
Development tool for Phala Phat contracts.
- Host: GitHub
- URL: https://github.com/l00k/devphase
- Owner: l00k
- License: mit
- Created: 2022-10-06T12:06:04.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T05:30:06.000Z (9 months ago)
- Last Synced: 2024-10-08T15:21:11.373Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.83 MB
- Stars: 11
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-phat-contracts - DevPHAse - Run a Phala local testnet and compile/test Phat Contracts in a development environment. (Resources)
README
# devPHAse
Development tool for Phala Phat contracts.
*Tests for both latest devPHAse and Phala Blockchain release:*
[](https://dl.circleci.com/status-badge/redirect/gh/l00k/devphase/tree/master)
## Features
Tool is heavily inspired by Hardhat (EVM devs should be familiar with it).
I tried to provide as much similar features as possible.
- **Up to date Phala binaries**
By default on each start devPHAse will pull latest Phala binaries (the latest release from official Phala's repo).
- **E2E testing**
Using internally Phala stack (prepared on start) you can test e2e your contracts with minimal cost.
- **Scripting**
Using all devPHAse API you can prepare scripts for common actions like: contract deployment, management, monitoring etc.
- **Type generation**
devPHAse generates type bindings for all structures used in contract, so autosuggestions should be provided by your IDE.
## Requirements
Requirements list for contract (building) commands
- Cargo
`cargo 1.69.0 (6e9a83356 2023-04-12)` *
- Cargo Contract
`cargo-contract-contract 3.0.1-unknown-x86_64-unknown-linux-gnu` *
- Target `wasm32-unknown-unknown`
- Component `rust-src`
`*` - previous versions may also work, but it was not tested
## Install
Depending on how you manage your projects you can:
1. Add devPHAse to your project dependencies (`yarn@^1` / `npm`)
Sadly `yarn@^3` is not supported (check [#4](https://github.com/l00k/devphase/issues/4))
```shell
yarn add -D @devphase/cli
yarn add -D typescript ts-node # required peer dependencies
yarn devphase [command]
```
2. Install it globally and use `npx` to call it.
**Note:** this may be default in Phala's example repos
```shell
npm install -g @devphase/cli
npm install -g typescript ts-node # required peer dependencies
npx @devphase/cli [command]
```
## Usage
Detailed usage described here
[USAGE](./docs/usage.md)
Must read :)
## Sandbox & Examples
In directory `workspaces/xsandbox` there is a template of devphase project.
You can try building and testing contracts.
[workspaces/xsandbox](./workspaces/xsandbox)
Check also `workspaces/xexamples` for more examples.
[workspaces/xexamples](./workspaces/xexamples)
## Commands
I strongly recommned using scripts instead of CLI commands.
[CLI commands index](./docs/cli-commands.md)
## Configuration
[Here is](./docs/config.ts) default configuration.
All values are optional (merged recuresivly)