Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 4.96 KB

README.md

File metadata and controls

119 lines (76 loc) · 4.96 KB
Raw

Optimistic SVG NFTs

A Project of the Encode Expert Solidity Bootcamp

208145278-3d7783d3-de17-4b55-95b6-99e40fbe8fcd

This repo shows how to set up an SVG NFT contract so that other NFTs can use it in their SVG code. This leads to an easy composition of SVG NFTs. More information at ERC-4883: Composable SVG NFT

Take a look at SVGNFT.sol. It describes an SVG NFT that is defined by three parameters: color, chubbiness, and mouthLength randomly generated at mint.

It exposes a function:

function renderTokenById(uint256 id) public view returns (string memory)

It returns the relevant SVG that can be embedded in other SVG code for rendering.

Website || Verified SVGNFT on Sepolia

Bootcamp topics utilized:

  • gas optimization
  • assembly
  • proxy pattern
  • advanced tooling (Foundry)
  • implementing Scaffold-ETH 2 (partner workshop)

Team Members (group 3, Discord handles):

  • lostDecade
  • Muhammed Shahinsha Pottayil
  • yassin7254
  • Rainmaker

Built using Scaffold-ETH 2

🏗 Scaffold-ETH 2

Documentation | Website

🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts.

⚙️ Built using NextJS, RainbowKit, foundry, Wagmi, Viem, and Typescript.

  • ✅ Contract Hot Reload: Your frontend auto-adapts to your smart contract as you edit it.
  • 🪝 Custom hooks: Collection of React hooks wrapper around wagmi to simplify interactions with smart contracts with typescript autocompletion.
  • 🧱 Components: Collection of common web3 components to quickly build your frontend.
  • 🔥 Burner Wallet & Local Faucet: Quickly test your application with a burner wallet and local faucet.
  • 🔐 Integration with Wallet Providers: Connect to different wallet providers and interact with the Ethereum network.

Debug Contracts tab

Requirements

Before you begin, you need to install the following tools:

Quickstart

To get started with Scaffold-ETH 2, follow the steps below:

  1. Clone this repo & install dependencies
git clone https://github.com/scaffold-eth/scaffold-eth-2.git
cd scaffold-eth-2
yarn
  1. Run a local network in the first terminal:
yarn chain

This command starts a local Ethereum network using foundry. The network runs on your local machine and can be used for testing and development. You can customize the network configuration in foundry.toml.

  1. In a second terminal, deploy the test contract:
yarn deploy

This command deploys a test smart contract to the local network. The contract is located in packages/foundry/contracts and can be modified to suit your needs. The yarn deploy command uses the deploy script located in packages/foundry/deploy to deploy the contract to the network. You can also customize the deploy script.

  1. On a third terminal, start your NextJS app:
yarn start

Visit your app on: http://localhost:3000. You can interact with your smart contract using the Debug Contracts page. You can tweak the app config in packages/nextjs/scaffold.config.ts.

What's next:

  • Edit your smart contract YourContract.sol in packages/foundry/contracts
  • Edit your frontend homepage at packages/nextjs/app/page.tsx. For guidance on routing and configuring pages/layouts checkout the Next.js documentation.
  • Edit your deployment scripts in packages/foundry/deploy
  • Edit your smart contract test in: packages/foundry/test. To run test use yarn foundry:test

Documentation

Visit our docs to learn how to start building with Scaffold-ETH 2.

To know more about its features, check out our website.

Contributing to Scaffold-ETH 2

We welcome contributions to Scaffold-ETH 2!

Please see CONTRIBUTING.MD for more information and guidelines for contributing to Scaffold-ETH 2.