Bytecraft and Sylvia
Bytecraft
Introduction
Bytecraft is a WASM smart contract development scaffold, similar to hardhat, the EVM development tool. It can help developers quickly create WASM contract development templates, speed up contract development, deployment and testing.
Installation
Environment installation
Install the rust environment, Node 16 and Node Package Manager (npm).
Note: Node 16 is required here. If the version is different, you can use n or npv to switch the Node version.
Install bytecraft
Create a new project
The contract directory is as follows:
Compile contract
Similar to Solidity, Rust is a statically typed language and requires compilation to determine variable types.
Optimize contract
Wasm contracts have optimization options. Because the wasm virtual machine supports uploading contract files up to 800K at most. If it exceeds this limit, it will fail. Bytecraft has optimization functions to help optimize the size of uploaded contract files.
note：The optimization operation requires opening Docker. Essentially, the original wasm file is taken into Docker for optimized compilation.
Upload contract
Wasm contracts need to upload the contract binary file before deployment, which consumes gas. After uploading the contract, a codeId will be generated. This Id is an accumulated id across the network. If there are contract functions with the same requirements, you can deploy and reuse directly according to the codeId.
Deploy contract
If a single contract is deployed, all operations (compilation, optimization, uploading and deployment) can be performed with one command.
// create task
USAGE
$ bytecraft task:new [TASK]
DESCRIPTION
create new task
//run predefined task
USAGE
$ bytecraft task:run [TASK] [--signer ] [--network ] [--config-path ] [--refs-path
] [--keys-path ]
FLAGS
--config-path= [default: config.json]
--keys-path= [default: keys.js]
--network= [default: localnet]
--refs-path= [default: refs.json]
--signer= [default: test]
DESCRIPTION
run predefined task
//Add reference packages. If it fails, you can switch to git installation （add sylvia = {git = "https://github.com/CosmWasm/sylvia.git"} in cargo.toml）
$ cargo add sylvia@0.3.1
//Install the Sylvia dependencies
$ cargo add sylvia-derive@0.3.1
// Pull the dependent packages in the configuration file
$ cargo build
take initializing the contract as an example
// Official contract initialization
pub fn instantiate(
_deps: DepsMut,
_env: Env,
_info: MessageInfo,
_msg: Empty,
)
// Using sylvia
#[contract] //The first macro definition initializes the contract state.
impl AdminContract {
#[msg(instantiate)] //The second macro definition generates a large number of template files about initializing contract message generation and sending.
pub fn instantiate(&self,
_ctx: (DepsMut, Env, MessageInfo)
) -> StdResult {
Ok(Response::new())
}
}
Taking the transfer function of a 20 token contract as an example
// origin
#[cfg_attr(not(feature = "library"), entry_point)]
pub fn execute(
deps: DepsMut,
env: Env,
info: MessageInfo,
msg: ExecuteMsg,
) -> Result<Response, ContractError> {
match msg {
ExecuteMsg::Transfer { recipient, amount } => {
execute_transfer(deps, env, info, recipient, amount)
}
ExecuteMsg::Burn { amount } => execute_burn(deps, env, info, amount),
ExecuteMsg::Send {
contract,
amount,
msg,
} => execute_send(deps, env, info, contract, amount, msg),
ExecuteMsg::Mint { recipient, amount } => execute_mint(deps, env, info, recipient, amount),
}
// After importing the sylvia library, there is no entry function to match the selection. The function property is defined as an executable function directly using the macro #[msg(exec)]
#[msg(exec)]
fn transfer(
&self,
ctx: ExecCtx,
recipient: String,
amount: Uint128,
) -> Result<Response, ContractError> {
ensure!(
amount != Uint128::zero(),
ContractError::InvalidZeroAmount {}
);
