From 06cdd4d73649191eaf7c95250da1b48cb0acdf51 Mon Sep 17 00:00:00 2001 From: Paul Razvan Berg Date: Tue, 29 Nov 2022 14:08:46 +0200 Subject: [PATCH] docs: change license to MIT chore: remove typechain invokations in "pre-commit" chore: delete ".mocharc.yml" file chore: delete ".nycrc.yml" file docs: add Foundry badge in README and delete coverage badge --- .husky/pre-commit | 2 -- .mocharc.yml | 6 ------ .nycrc.yml | 12 ------------ LICENSE.md | 30 ++++++++++-------------------- README.md | 12 ++++++------ package.json | 2 +- src/IPRBProxy.sol | 2 +- src/IPRBProxyFactory.sol | 2 +- src/IPRBProxyRegistry.sol | 2 +- src/PRBProxy.sol | 2 +- src/PRBProxyFactory.sol | 2 +- src/PRBProxyRegistry.sol | 2 +- 12 files changed, 23 insertions(+), 53 deletions(-) delete mode 100644 .mocharc.yml delete mode 100644 .nycrc.yml diff --git a/.husky/pre-commit b/.husky/pre-commit index 423527a..a3c12e2 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -2,5 +2,3 @@ . "$(dirname "$0")/_/husky.sh" yarn dlx lint-staged -yarn prepare:types -git add src/types diff --git a/.mocharc.yml b/.mocharc.yml deleted file mode 100644 index d770b66..0000000 --- a/.mocharc.yml +++ /dev/null @@ -1,6 +0,0 @@ -extension: "ts" -recursive: true -require: - - "ts-node/register/transpile-only" -spec: "test/ts/**/*.ts" -watchExtension: "ts" diff --git a/.nycrc.yml b/.nycrc.yml deleted file mode 100644 index 56d82fd..0000000 --- a/.nycrc.yml +++ /dev/null @@ -1,12 +0,0 @@ -check-coverage: false -exclude: - - "src/constants.ts" - - "src/contracts.ts" - - "src/types/**/*.ts" -extends: "@istanbuljs/nyc-config-typescript" -include: - - "src/**/*.ts" -report-dir: "coverage-ts" -reporter: - - "html" - - "lcov" diff --git a/LICENSE.md b/LICENSE.md index 68a49da..783ebe2 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,24 +1,14 @@ -This is free and unencumbered software released into the public domain. +MIT License -Anyone is free to copy, modify, publish, use, compile, sell, or -distribute this software, either in source code form or as a compiled -binary, for any purpose, commercial or non-commercial, and by any -means. +Copyright (c) 2022 Paul Razvan Berg -In jurisdictions that recognize copyright laws, the author or authors -of this software dedicate any and all copyright interest in the -software to the public domain. We make this dedication for the benefit -of the public at large and to the detriment of our heirs and -successors. We intend this dedication to be an overt act of -relinquishment in perpetuity of all present and future rights to this -software under copyright law. +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to +deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR -OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -For more information, please refer to +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +IN THE SOFTWARE. diff --git a/README.md b/README.md index ae035c6..ef15cbd 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# PRBProxy [![Github Actions][gha-badge]][gha] [![Coverage Status][coveralls-badge]][coveralls] [![Styled with Prettier][prettier-badge]][prettier] [![License: Unlicense][license-badge]][license] +# PRBProxy [![Github Actions][gha-badge]][gha] [![Foundry][foundry-badge]][foundry] [![Styled with Prettier][prettier-badge]][prettier] [![License: MIT][license-badge]][license] [gha]: https://github.com/paulrberg/prb-proxy/actions [gha-badge]: https://github.com/paulrberg/prb-proxy/actions/workflows/ci.yml/badge.svg -[coveralls]: https://coveralls.io/github/paulrberg/prb-proxy -[coveralls-badge]: https://coveralls.io/repos/github/paulrberg/prb-proxy/badge.svg?branch=main +[foundry]: https://getfoundry.sh/ +[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg [prettier]: https://prettier.io [prettier-badge]: https://img.shields.io/badge/Code_Style-Prettier-ff69b4.svg -[license]: https://unlicense.org/ -[license-badge]: https://img.shields.io/badge/License-Unlicense-blue.svg +[license]: https://opensource.org/licenses/MIT +[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg **Proxy contract to compose Ethereum transactions on behalf of the owner.** Think of this as a smart wallet that enables the execution of multiple contract calls in one transaction. Externally owned accounts (EOAs) do not have this feature; they are @@ -340,7 +340,7 @@ start making changes. ## License -[Unlicense](./LICENSE.md) © Paul Razvan Berg +[MIT](./LICENSE.md) © Paul Razvan Berg diff --git a/package.json b/package.json index 25ce215..a517b91 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ "smart-contracts", "solidity" ], - "license": "Unlicense", + "license": "MIT", "packageManager": "yarn@3.3.0", "publishConfig": { "access": "public" diff --git a/src/IPRBProxy.sol b/src/IPRBProxy.sol index 0823aea..c748ef1 100644 --- a/src/IPRBProxy.sol +++ b/src/IPRBProxy.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Unlicense +// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; /// @title IPRBProxy diff --git a/src/IPRBProxyFactory.sol b/src/IPRBProxyFactory.sol index 8a076c7..6cb00ef 100644 --- a/src/IPRBProxyFactory.sol +++ b/src/IPRBProxyFactory.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Unlicense +// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; /// @title IPRBProxyFactory diff --git a/src/IPRBProxyRegistry.sol b/src/IPRBProxyRegistry.sol index bd53ef5..9891ba0 100644 --- a/src/IPRBProxyRegistry.sol +++ b/src/IPRBProxyRegistry.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Unlicense +// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; import { IPRBProxy } from "./IPRBProxy.sol"; diff --git a/src/PRBProxy.sol b/src/PRBProxy.sol index 7481956..cfaca08 100644 --- a/src/PRBProxy.sol +++ b/src/PRBProxy.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Unlicense +// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; import { IPRBProxy } from "./IPRBProxy.sol"; diff --git a/src/PRBProxyFactory.sol b/src/PRBProxyFactory.sol index 076be56..037a608 100644 --- a/src/PRBProxyFactory.sol +++ b/src/PRBProxyFactory.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Unlicense +// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; import { IPRBProxy } from "./IPRBProxy.sol"; diff --git a/src/PRBProxyRegistry.sol b/src/PRBProxyRegistry.sol index 6f5035e..477c66b 100644 --- a/src/PRBProxyRegistry.sol +++ b/src/PRBProxyRegistry.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: Unlicense +// SPDX-License-Identifier: MIT pragma solidity >=0.8.4; import { IPRBProxy } from "./IPRBProxy.sol";