# Creating an Entity Package
Entity Packages are only required at the beginning of a network. If the network is already running then this will no longer be used
In order to join at the beginning of The Quest (our staking competition), or at the beginning of any network (including Oasis Mainnet), we require that you send an Entity Package so that we can create the genesis document for a either network.
To create an Entity Package you must create a tarball (
.tar.gz) that contains
the following files:
entity/entity_genesis.json- This is the
entity_genesis.jsonfrom the entity you initialized.
entity/entity.json- This is the
entity.jsonfile from the entity you initialized.
node/node_genesis.json- This is the
node_genesis.jsonfrom the node you initialized.
During genesis creation we will only accept a single node.
The following commands should be executed on your local system, where you initialized your Entity and Node:
mkdir -p package/entity package/node cp /localhostdir/entity/*.json package/entity cp /localhostdir/node/node_genesis.json package/node cd package && tar -zcvf ../<YOUR-GITHUB-USERNAME>-entity.tar.gz entity node
If possible, please use the same GitHub handle to submit your Entity Package as you used to sign the waiver to join The Quest.
# Submitting Your Entity Package (For The Quest)
To submit your Entity Package, we've created a repository that will consume and validate the Entity packages used in The Quest.
- Fork the oasislabs/the-quest-entities repository.
- Add your Entity Package to the
entities/directory of the repository.
- Create a pull request against the
masterbranch of the oasislabs/the-quest-entities repository. Once your Entity Package passes all validation checks we will handle the merging of your pull request.
You can see an example of a submission in this PR.
If there are any issues, you can always resubmit your entity package.