Dev to main

.all-contributorsrc

@@ -0,0 +1,44 @@
+{
+ "projectName": "starklane",
+ "projectOwner": "ScreenshotLabs",
+ "repoType": "github",
+ "repoHost": "https://github.com",
+ "files": [
+ "README.md"
+ ],
+ "imageSize": 100,
+ "commit": true,
+ "commitConvention": "angular",
+ "contributorsPerLine": 7,
+ "linkToUsage": true,
+ "contributors": [
+ {
+ "login": "remiroyc",
+ "name": "Rémi",
+ "avatar_url": "https://avatars.githubusercontent.com/u/11146088?v=4",
+ "profile": "https://github.com/remiroyc",
+ "contributions": [
+ "code"
+ ]
+ },
+ {
+ "login": "kwiss",
+ "name": "Christophe",
+ "avatar_url": "https://avatars.githubusercontent.com/u/243668?v=4",
+ "profile": "https://github.com/kwiss",
+ "contributions": [
+ "code",
+ "design"
+ ]
+ },
+ {
+ "login": "gershon",
+ "name": "Paul",
+ "avatar_url": "https://avatars.githubusercontent.com/u/55589?v=4",
+ "profile": "https://github.com/gershon",
+ "contributions": [
+ "code"
+ ]
+ }
+ ]
+}

.env.sample

@@ -0,0 +1,6 @@
+ PRIVATE_KEY=
+ ALCHEMY_KEY=
+ HOSTNAME_L1=
+ HOSTNAME_L2=
+ ETHERSCAN_API_KEY=
+ L2_NETWORK=

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+ root: true,
+ // This tells ESLint to load the config from the package `eslint-config-custom`
+ extends: ["custom"],
+ settings: {
+ next: {
+ rootDir: ["apps/*/"],
+ },
+ },
+};

.gitignore

@@ -0,0 +1,44 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+/**/node_modules
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# next.js
+.next/
+out/
+build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# turbo
+.turbo
+
+.env
+coverage.json
+typechain
+typechain-types
+cache
+artifacts
+*.key
+
+starknet-artifacts

.prettierignore

@@ -0,0 +1,33 @@
+node_modules
+
+#Hardhat files
+cache
+artifacts
+
+#Python artifacts
+.venv*
+__pycache__
+.pytest_cache
+
+#Starknet plugin
+starknet-artifacts
+
+#NPM lock file
+package-lock.json
+
+#Environment variables file
+.env
+
+#deployment artifacts folder
+deployment
+
+# Yarn error file
+yarn-error.log
+
+# Apple related file
+.DS_Store 
+
+#IDEs
+.idea
+
+starknet-artifacts/**/*.json

.prettierrc.json

