Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/retricsu/ckb-hands-on-example
A simple hash lock example to showcase the development of CKB with scripts and the frontend.
https://github.com/retricsu/ckb-hands-on-example
Last synced: about 8 hours ago
JSON representation
A simple hash lock example to showcase the development of CKB with scripts and the frontend.
- Host: GitHub
- URL: https://github.com/retricsu/ckb-hands-on-example
- Owner: RetricSu
- Created: 2024-05-22T04:11:05.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-05-22T14:51:46.000Z (6 months ago)
- Last Synced: 2024-05-22T16:11:08.967Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 85.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CKB-Hands-On
A simple hash lock example to showcase the development of CKB with scripts and the frontend.
> Given a hash, you need to provide its preimage in order to unlock the Lock Script in the transaction
Example: `Hash = blake2b_256(preimage)`
## offckb-template
This is a Minimal Template for CKB Full-Stack Dapps generated by [offckb](https://github.com/RetricSu/offckb).
Offckb does not do the magic. It just wraps the new CKB smart contract template and the CKB javascript Dapp framework into one mono-repo. Under the hook, it uses:
- [ckb-scripts-template](https://github.com/cryptape/ckb-script-templates) for smart contract development
- [next-js](https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app) and [Lumos](https://github.com/ckb-js/lumos) for frontend development
## Smart contract development
By default, this template comes with a single simple smart contract `hello-world`: `contracts/hello-world/src/main.rs`.
The smart contract is written in Rust lang. In order to develop, the following dependencies are required:
- `git`, `make`, `sed`, `bash`, `sha256sum` and others Unix utilities.
- `Rust` with `riscv64 target`: `rustup target add riscv64imac-unknown-none-elf`
- `Clang 16+`
- `cargo-generate`
Check out the ckb-script-templates for more [detail](https://github.com/cryptape/ckb-script-templates/blob/main/README.md#dependencies)
### Usage
add a new smart-contract:
```sh
make generate
```
build smart-contract:
```sh
make build
```
run test:
```sh
make test
```
For more detail, check out [ckb-script-templates](https://github.com/cryptape/ckb-script-templates)
## dApp frontend development
first, enter the frontend workspace:
```sh
cd frontend
```
start the app:
```sh
npm i && npm run dev
```
change the CKB blockchain network:
edit `.env` file:
```bash
NEXT_PUBLIC_NETWORK=devnet # devnet, testnet or mainnet
```
## Deploy to devnet/testnet with offckb
Once you build your smart contracts, you can deploy them to CKB blockchain with [ckb-cli](https://github.com/nervosnetwork/ckb-cli) or any other tools.
If you want to test them in devnet/testnet blockchain, then `offckb` might be the ideal selection.
`offckb` will look for the `offckb.config.ts` file to read config information. so you will need to enter the frontend workspace to do the instruction:
```sh
cd frontend
offckb deploy --network devnet
```
If successfully deployed, you will see the deploy script info for your smart contract recorded in the `offckb.config.ts` file. You can then directly import and use your smart contract in your frontend Dapp like this:
```ts
import offckb from 'offckb.config';
import { CellDep } from '@ckb-lumos/lumos';
const lumosConfig = offckb.lumosConfig;
const myContractDep: CellDep = {
outPoint: {
txHash: lumosConfig.SCRIPTS.YOUR_SCRIPT_NAME!.TX_HASH,
index: lumosConfig.SCRIPTS.YOUR_SCRIPT_NAME!.INDEX,
},
depType: lumosConfig.SCRIPTS.YOUR_SCRIPT_NAME!.DEP_TYPE,
};
```
Every time you deploy a new version of your smart contracts, those script infos will be updated by `offckb` in the `offckb.config.ts` and work out-of-box in your frontend.
You can also deploy smart contracts to the CKB Testnet like this:
```sh
cd frontend
offckb deploy --network testnet
```
and start your frontend Dapp targeting Testnet:
edit `.env` file:
```bash
NEXT_PUBLIC_NETWORK=testnet # devnet, testnet or mainnet
```
```bash
cd frontend
npm run dev
```
Note that the `mainnet` network is not supported in `offckb` since `offckb` is focusing on building a friendly development environment for CKB. To gain better security, it is recommended to use production tools like [ckb-cli](https://github.com/nervosnetwork/ckb-cli) to deploy smart contracts and do transactions for the CKB mainnet.