Skip to content

Latest commit

 

History

History
executable file
·
227 lines (153 loc) · 4.86 KB

1_SETUP.md

File metadata and controls

executable file
·
227 lines (153 loc) · 4.86 KB
Raw

1. 🏗 Setting up the environment

Installing Node.js

📱 MacOS

Make sure you have git installed. Otherwise, follow these instructions.

There are multiple ways of installing Node.js on MacOS. We will be using Node Version Manager (nvm). Copy and paste these commands in a terminal:

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.35.2/install.sh | bash
nvm install 16.14.2
nvm use 16.14.2
nvm alias default 16.14.2
npm install npm --global # Upgrade npm to the latest version

Installing yarn

We are going to use yarn

To install it do the following:

npm install -g yarn

2. Creating a new Hardhat project

We'll install Hardhat using the npm CLI. The Node.js package manager is a package manager and an online repository for JavaScript code.

Open a new terminal, go to the directory and run these commands:

yarn init --yes
yarn add -D hardhat

Also, there is sometimes problem with hardhat-deploy-ethers dependency. Here is a way to fix:

yarn add -D  @nomiclabs/hardhat-ethers@npm:hardhat-deploy-ethers ethers

But it sometimes does not work, try this:

yarn add -D  hardhat-deploy-ethers

In the same directory where you installed Hardhat add a hardhat.config.ts (we are going to use typescript and use solidity 0.5.17 compiler)

import { HardhatUserConfig } from "hardhat/types";
const config: HardhatUserConfig = {
  solidity: {
    version: "0.6.6",
  },
};
export default config;

Install Dependenciies

Run following yo install required dependencies

yarn install

Add .gitignore

We need to create the following .gitignore :

cache/
artifacts/

coverage*
typechain/

.vscode/*
!.vscode/settings.json.default
!.vscode/launch.json.default
!.vscode/extensions.json.default

.DS_Store
Thumbs.db
node_modules/
.env

.yalc
yalc.lock

contractsInfo.json
deployments/hardhat
deployments/localhost

.dapp/
_lib/

Add .env

We also create the following .env :

PKEY=
MNEMONIC_MAINNET=
MNEMONIC=
ETHERSCANKEY=


# network specific node uri : `"ETH_NODE_URI_" + networkName.toUpperCase()`
ETH_NODE_URI_MAINNET=https://eth-mainnet.alchemyapi.io/v2/<apiKey>
# generic node uri (if no specific found) :
ETH_NODE_URI=https://{{networkName}}.infura.io/v3/<apiKey


CHAINSTACK_NODEUSERNAME=
CHAINSTACK_PASSWORD=
CHAINSTACK_RPC_ENDPOINT=
CHAINSTACK_WSS_ENDPOINT=


ETH_NODE_URI_BSCMAINNET = https://bsc-dataseed1.ninicoin.io/
ETH_NODE_URI_BSCTESTNET = https://data-seed-prebsc-2-s2.binance.org:8545/

We can go to vanity-eth in order to generate such Private key

We can go to iancoleman.io in order to generate such Mneomic key

We could ask mock BNB for testing purpose by go to testnet.binance.org

⚠️ Warning

Note that we use plugin "hardhat-secure-signer" to run stand-alone scripts. We only store private key and Mneomic key for only running test purpose

3. 🏗 Setting up Starknet environment

Installing Python

Create your virtual environment

virtualenv ~/stark_venv

And of course, activate it ;)

source ~/stark_venv/bin/activate

After that your prompt is prefix with (stark_venv)

Of course, eeactivate when you have no need of ot

deactivate

Install Dependencies

Make sure you can install the following pip packages: ecdsa, fastecdsa, sympy (using pip3 install ecdsa fastecdsa sympy) to support multiprecision arithmetic. On Ubuntu, for example, you will have to first run:

sudo apt install -y libgmp3-dev

On Mac, you can use brew:

brew install gmp

Install Cairo

Install the cairo-lang python package using:

pip3 install cairo-lang

Test your installation on execute cairo-compile

cairo-compile
usage: cairo-compile [-h] [--proof_mode] [--no_proof_mode] [-v]
[--prime PRIME] [--cairo_path CAIRO_PATH] [--preprocess]
[--output OUTPUT] [--no_debug_info]
[--debug_info_with_source]
[--cairo_dependencies CAIRO_DEPENDENCIES]
[--no_opt_unused_functions]
file [file ...]
cairo-compile: error: the following arguments are required: file

Run a starknet-devnet

For this step, a prerequisite is to have docker installed.

Devnet is available as a Docker container (shardlabs/starknet-devnet):

docker pull shardlabs/starknet-devnet

After that, we run a docker command to deploy a starknet-devnet on your laptop on port 5000.

docker run -it -p 127.0.0.1:5000:5000 shardlabs/starknet-devnet

If you run the docker ps command, you should see your starknet-devnet.

we can even compile and test our project:

yarn hardhat starknet-compile