@@ -0,0 +1 @@
+{}

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+For issues to work on, [see the issues tab](https://github.com/ScreenshotLabs/starklane/issues)
+
+To help you get your feet wet and get you familiar with our contribution process, we have a list of **good first issues** that contain bugs that have a relatively limited scope. This is a great place to get started.

Dockerfile

@@ -0,0 +1,31 @@
+FROM python:3.11
+
+ENV HOSTNAME_L1 testnet-l1
+ENV HOSTNAME_L2 testnet-l2
+
+RUN apt update -y && apt upgrade -y && apt install curl git libssl-dev libgmp3-dev -y
+
+# Copy folder
+COPY . starklane
+WORKDIR starklane
+
+# Install Python dependencies
+RUN rm -rf .venv && python -m venv .venv
+RUN . .venv/bin/activate
+RUN python -m pip install --upgrade pip && pip install poetry && poetry install
+
+# Install Node 16
+RUN curl -sL https://deb.nodesource.com/setup_16.x | bash - && \
+ apt-get install -y nodejs
+
+# Install Yarn
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
+ echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \ 
+ apt update -y && \
+ apt install yarn -y
+
+# Install Node dependencies
+RUN yarn
+
+# Build Cairo files
+RUN yarn build:l2

README.md

@@ -1,2 +1,70 @@
-# starklane
+# Starklane
+
 The Starklane NFT Bridge: seamless transfer of NFTs between ETH L1 & Starknet L2. Smart contracts, user-friendly interface, secure & efficient solution. Experience the future of NFT ownership today
+
+[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+##
+
+## ➡️ L1 - L2 Flow
+
+- The L1 gateway sends a message to the L2 gateway
+
+- The L2 bridge contract verifies the presence of the L1 address in the registry structure `_l1_to_l2_addresses`
+
+- If the L2 contract doesn't exist, the Universal Deployer Contract is automatically called to deploy a default ERC-721 contract, resulting in a replica of the L1 contract on L2.
+
+- The bridge contract has the authority to mint a new token on the deployed smart contract.
+
+## ⬅️ L2 - L1 Flow
+
+TBD
+
+## Quickstart
+
+### Install dependencies
+
+`yarn`
+
+### Build all packages
+
+`yarn build`
+
+## Disclaimer
+
+These contracts are only given as an example. They HAVE NOT undergone any audit. They SHOULD NOT be used for any production level application.
+
+## Contributors ✨
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+ <tbody>
+ <tr>
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/remiroyc"><img src="https://avatars.githubusercontent.com/u/11146088?v=4?s=100" width="100px;" alt="Rémi"/><br /><sub><b>Rémi</b></sub></a><br /><a href="https://github.com/ScreenshotLabs/starklane/commits?author=remiroyc" title="Code">💻</a></td>
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/kwiss"><img src="https://avatars.githubusercontent.com/u/243668?v=4?s=100" width="100px;" alt="Christophe"/><br /><sub><b>Christophe</b></sub></a><br /><a href="https://github.com/ScreenshotLabs/starklane/commits?author=kwiss" title="Code">💻</a> <a href="#design-kwiss" title="Design">🎨</a></td>
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/gershon"><img src="https://avatars.githubusercontent.com/u/55589?v=4?s=100" width="100px;" alt="Paul"/><br /><sub><b>Paul</b></sub></a><br /><a href="https://github.com/ScreenshotLabs/starklane/commits?author=gershon" title="Code">💻</a></td>
+ </tr>
+ </tbody>
+ <tfoot>
+ <tr>
+ <td align="center" size="13px" colspan="7">
+ <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
+ <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+ </img>
+ </td>
+ </tr>
+ </tfoot>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

apps/blockchain/contracts/ethereum/Bridge.sol

@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.9;
+
+import "./interfaces/IStarknetMessaging.sol";
+import "@openzeppelin/contracts/access/Ownable.sol";
+import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+
+interface NFTContract is IERC721 {
+ function name() external view returns (string memory);
+
+ function symbol() external view returns (string memory);
+
+ function tokenURI(uint256 tokenId) external view returns (string memory);
+}
+
+contract Bridge is Ownable {
+ IStarknetMessaging public starknetCore;
+ uint256 public selector;
+ uint256 public l2GatewayAddress;
+
+ constructor(address starknetCore_) {
+ require(
+ starknetCore_ != address(0),
+ "Gateway/invalid-starknet-core-address"
+ );
+ starknetCore = IStarknetMessaging(starknetCore_);
+ }
+
+ function setSelector(uint256 value) external onlyOwner {
+ selector = value;
+ }
+
+ function setL2GatewayAddress(uint256 value) external onlyOwner {
+ l2GatewayAddress = value;
+ }
+
+ function strToUint(string memory text) public pure returns (uint256 res) {
+ bytes32 stringInBytes32 = bytes32(bytes(text));
+ uint256 strLen = bytes(text).length; // TODO: cannot be above 32
+ require(strLen <= 32, "String cannot be longer than 32");
+
+ uint256 shift = 256 - 8 * strLen;
+
+ uint256 stringInUint256;
+ assembly {
+ stringInUint256 := shr(shift, stringInBytes32)
+ }
+ return stringInUint256;
+ }
+
+ function deposit(
+ address l1TokenAddress,
+ uint256 l2OwnerAddress,
+ uint256 tokenId
+ ) public payable {
+ NFTContract tokenContract = NFTContract(l1TokenAddress);
+
+ // optimistic transfer, should revert if no approved or not owner
+ tokenContract.transferFrom(msg.sender, address(this), tokenId);
+
+ string memory symbol = tokenContract.symbol();
+ string memory name = tokenContract.name();
+ string memory tokenUri = tokenContract.tokenURI(tokenId);
+
+ uint256[] memory payload = new uint256[](6);
+
+ payload[0] = uint256(uint160(l1TokenAddress)); // l1_contract_address
+ payload[1] = l2OwnerAddress; // to
+ payload[2] = tokenId;
+ payload[3] = strToUint(name);
+ payload[4] = strToUint(symbol);
+ payload[5] = strToUint(tokenUri);
+
+ starknetCore.sendMessageToL2{value: msg.value}(
+ l2GatewayAddress,
+ selector,
+ payload
+ );
+ }
+
+ // TO REMOVE
+ function forceWithdraw(address l1_contract_address, uint256 tokenId)
+ public
+ onlyOwner
+ {
+ IERC721 tokenContract = NFTContract(l1_contract_address);
+ tokenContract.transferFrom(address(this), msg.sender, tokenId);
+ }
+}