This project is based on the Chainfusion starter template.
Watch the workshop from DappCon24 to learn more about how it was built.
No matter what setup you pick from below, run ./deploys.sh from the project root to deploy the project. To understand the steps involved in deploying the project locally, examine the comments in deploy.sh. This script will
- start anvil
- start dfx
- deploy the EVM contract
- generate a number of jobs
- deploy the chainfusion canister
If you want to check that the chainfusion_backend really processed the events, you can either look at the logs output by running ./deploy.sh – keep an eye open for the Assets & Metadata successfully generated message – or you can call the EVM contract to get the tokenURI.
To do this, run
cast call --rpc-url=127.0.0.1:8545 0x5fbdb2315678afecb367f032d93f642f64180aa3 "tokenURI(uint256)(string)" <token_id>where <token_id> is the id of the token you want to get the tokenURI for. This should return "http://2222s-4iaaa-aaaaf-ax2uq-cai.localhost:4943/<token_id>" for processed mints and server returned an error response: error code 3: execution reverted: revert: NOT_MINTED for unprocessed mints.
If you want to mint more NFTs, simply run
cast send --rpc-url=127.0.0.1:8545 0x5fbdb2315678afecb367f032d93f642f64180aa3 "mintTo(address)" <mint_to_address> --private-key=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80`You can learn more about how to use cast here.
Make sure you have you have Docker and VS Code installed and running, then click the button below
Make sure that Node.js >= 21, foundry, caddy and dfx >= 0.18 are installed on your system.
Run the following commands in a new, empty project directory:
git clone https://github.com/letmejustputthishere/chainfusion-nft-creator.git # Download this starter project
cd chainfusion-nft-creator # Navigate to the project directoryThis project demonstrates how to use the Internet Computer as a coprocessor for EVM smart contracts. The coprocessor listens to events emitted by an EVM smart contract, processes them, and optionally sends the results back. Note that way say EVM smart contracts, as you can not only interact with the Ethereum network, but other networks that are using the Ethereum Virtual Machine (EVM), such as Polygon and Avalanche.
This is an early project based on the Chainfusion starter template and should be considered as a proof of concept. It is not production-ready and should not be used in production environments. There are quite some TODOs in the code which will be addressed over time. If you have any questions or suggestions, feel free to open an issue, start a discussion or reach out to me on the DFINITY Developer Forum or X.
The concept of coprocessors originated in computer architecture as a technique to enhance performance. Traditional computers rely on a single central processing unit (CPU) to handle all computations. However, the CPU became overloaded as workloads grew more complex.
Coprocessors were introduced to offload specific tasks from the CPU to specialized hardware. We see the same happening in the EVM ecosystem. EVM smart contracts, and Ethereum in particular, are a very constrained computing environment. Coprocessors and stateful Layer 2 solutions enable to extend the capabilities of the EVM by offloading specific tasks to more powerful environments.
You can read more about coprocessors in the context of Ethereum in the article "A Brief Into to Coprocessors". The first paragraph of this section was directly taken from this article.
Canister smart contracts on ICP can securely read from EVM smart contracts (using HTTPS Outcalls or the EVM RPC canister) and write to them (using Chain-key Signatures, i.e. Threshold ECDSA). Hence, there are no additional parties needed to relay messages between the two networks, and no additional work needs to be done on the EVM side to verify the results of the computation as the EVM smart contract just needs to check for the proper sender.
Furthermore, canister smart contracts have many capabilities and properties that can be leveraged to extend the reach of smart contracts:
- WASM Runtime, which is much more efficient than the EVM, and allows programming in Rust, JavaScript, and other traditional languages (next to Motoko).
- 400 GiB of memory with the cost of storing 1 GiB on-chain for a year only being $5
- Long-running computations that even allow running AI inference.
- HTTPS Outcalls allow canisters to interact with other chains and traditional web services.
- Chain-key signatures allow canisters to sign transactions for other chains, including Ethereum and Bitcoin.
- Timers allow syncing with EVM events and scheduling other tasks.
- Unbiasable randomness provided by the threshold BLS signatures straight from the heart of ICP's Chain-key technology.
- Serve webcontent directly from canisters via the HTTP gateway protocol
- The reverse gas model frees end users from paying for every transaction they perform
- ~1-2 second finality
- Multi-block transactions
For more context on how ICP can extend Ethereum, check out this presentation from EthereumZuri 2024.
There are a number of ways of generating and storing metadata for Ethereum NFTs
Generating
- generate metadata off chain
- if metadata is revealed (therefore
baseURIis set) after the collection sold out, devs can arbitrarily assign rare NFTs to their addresses) - if metadata is public during launch, minting process can be frontrunned to only mint rare NFTs
- you can use the block hash of the block that contains the reveal transaction as an input to a previously released shuffle function
- only drawback is that collection could collude with miner to change block hash in a favorable way, or miner itself has incentive to do so
- still the team could use the time between reveal and metadata upgrades as they have access to the reveal secret
- if metadata is revealed (therefore
- generate metadata on chain
- too expensive
- if done, access to unpredictable randomness is hard
- this can be abused to only mint under conditions that produce rare nfts
- you can use chainlink oracle for randomness, but its expensive
- if done, external data (like the current btc price for example) cannot be included easily
- if done, while generating the metadata itself might be feasible in some cases, generating a JPEG or SVG will most likely not be
Storing
- point from
tokenURIto IPFS (immutable)- metadata and assets are decentralised, but immutable
- point from
tokenURIto centralised server (mutable, but centralised)- metadata and assets can be changed and rewritten, potentially in a nefarious way
- store metadata on chain (too expensive)
- assets are decentralised and their mutability can be expressed in code
The architecture describe in the following section solves the problem of generating and storing metadata and assets for NFTs in a decentralised and secure way, while still providing smart contract controlled mutability, if necessary.
The contract src/foundry/NFT.sol is a simple implementation of a ERC721 contract that emits an Transfer event when the mintTo function is called. The mintTo function accepts an address argument that is used to decide the recipient of the minted NFT and requires a payment of MINT_PRICE ETH. The MINT_PRICE is set to 0.08 ether and the TOTAL_SUPPLY is set to 10_000.
function mintTo(address recipient) public payable returns (uint256) {
if (msg.value != MINT_PRICE) {
revert MintPriceNotPaid();
}
uint256 newTokenId = currentTokenId + 1;
if (newTokenId > TOTAL_SUPPLY) {
revert MaxSupply();
}
currentTokenId = newTokenId;
// this emits the following event
// Transfer(address indexed _from, address indexed _to, uint256 indexed _tokenId);
_safeMint(recipient, newTokenId);
return newTokenId;
}The contract also has a tokenURI function that returns a distinct Uniform Resource Identifier (URI) for a given asset. The _baseURI that is passed as a constructor upon contract creation is set to the URL of the chainfusion canister. The tokenURI function returns the base URI concatenated with the token ID and throws if tokenId is not a valid NFT.
function tokenURI(uint256 tokenId)
public
view
virtual
override
returns (string memory)
{
if (ownerOf(tokenId) == address(0)) {
revert NonExistentTokenURI();
}
return
bytes(baseURI).length > 0
? string(abi.encodePacked(baseURI, tokenId.toString()))
: "";
}The source code of the contract can be found in src/foundry/NFT.sol.
For local deployment of the EVM smart contract and submitting transactions we use foundry. You can take a look at the steps needed to deploy the contract locally in the deploy.sh script which runs script/NFT.s.sol. Make sure to check both files to understand the deployment process.
The chainfusion_backend canister listens to events emitted by the Ethereum smart contract by periodically calling the eth_getLogs RPC method via the EVM RPC canister. When an event is received, the canister can do all kinds of synchronous and asynchronous processing. In this project, the chainfusion canister leverages the unbiasable randomness provided by the ICP to randomly generate metadata and assets for an NFT – fully on-chain. You can learn more about how the EVM RPC canister works and how to integrate with it here.
The logic for the job that is run on each event can be found in src/chainfusion_backend/job.rs. You can find the code for the generators in src/chainfusion_backend/src/job/generators.rs.
pub async fn job(event_source: LogSource, event: LogEntry) {
mutate_state(|s| s.record_processed_log(event_source.clone()));
// because we deploy the canister with topics only matching
// Transfer events with the from topic set to the zero address
// we can safely assume that the event is a mint event.
let mint_event = MintEvent::from(event);
// we get secure random bytes from the IC to seed the RNG
// for every mint event.
// you can read more [here](https://internetcomputer.org/docs/current/developer-docs/smart-contracts/advanced-features/randomness/)
let random_bytes = get_random_bytes().await;
let mut rng = ChaCha20Rng::from_seed(random_bytes);
// using th random number generator seeded with the on-chain random bytes
// we generate our attributes for the NFT
let attributes = generate_attributes(&mut rng);
// based on the attributes we generate and store the opensea compliant
// metadata in the canisters stable memory.
// canister can currently access 400GB of mutable on-chain storage, you can read more about
// this feature [here](https://internetcomputer.org/docs/current/developer-docs/smart-contracts/maintain/storage/).
generate_and_store_metadata(&mint_event, &attributes);
// last, based on the attributes we generate and store the image in the canisters stable memory.
generate_and_store_image(&mint_event, &attributes);
println!("Assets & Metadata successfully generated: http://2222s-4iaaa-aaaaf-ax2uq-cai.localhost:4943/{:?}", &mint_event.token_id);
}generate_and_store_metadata and generate_and_store_image both use stable memory – in particular the ic-stable-structures crate – to store the metadata and image on-chain. You can read more about stable memory – which currently gives canister on the ICP access to 400 GiB of storage – here and find the implementation in src/chainfusion_backend/src/storage.rs.
The metadata and image for the NFT are served to the web (e.g. browsers) via HTTP without any additional software or tooling necessary. You can find the logic for this in src/chainfusion_backend/src/lib.rs
#[ic_cdk::query]
fn http_request(req: HttpRequest) -> HttpResponse {
// disable update calls for this method
if ic_cdk::api::data_certificate().is_none() {
ic_cdk::trap("update call rejected");
}
// check if the asset is in the stable memory
if let Some(asset) = storage::get_asset(&req.path().to_string()) {
let mut response_builder = HttpResponseBuilder::ok();
// Apply headers
for (key, value) in asset.headers {
response_builder = response_builder.header(key, value);
}
// Set body and content length, then build the response
response_builder
.with_body_and_content_length(asset.body)
.build()
} else {
// return 404
HttpResponseBuilder::not_found().build()
}
}The Chainfusion canister has been structured in a way that all the coprocessing logic lives in src/chainfusion_backend/src/job.rs and developers don't need to recreate or touch the code responsible for fetching new events, creating signatures or sending transactions. They can solely focus on writing jobs to run upon receiving a new event from an EVM smart contract.
You can find the full flow for this use-case in the following sequence diagram with Ethereum as an example EVM chain (note that this flow can be applied to any EVM chain):
Here you can find a number of examples leveraging the Chainfusion starter logic:
- On-chain asset and metadata creation for ERC721 NFT contracts (this project)
Build your own use-case on top of the Chainfusion starter and share it with the community! Some ideas you could explore:
- A referral canister that distributes rewards to users based on their interactions with an EVM smart contract
- A ckNFT canister that mints an NFT on the ICP when an EVM helper smart contract emits an
ReceivedNft, similar to theEthDepositHelpercontract the ckETH minter uses. This could enable users to trade NFTs on the ICP without having to pay gas fees on Ethereum.