Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions .devcontainer.json

This file was deleted.

1 change: 0 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@ INFURA_KEY=INFURA_PROJECT_ID

# Additional keys
ETHERSCAN_KEY=ETHERSCAN_API_KEY
BSCSCAN_KEY=BSCSCAN_API_KEY

COINMARKETCAP_KEY=COINMARKETCAP_API_KEY
4 changes: 2 additions & 2 deletions .github/actions/setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ runs:
with:
version: nightly
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v5
with:
node-version: "18.18.x"
node-version: "22.10.x"
cache: npm
- name: Install packages
run: make install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v3
uses: actions/checkout@v5
with:
submodules: recursive
- name: Setup
Expand Down
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
node_modules
lib
report
.env
.DS_Store

# Compiler files
cache
out

# Ignores development broadcast logs
/broadcast
broadcast

docs
coverage
Expand Down
26 changes: 25 additions & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,32 @@
{
"files": "*.ts",
"options": {
"plugins": ["@trivago/prettier-plugin-sort-imports"],
"printWidth": 120,
"tabWidth": 2
"tabWidth": 2,
"singleQuote": false,
"importOrder": [
"(^chai$)|(hardhat$)",
"ethers$",
"^@nomicfoundation/(.*)$",
"^@solarity/(.*)$",
"^@typechain/hardhat$",
"^hardhat-[a-zA-Z0-9_\\-]+$",
"^tsconfig-paths/register$",
"^solidity-[a-zA-Z0-9_\\-]+$",
"^hardhat/config$",
"^dotenv$",
"@scripts",
"@test-helpers",
"@(?:/generated-types|ethers-v6)",
"",
"^[a-zA-Z0-9_\\-]+$",
"^\\u0000",
"^\\.\\./",
"^\\./"
],
"importOrderSeparation": true,
"importOrderSortSpecifiers": true
}
}
]
Expand Down
14 changes: 0 additions & 14 deletions .solhint.json

This file was deleted.

16 changes: 0 additions & 16 deletions Dockerfile

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Solarity
Copyright (c) 2025 Solarity

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 8 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ install:; make forge-install && npm install

forge-install:
rm -rfv lib \
&& forge install --no-git foundry-rs/forge-std@v1.9.7 \
&& forge install --no-git OpenZeppelin/openzeppelin-contracts@v5.3.0 \
&& forge install --no-git OpenZeppelin/openzeppelin-contracts-upgradeable@v5.3.0 \
&& forge install --no-git dl-solarity/solidity-lib@3.1.0
&& forge install --no-git foundry-rs/forge-std@v1.12.0 \
&& forge install --no-git OpenZeppelin/openzeppelin-contracts@v5.4.0 \
&& forge install --no-git OpenZeppelin/openzeppelin-contracts-upgradeable@v5.4.0 \
&& forge install --no-git dl-solarity/solidity-lib@v3.3.0

# Development commands

Expand All @@ -33,7 +33,7 @@ private-network-fork:; anvil --fork-url https://mainnet.infura.io/v3/${INFURA_KE

deploy-localhost:; forge script scripts/deploy.s.sol --fork-url http://localhost:8545 --broadcast

deploy-goerli:; forge script scripts/deploy.s.sol --rpc-url https://goerli.infura.io/v3/${INFURA_KEY} --private-key ${PRIVATE_KEY} --broadcast --verify -vvvv
deploy-sepolia:; forge script scripts/deploy.s.sol --rpc-url https://sepolia.infura.io/v3/${INFURA_KEY} --private-key ${PRIVATE_KEY} --broadcast --verify -vvvv

# Types and docs commands

Expand All @@ -43,8 +43,10 @@ generate-docs:; forge doc

# Linting commands

lint-fix:; make lint-sol-fix && make lint-json-fix
lint-fix:; make lint-sol-fix && make lint-json-fix && make slippy-check

lint-json-fix:; npx prettier --write "./**/*.json"

lint-sol-fix:; npx prettier --write "contracts/**/*.sol"

slippy-check:; npx slippy "./contracts/**/*.sol"
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ Third, use `make` to install local dependencies:
make install
```

#### Or with Docker

It is recommended to use the VSCode `Dev Containers` extension for development. After installing it, open the Command Palette `(Ctrl+Shift+P)` and select the `Dev Containers: Rebuild and Reopen in Container` command.

### How to use

The template works out of the box. To clean up the repo, you may need to delete the mock contracts and tests.
Expand Down Expand Up @@ -57,6 +53,6 @@ make deploy-localhost

### Other niceties

- The template comes with presetup `prettier` and `solhint` that lint the project via `husky` before compilation hook.
- The template comes with presetup `prettier` and `slippy` that lint the project via `husky` before compilation hook.
- The `.env.example` file is provided to check what is required as ENVs
- Preinstalled `@openzeppelin/contracts` and `@solarity/solidity-lib`
File renamed without changes.
6 changes: 1 addition & 5 deletions foundry.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,9 @@ remappings = [
]

[rpc_endpoints]
sepolia = "https://sepolia.infura.io/v3/${INFURA_KEY}"
chapel = "https://data-seed-prebsc-1-s1.binance.org:8545"
bsc = "https://bsc-dataseed.binance.org/"
ethereum = "https://mainnet.infura.io/v3/${INFURA_KEY}"
sepolia = "https://sepolia.infura.io/v3/${INFURA_KEY}"

[etherscan]
mainnet = { key = "${ETHERSCAN_KEY}" }
sepolia = { key = "${ETHERSCAN_KEY}" }
bsc = { key = "${BSCSCAN_KEY}" }
chapel = { key = "${BSCSCAN_KEY}", url = "https://api-testnet.bscscan.com/" }
Loading