Skip to content

Commit

Permalink
update screenshots & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-zwets committed Jun 1, 2024
1 parent b90d56b commit d09ea59
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
# CashScript Playground
The CashScript Playground is a way to write CashScript contracts and immediately interact with them in the browser. It is inspired by Ethereum's Remix, but slightly less feature-rich.
The CashScript Playground is an online IDE for writing CashScript smart contracts and immediately interact with them in the browser. The playground the easiest way to quickly get started with CashScript without any setup. The CashScript playground is inspired by Ethereum's Remix.

In the left panel you can write CashScript contracts and compile them. After compiling, a form is generated to create a new instance of this CashScript contract. It will then display some information about the contract and generate new forms to call contract functions to send BCH transactions. Press the arrow buttons to switch to a wallet view where you can generate wallets for testing purposes.
The CashScript Playground is available at [playground.cashscript.org](https://playground.cashscript.org/).

A live demo is available at [playground.cashscript.org](https://playground.cashscript.org/).
![Featured-screenhot](./screenshots/featured-screenshot.png)

In the left panel you can write CashScript contracts and compile them. After compiling, a contract Artifact is generated which can then be used to initialise an instance of the contract, with specific contract arguments.

## Limitations
Special transaction options such as OP_RETURN, hardcoded fees or relative timelocks are not supported by the playground.

The CashScript-Playground is connected to the Bitcoin Cash chipnet by default, you can get testnet coins from the [testnet faucet](https://tbch.googol.cash/). You can also connect the playground to mainnet but be sure **never to send large amounts** of money to contracts or wallets generated by the CashScript Playground!
The playground also does not support the combining multiple different smart contracts in one transaction.

## Example
![Example-0](./screenshots/nftUnlockedCovenant-0.png)
## Disclaimer

The CashScript-Playground is connected to the Bitcoin Cash chipnet by default, you can get testnet coins from the [testnet faucet](https://tbch.googol.cash/). You can also connect the playground to mainnet but be sure **never to send large amounts** of money to contracts or wallets generated by the CashScript Playground!

![Example-1](./screenshots/nftUnlockedCovenant-1.png)
## ScreenShots
![Screenshot-1](./screenshots/screenshot-1.png)

![Example-2](./screenshots/nftUnlockedCovenant-2.png)
![Screenshot-2](./screenshots/screenshot-2.png)

## Running locally
```
Expand Down
Binary file added screenshots/featured-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed screenshots/nftUnlockedCovenant-0.png
Binary file not shown.
Binary file removed screenshots/nftUnlockedCovenant-1.png
Binary file not shown.
Binary file removed screenshots/nftUnlockedCovenant-2.png
Binary file not shown.
Binary file added screenshots/screenshot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d09ea59

Please sign in to comment.