initialize repository with buidler environment, readme, and license

Author: ItsNickBarry

.gitignore

@@ -0,0 +1,3 @@
+artifacts/
+cache/
+node_modules/

LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Nick Barry
+
+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 above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

README.md

@@ -0,0 +1,80 @@
+# SolidState Contracts
+
+Upgradable-first Solidity smart contract development library.
+
+## Usage
+
+Install the package as a development dependency:
+
+```bash
+npm install --save-dev @solidstate/contracts
+# or
+yarn add --dev @solidistate/contracts
+```
+
+### Contracts
+
+All contracts are designed to either be deployed through the standard `constructor` method, or referenced by a proxy.  To this end, the [diamond storage](https://medium.com/1milliondevs/new-storage-layout-for-proxy-contracts-and-diamonds-98d01d0eadb) pattern is employed exclusively.
+
+### Portable Tests
+
+Where possible, automated tests are designed to be imported by repositories which make use of SolidState and run against any derived contracts.  This is to help prevent unintended changes to to the base contract behavior.
+
+For example, consider a custom `ERC20Base` implementation:
+
+```solidity
+import '@solidstate/contracts/token/ERC20/ERC20Base.sol';
+
+contract CustomToken is ERC20Base {
+  // custom code...
+}
+```
+
+Rather than rewrite the `ERC20Base` tests or assume that all core behavior remains untouched, one can import the included tests and run them against the custom implementation:
+
+```javascript
+describe('CustomToken', function () {
+  let deploy = async function () {
+    let factory = await ethers.getContractFactory('CustomToken');
+    let instance = await factory.deploy();
+    await instance.deployed();
+    return instance;
+  }
+
+  assertBehaviorOfERC20Base(deploy);
+
+  // custom tests...
+});
+```
+
+## Development
+
+Install dependencies via Yarn:
+
+```bash
+yarn install
+```
+
+Compile contracts via Buidler:
+
+```bash
+yarn run buidler compile
+```
+
+### Networks
+
+By default, Buidler uses the BuidlerEVM in-process.  To connect to an out-of process network such as a local instance of Ganache, specify the `localhost` or `generic` network:
+
+```bash
+yarn run buidler test --network localhost
+# or
+URL=[NODE_URL] yarn run buidler test --network generic
+```
+
+### Testing
+
+Test contracts via Buidler:
+
+```bash
+yarn run buidler test
+```

buidler.config.js

@@ -0,0 +1,21 @@
+usePlugin("@nomiclabs/buidler-waffle");
+
+module.exports = {
+  solc: {
+    version: '0.7.2',
+    optimizer: {
+      enabled: true,
+      runs: 200,
+    },
+  },
+
+  networks: {
+    generic: {
+      // set URL for external network, such as Infura
+      url: `${ process.env.URL }`,
+      accounts: {
+        mnemonic: `${ process.env.MNEMONIC }`,
+      },
+    },
+  },
+};

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@solidstate/contracts",
+  "version": "0.0.0",
+  "author": "Nick Barry",
+  "license": "MIT",
+  "description": "Solidity library for flexible smart contract development",
+  "keywords": [
+    "solidity",
+    "smart-contracts",
+    "ethereum",
+    "ether",
+    "eth",
+    "cryptocurrency",
+    "crypto",
+    "wow",
+    "library"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solidstate-network/solidstate-contracts.git"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@nomiclabs/buidler": "^1.4.7",
+    "@nomiclabs/buidler-ethers": "^2.0.2",
+    "@nomiclabs/buidler-waffle": "^2.1.0",
+    "@openzeppelin/contracts": "3.2.0-solc-0.7",
+    "chai": "^4.2.0",
+    "ethereum-waffle": "^3.1.1"
+  },
+  "files": [
+    "/contracts/**/*.sol",
+    "!/contracts/**/*Mock.sol"
+  ]
+}