Skip to content
This repository was archived by the owner on May 16, 2023. It is now read-only.

Commit 8a0769b

Browse files
author
Andres Adjimann
committed
feat: inital structure and template project
1 parent f888b6c commit 8a0769b

29 files changed

+5476
-0
lines changed

‎.editorconfig‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
insert_final_newline = true
6+
charset = utf-8
7+
indent_style = space
8+
indent_size = 2
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false
13+
14+
[*.sol]
15+
indent_size = 4
16+
17+
[{/deployments/**,/artifacts/**,/cache/**,/coverage/**,/node_modules/**,package.json,/imports/**,secret/**}]
18+
charset = unset
19+
end_of_line = unset
20+
insert_final_newline = unset
21+
trim_trailing_whitespace = unset
22+
indent_style = unset
23+
indent_size = unset

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* text=auto eol=lf
2+
*.sol linguist-language=Solidity

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
**/.env
2+
yarn.error.log
3+
.yalc
4+
yalc.lock
5+
coverage*
6+
.vscode/*
7+
node_modules/
8+
.idea/
9+
.DS_Store

‎.vscode/extensions.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"recommendations": [
3+
"dbaeumer.vscode-eslint",
4+
"editorconfig.editorconfig",
5+
"esbenp.prettier-vscode",
6+
"hbenl.vscode-mocha-test-adapter",
7+
"juanblanco.solidity",
8+
"gamunu.vscode-yarn",
9+
"atlassian.atlascode"
10+
],
11+
"unwantedRecommendations": []
12+
}

‎.vscode/launch.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"type": "node",
6+
"request": "launch",
7+
"name": "hardhat node",
8+
"skipFiles": ["<node_internals>/**"],
9+
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/hardhat",
10+
"args": ["node"],
11+
"cwd": "${workspaceFolder}"
12+
},
13+
{
14+
"type": "node",
15+
"request": "launch",
16+
"name": "hardhat fork:deploy mainnet",
17+
"skipFiles": ["<node_internals>/**"],
18+
"runtimeExecutable": "yarn",
19+
"args": ["fork:deploy", "mainnet", "--blockNumber", "12379516"],
20+
"cwd": "${workspaceFolder}"
21+
}
22+
]
23+
}

‎.vscode/settings.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.defaultFormatter": "esbenp.prettier-vscode",
4+
"editor.codeActionsOnSave": {
5+
"source.fixAll": true
6+
},
7+
"[typescript]": {
8+
"editor.defaultFormatter": "esbenp.prettier-vscode"
9+
},
10+
"solidity.linter": "solhint",
11+
"solidity.enableLocalNodeCompiler": false,
12+
"solidity.compileUsingRemoteVersion": "v0.7.5+commit.eb77ed08",
13+
"solidity.packageDefaultDependenciesContractsDirectory": "",
14+
"solidity.enabledAsYouTypeCompilationErrorCheck": true,
15+
"solidity.validationDelay": 1500,
16+
"solidity.packageDefaultDependenciesDirectory": "node_modules",
17+
"mochaExplorer.env": {
18+
"HARDHAT_CONFIG": "hardhat.config.ts",
19+
"HARDHAT_COMPILE": "true",
20+
"NODE_OPTIONS": "--max-old-space-size=4096 --unhandled-rejections=strict"
21+
},
22+
"mochaExplorer.require": ["ts-node/register/transpile-only"],
23+
"[markdown]": {
24+
"editor.formatOnSave": false
25+
}
26+
}

‎README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Smart-Contracts for [The Sandbox](https://www.sandbox.game)
2+
3+
[www.sandbox.game](https://www.sandbox.game)
4+
5+
The Sandbox is a user-generated content (UGC) gaming platform that will empower creators through digital ownership and
6+
monetization of 3D voxel creations made and shared by users around the world.
7+
8+
Learn more:
9+
10+
- Website: www.sandbox.game
11+
- Discord: https://discordapp.com/invite/vAe4zvY
12+
- Telegram: https://t.me/sandboxgame
13+
- Medium: https://medium.com/sandbox-game
14+
15+
# Blockchain Features
16+
17+
We’re adopting the best standards to reach to players who are not familiar with Blockchain and Web3 technologies,
18+
simplifying the UX and on-boarding
19+
20+
- Dual token structure smart-contract: [ERC-721](https://eips.ethereum.org/EIPS/eip-721)
21+
/ [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155)
22+
- Escrowless Auctions
23+
- Meta-Transactions
24+
- [EIP-712 DRAFT](https://eips.ethereum.org/EIPS/eip-712) for Human-Readable signature messages
25+
- [EIP-1776 DRAFT](https://github.com/ethereum/EIPs/issues/1776) submitted by Pixowl to Ethereum for Native
26+
Meta-Transactions
27+
28+
More detailed information can be found on our Medium
29+
article: [https://medium.com/sandbox-game/blockchain-features-in-the-sandbox-7db91fcc615c](https://medium.com/sandbox-game/blockchain-features-in-the-sandbox-7db91fcc615c)
30+
31+
---
32+
33+
# Get Started Instructions
34+
35+
If you want to check out our contracts and run the test follow these instructions :
36+
37+
SETUP :
38+
39+
```
40+
yarn
41+
```
42+
43+
RUN TESTS :
44+
45+
```
46+
yarn test
47+
```
48+
49+
ENVIRONMENT VARIABLES :
50+
51+
The root of this repo contains a `example.env` file. You can copy this to your own `.env` file and populate the FIELDS
52+
with your own values. We use the MNEMONIC field to hold your seed-phrase. Alternately, if you want to use an HD-Wallet,
53+
the buidler-docs have a section on configuration here: https://buidler.dev/config/#hd-wallet-config
54+
55+
# Technical Documentation
56+
57+
You can explore here the documentation of our tokens and blockchain featurs:
58+
59+
- our ERC-20 token : [SAND](documentation/Sand.md)
60+
- Meta-Transaction implementation (EIP-1776) : [Meta-Transactions](documentation/meta_transactions.md)
61+
62+
- our ERC-1155/ERC-721 Asset token : [ASSET](documentation/Asset.md)
63+
64+
- our ERC-721 LAND token : [LAND](documentation/Land.md)
65+
66+
- our Marketplaces features: [Escrowless Auctions](documentation/escrow_less_auctions.md)
67+
- our User-Generated Content Moderation Policies using [Prediction Market](documentation/curation.md)
68+
69+
# Your First Pull Request
70+
71+
We are using feature branches to host the code of an upcoming feature. All feature branches start with "feat/"
72+
prefix, each feature branch is intended for a single purpose. The following branches will reject direct pushes:
73+
74+
- master branch
75+
- "feat/" prefixed branches
76+
77+
So, in order to commit your changes to master you will have to
78+
79+
- git checkout master
80+
- git checkout -b feat/exampleFeature
81+
- git push --set-upstream origin feat/exampleFeature
82+
- git checkout -b exampleFeature
83+
- git push --set-upstream origin exampleFeature
84+
85+
Now you can write your code and push your changes to the exampleFeature branch, once your'e done you need to open a pull
86+
request from exampleFeature to feat/exampleFeature, and then another pull request from feat/exampleFeature to master.

‎config-packages/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Config packaged
2+
3+
The packages in this directory are not meant to be published, but are just default configuration for different tools.

‎config-packages/eslint/index.js‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
const path = require('path');
2+
const tsconfigPath = path.join(__dirname, './tsconfig.json');
3+
module.exports = {
4+
ignorePatterns: [
5+
'artifacts/',
6+
'cache/',
7+
'coverage/',
8+
'node_modules/'
9+
],
10+
root: true,
11+
extends: ['eslint:recommended', 'plugin:mocha/recommended', 'prettier'],
12+
parserOptions: {
13+
ecmaVersion: 2020,
14+
},
15+
plugins: ['mocha'],
16+
env: {
17+
commonjs: true,
18+
node: true,
19+
mocha: true,
20+
},
21+
overrides: [
22+
{
23+
files: ['*.ts'],
24+
parser: '@typescript-eslint/parser',
25+
parserOptions: {
26+
project: [tsconfigPath],
27+
ecmaVersion: 2020,
28+
sourceType: 'module',
29+
},
30+
plugins: ['mocha', '@typescript-eslint'],
31+
extends: [
32+
'eslint:recommended',
33+
'plugin:@typescript-eslint/recommended',
34+
'plugin:mocha/recommended',
35+
'prettier',
36+
'prettier/@typescript-eslint',
37+
],
38+
rules: {
39+
'@typescript-eslint/no-misused-promises': 'error',
40+
'@typescript-eslint/no-floating-promises': 'error',
41+
},
42+
},
43+
],
44+
};
45+

‎config-packages/eslint/package.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"name": "eslint-config-custom",
3+
"version": "0.0.1",
4+
"main": "index.js",
5+
"private": true,
6+
"dependencies": {
7+
"eslint": "latest",
8+
"eslint-config-prettier": "latest"
9+
}
10+
}

0 commit comments

Comments
 (0)