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

Commit 1f9db20

Browse files
author
Andres Adjimann
committed
feat: inital structure and template project
1 parent 7da55b8 commit 1f9db20

File tree

6 files changed

+5052
-0
lines changed

6 files changed

+5052
-0
lines changed

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

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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+
# Technical Documentation
50+
51+
You can explore here the documentation of our tokens and blockchain featurs:
52+
53+
- our ERC-20 token : [SAND](documentation/Sand.md)
54+
- Meta-Transaction implementation (EIP-1776) : [Meta-Transactions](documentation/meta_transactions.md)
55+
56+
- our ERC-1155/ERC-721 Asset token : [ASSET](documentation/Asset.md)
57+
58+
- our ERC-721 LAND token : [LAND](documentation/Land.md)
59+
60+
- our Marketplaces features: [Escrowless Auctions](documentation/escrow_less_auctions.md)
61+
- our User-Generated Content Moderation Policies using [Prediction Market](documentation/curation.md)
62+
63+
# Your First Pull Request
64+
65+
We are using feature branches to host the code of an upcoming feature. All feature branches start with "feat/"
66+
prefix, each feature branch is intended for a single purpose. The following branches will reject direct pushes:
67+
68+
- main branch
69+
- "feat/" prefixed branches
70+
71+
So, in order to commit your changes to master you will have to
72+
73+
- git checkout master
74+
- git checkout -b feat/exampleFeature
75+
- git push --set-upstream origin feat/exampleFeature
76+
- git checkout -b exampleFeature
77+
- git push --set-upstream origin exampleFeature
78+
79+
Now you can write your code and push your changes to the exampleFeature branch, once your'e done you need to open a pull
80+
request from exampleFeature to feat/exampleFeature, and then another pull request from feat/exampleFeature to master.

package.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "contracts",
3+
"version": "0.0.1",
4+
"workspaces": [
5+
"packages/*"
6+
],
7+
"private": true,
8+
"description": "TheSandbox game smart contracts",
9+
"scripts": {
10+
"test": "yarn workspaces run test"
11+
},
12+
"repository": {
13+
"type": "git",
14+
"url": "https://github.com/thesandboxgame/contracts.git"
15+
},
16+
"keywords": [],
17+
"author": "",
18+
"license": "MIT",
19+
"bugs": {
20+
"url": "https://github.com/thesandboxgame/contracts/issues"
21+
},
22+
"homepage": "https://github.com/thesandboxgame/contracts#readme",
23+
"packageManager": "yarn@3.4.1"
24+
}

packages/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Smart-Contracts for [The Sandbox](https://www.sandbox.game) source code workspaces
2+
3+
This directory contains the source code used by [The Sandbox](https://www.sandbox.game)
4+
5+
Each workspace can use any tool needed for development, but, it must have at least one the test npm script to run tests
6+
7+
We recommend:
8+
9+
- hardhat
10+
- hardhat-toolbox
11+
- typescript
12+
- eslint
13+
- prettier
14+
- solcover
15+
- solhint
16+
17+
# Deploy
18+
19+
Each workspace must export via nmp the solidity source code then we import the source code from different places in the
20+
deploy workspace that manage the deployment to our different environments.

0 commit comments

Comments
 (0)