Code Monkey home page Code Monkey logo

thesandboxgame / sandbox-smart-contracts Goto Github PK

View Code? Open in Web Editor NEW
171.0 20.0 86.0 152.57 MB

The Sandbox is a user-generated content (UGC) gaming platform that will empower creators through digital ownership and monetization of 3D voxel creations made and shared by users around the world.

Home Page: https://www.sandbox.game

License: MIT License

JavaScript 5.60% TypeScript 77.08% Solidity 17.32%
blockchain ethereum gaming creators assets nft ugc voxel

sandbox-smart-contracts's Introduction

The Sandbox Smart Contracts

Build Status Node Version Discord

The Sandbox is a user-generated content (UGC) gaming platform, that will empower creators through digital ownership and monetization of 3D voxel creations made and shared by users around the world.

This mono-repo contains The Sandbox smart contracts, underpinning The Sandbox metaverse. Our key token contracts were conceived inside the core package. You can find out more about some of our early blockchain features in this article. Since core was created, we have added new contracts and updates via new packages - see the below Architecture Overview for more information.

Learn more

Prerequisites

Tech stack and getting started

This workspace uses Nx: a smart, fast and extensible build system. Run nx graph to see a diagram of the dependencies of the projects.

To add a package simply add it inside the packages directory. Every package can implement the following targets that will be run by the root package.json scripts and on the CI:

  • test: run unit tests inside your new package.
  • coverage: run coverage. Note: CI expects to have at least 80% coverage.
  • lint: lint your code.
  • format: format the code with prettier.

See packages/example-hardhat for an example template package for smart contract development with Hardhat.

Refer to each package's readme for more information about that package. Note that deployment for all new packages is carried out via packages/deploy. Each package should follow the audit best practices where applicable.

Developer quickstart

yarn install

Install Slither (optional)

pip3 install -r requirements.txt

Architecture Overview

  • ๐Ÿ“ฆ This mono-repository contains a suite of smart contract packages.
  • โš–๏ธ The mono-repository is released under MIT license. Note, that the packages may contain their own licenses.
Package Version License Description
@sandbox-smart-contracts/packages/core npm License: MIT ๐Ÿ—๏ธ Core smart contracts (pre 2023)
@sandbox-smart-contracts/packages/deploy N/A License: MIT ๐Ÿš€ Deploy all packages (except core)
@sandbox-smart-contracts/packages/example-hardhat N/A License: MIT ๐Ÿ‘ท Development template using Hardhat
@sandbox-smart-contracts/packages/giveaway npm License: MIT ๐ŸŽ Instant Giveaway smart contract claims
@sandbox-smart-contracts/packages/dependency-metatx npm License: MIT ๐ŸŒ Dependency: ERC2771 handler
@sandbox-smart-contracts/packages/marketplace npm License: MIT ๐Ÿ›๏ธ The Sandbox marketplace contracts
@sandbox-smart-contracts/packages/dependency-royalty-management npm License: MIT ๐ŸŽจ Dependency: The Sandbox Royalty Implementation in partnership with Manifold's royalty-registry
@sandbox-smart-contracts/packages/dependency-operator-filter npm License: MIT ๐Ÿค Dependency: The Sandbox's implementation for OpenSea's operator filter
@sandbox-smart-contracts/packages/asset npm License: MIT ๐Ÿš— Asset contract upgrade for L2 deployment featuring tiers, abilities, operator-filter and creator royalties

Contributing

Bug bounties

Submit a bug at Immunefi to help secure our smart contracts!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.