Skip to content

Quickstart Guide

The Oasis Dashboard is the best way to get started on the Oasis platform. The Dashboard provides a single place to view, create, and deploy smart contracts. Build your own or choose from a curated collection of pre-made smart contracts.

Note

We expect to issue one major upgrade of the Oasis Devnet per quarter. In addition to new features and experiences, some of these upgrades may require us to reset the Devnet's state, which includes contracts deployed through the dashboard. We will be sure to provide you with ample time and instructions to ensure this affects your own work on the Devnet as little as possible.

Step 1: Setup your account

To get started, log in to the dashboard, dashboard.oasiscloud.io. To sign in, you'll need a Google or a Github account.

Dashboard OAuth

Once you login, we will auto-fund your account to be able to deploy apps, and will do so periodically. If your usage exceeds our auto funding limit, please send us a note at support@oasislabs.com and we will be happy to assist you.

Note

If you do have MetaMask in your browser, you can optionally use your existing wallet by importing it in the Account Settings.

Dashboard OAuth

Step 2: Create a project

The homepage of the Dashboard shows a list of existing projects (when you first log in this is likely to be empty). To create your first project, press the "+" button in the lower right of the page. You'll be prompted to enter a name. Projects can include multiple contracts or multiple versions of a contract.

Step 3: Add a smart contract to your project

A project page will show all contracts associated with a particular project you're working on.

View of contracts

There are two types of contracts that you can use in your project:

  • My Contracts: This shows the smart contracts you've uploaded to the dashboard. This is a powerful mechanism for writing custom cloud logic.
  • Public Contracts: This shows smart contracts created and shared by other users. Here you can find a curated collection of pre-made contracts you can use in your own projects without developing your own smart contract code. When you deploy your own smart contracts you can also decide to make them public and share with other Devnet users.

Clicking on any of these contracts will take you to a page describing the API of the contract. Let's pick Secret Ballot contract for example. Deploy Contract

Step 4: Deploy a smart contract

On the contract page, you'll see a 'Deploy' button on the bottom right. Clicking 'Deploy' will prompt you to name the new deployment, and will ask you to fill in constructor arguments to the contract if required.

Deploy Contract

Note

To share your smart contract with other Devnet developers click the slider at the top of the contract to make it visible to public. You can also mark your contract to stop serving at a certain time by toggling Contract Expiration.

Once you confirm your deployment, a new instance of the deployment will be published to the Oasis Devnet, and will show up as a 'Deployment' on your project page.

Contracts deployed through the Developer Dashboard will be deployed as confidential.

Note

If you have MetaMask installed, you'll be prompted to by MetaMask to confirm the deployment, and it will be made from your account. If you don't have MetaMask installed, the Oasis Dashboard will generate a new account for you, and deploy your contracts under that account. You can later transition your account to a MetaMask wallet you control, so that Oasis Labs can no longer make transactions without your explicit approval. For more information, we've shared our best practices for wallet management.

Step 5: View your deployment

View of a deployment

On your project page, you can now see the new deployment. Clicking on the deployment will allow you to see

  • The address of the deployed contracts, so you can programatically interact with it.
  • The interface of the deployed contract, used by many programs to learn the valid methods that can be called.
  • The arguments you set when you deployed the contract.

Congratulations! You just deployed your first contract on Oasis.

Note about rate limiting

The Oasis Devnet currently enforces a rate limit to prevent spamming and ensure a high quality experience for developers. If your transactions fail, please reduce the rate of your requests or wait a little while before trying again. If these limits are causing an issue for your DApp, please contact support@oasislabs.com.

What's next

  • Develop smart contracts locally using Oasis Contract Kit.
  • Develop a mobile app with Thunkable, a drag-and-drop mobile app service, to test your smart contract with other users.

Learn from tutorials

Here are some tutorials to get started:

Tools

The Oasis Devnet provides a number of tools and resources to help with DApp development. Here are some important links:

Name URL Description
Status dashboard https://oasislabs.statuspage.io View network status and downtime
Oasis explorer https://dashboard.oasiscloud.io/explorer View transactions on Devnet
Issue tracker https://www.github.com/oasislabs/devnet-issues/issues Submit bug reports and feature requests