-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build!: move LSP17ContractExtension in its own package
- Loading branch information
1 parent
4c31ce7
commit 254e4a0
Showing
17 changed files
with
25,757 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"CodeGPT.apiKey": "CodeGPT Plus Beta" | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
module.exports = { | ||
root: true, | ||
extends: ['custom'], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "lib/forge-std"] | ||
path = ../../lib/forge-std | ||
url = https://github.com/foundry-rs/forge-std.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"extends": "solhint:recommended", | ||
"rules": { | ||
"avoid-sha3": "error", | ||
"avoid-suicide": "error", | ||
"avoid-throw": "error", | ||
"avoid-tx-origin": "error", | ||
"check-send-result": "error", | ||
"compiler-version": ["error", "^0.8.0"], | ||
"func-visibility": ["error", { "ignoreConstructors": true }], | ||
"not-rely-on-block-hash": "error", | ||
"not-rely-on-time": "error", | ||
"reentrancy": "error", | ||
"constructor-syntax": "error", | ||
"private-vars-leading-underscore": ["error", { "strict": false }], | ||
"imports-on-top": "error", | ||
"visibility-modifier-order": "error", | ||
"no-unused-import": "error", | ||
"no-global-import": "error", | ||
"reason-string": ["warn", { "maxLength": 120 }], | ||
"avoid-low-level-calls": "off", | ||
"no-empty-blocks": ["error", { "ignoreConstructors": true }], | ||
"custom-errors": "off" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# LSP Package Template | ||
|
||
This project can be used as a skeleton to build a package for a LSP implementation in Solidity (LUKSO Standard Proposal) | ||
|
||
It is based on Hardhat. | ||
|
||
## How to setup a LSP as a package? | ||
|
||
1. Copy the `template/` folder and paste it under the `packages/` folder. Then rename this `template/` folder that you copied with the LSP name. | ||
|
||
You can do so either: | ||
|
||
- manually, by copying the folder and pasting it inside `packages` and then renaming it. | ||
or | ||
- by running the following command from the root of the repository. | ||
|
||
```bash | ||
cp -r template packages/lsp-name | ||
``` | ||
|
||
2. Update the `"name"` and `"description"` field inside the `package.json` for this LSP package you just created. | ||
|
||
3. Setup the dependencies | ||
|
||
If this LSP uses external dependencies like `@openzeppelin/contracts`, put them under `dependencies` with the version number. | ||
|
||
```json | ||
"@openzeppelin/contracts": "^4.9.3" | ||
``` | ||
|
||
If this LSP uses other LSP as dependencies, put each LSP dependency as shown below. This will use the current code in the package: | ||
|
||
```json | ||
"@lsp2": "*" | ||
``` | ||
|
||
4. Setup the npm commands for linting, building, testing, etc... under the `"scripts"` in the `package.json` | ||
|
||
5. Test that all commands you setup run successfully | ||
|
||
By running the commands below, your LSP package should come up in the list of packages that Turbo is running this command for. | ||
|
||
```bash | ||
turbo build | ||
turbo lint | ||
turbo lint:solidity | ||
turbo test | ||
turbo test:foundry | ||
``` | ||
|
||
6. Finally update the relevant information in the `README.md` file in the folder of the newly created package, such as the title at the top, some description, etc... |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// SPDX-License-Identifier: Apache-2.0 | ||
pragma solidity ^0.8.4; | ||
|
||
abstract contract Version { | ||
/** | ||
* @dev Get the version of the contract. | ||
* @notice Contract version. | ||
* | ||
* @return The version of the the contract. | ||
*/ | ||
// DO NOT CHANGE | ||
// Comments block below is used by release-please to automatically update the version in this file. | ||
// x-release-please-start-version | ||
string public constant VERSION = "0.14.0"; | ||
|
||
// x-release-please-end | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
[profile.default] | ||
src = 'contracts' | ||
out = 'out' | ||
libs = ['node_modules','lib'] | ||
cache_path = 'forge-cache' | ||
test = 'foundry' | ||
solc_version = "0.8.17" | ||
[fuzz] | ||
runs = 10_000 | ||
max_test_rejects = 200_000 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
import { HardhatUserConfig } from 'hardhat/config'; | ||
import { NetworkUserConfig } from 'hardhat/types'; | ||
import { config as dotenvConfig } from 'dotenv'; | ||
import { resolve } from 'path'; | ||
|
||
/** | ||
* this package includes: | ||
* - @nomiclabs/hardhat-ethers | ||
* - @nomicfoundation/hardhat-chai-matchers | ||
* - @nomicfoundation/hardhat-network-helpers | ||
* - @nomiclabs/hardhat-etherscan | ||
* - hardhat-gas-reporter (is this true? Why do we have it as a separate dependency?) | ||
* - @typechain/hardhat | ||
* - solidity-coverage | ||
*/ | ||
import '@nomicfoundation/hardhat-toolbox'; | ||
|
||
// additional hardhat plugins | ||
import 'hardhat-packager'; | ||
import 'hardhat-contract-sizer'; | ||
import 'hardhat-deploy'; | ||
|
||
// custom built hardhat plugins and scripts | ||
// can be imported here (e.g: docs generation, gas benchmark, etc...) | ||
|
||
dotenvConfig({ path: resolve(__dirname, './.env') }); | ||
|
||
function getTestnetChainConfig(): NetworkUserConfig { | ||
const config: NetworkUserConfig = { | ||
live: true, | ||
url: 'https://rpc.testnet.lukso.network', | ||
chainId: 4201, | ||
}; | ||
|
||
if (process.env.CONTRACT_VERIFICATION_TESTNET_PK !== undefined) { | ||
config['accounts'] = [process.env.CONTRACT_VERIFICATION_TESTNET_PK]; | ||
} | ||
|
||
return config; | ||
} | ||
|
||
const config: HardhatUserConfig = { | ||
defaultNetwork: 'hardhat', | ||
networks: { | ||
hardhat: { | ||
live: false, | ||
saveDeployments: false, | ||
allowBlocksWithSameTimestamp: true, | ||
}, | ||
luksoTestnet: getTestnetChainConfig(), | ||
}, | ||
namedAccounts: { | ||
owner: 0, | ||
}, | ||
// uncomment if the contracts from this LSP package must be deployed at deterministic | ||
// // addresses across multiple chains | ||
// deterministicDeployment: { | ||
// luksoTestnet: { | ||
// // Nick Factory. See https://github.com/Arachnid/deterministic-deployment-proxy | ||
// factory: '0x4e59b44847b379578588920ca78fbf26c0b4956c', | ||
// deployer: '0x3fab184622dc19b6109349b94811493bf2a45362', | ||
// funding: '0x0000000000000000000000000000000000000000000000000000000000000000', | ||
// signedTx: | ||
// '0xf8a58085174876e800830186a08080b853604580600e600039806000f350fe7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf31ba02222222222222222222222222222222222222222222222222222222222222222a02222222222222222222222222222222222222222222222222222222222222222', | ||
// }, | ||
// }, | ||
etherscan: { | ||
apiKey: 'no-api-key-needed', | ||
customChains: [ | ||
{ | ||
network: 'luksoTestnet', | ||
chainId: 4201, | ||
urls: { | ||
apiURL: 'https://api.explorer.execution.testnet.lukso.network/api', | ||
browserURL: 'https://explorer.execution.testnet.lukso.network/', | ||
}, | ||
}, | ||
], | ||
}, | ||
gasReporter: { | ||
enabled: true, | ||
currency: 'USD', | ||
gasPrice: 21, | ||
excludeContracts: ['Helpers/'], | ||
src: './contracts', | ||
showMethodSig: true, | ||
}, | ||
solidity: { | ||
version: '0.8.17', | ||
settings: { | ||
optimizer: { | ||
enabled: true, | ||
/** | ||
* Optimize for how many times you intend to run the code. | ||
* Lower values will optimize more for initial deployment cost, higher | ||
* values will optimize more for high-frequency usage. | ||
* @see https://docs.soliditylang.org/en/v0.8.6/internals/optimizer.html#opcode-based-optimizer-module | ||
*/ | ||
runs: 1000, | ||
}, | ||
outputSelection: { | ||
'*': { | ||
'*': ['storageLayout'], | ||
}, | ||
}, | ||
}, | ||
}, | ||
packager: { | ||
// What contracts to keep the artifacts and the bindings for. | ||
contracts: [], | ||
// Whether to include the TypeChain factories or not. | ||
// If this is enabled, you need to run the TypeChain files through the TypeScript compiler before shipping to the registry. | ||
includeFactories: true, | ||
}, | ||
paths: { | ||
artifacts: 'artifacts', | ||
tests: 'tests', | ||
}, | ||
typechain: { | ||
outDir: 'types', | ||
target: 'ethers-v5', | ||
}, | ||
mocha: { | ||
timeout: 10000000, | ||
}, | ||
}; | ||
|
||
export default config; |
Oops, something went wrong.