Skip to content

The best place to get started with all things decentralized

Notifications You must be signed in to change notification settings

koii-network/ezsandbox

Repository files navigation

banner_with_icon

Powered by Koii - Over 60,000 community devices at your fingertips

Curious to see the source code? Learn More

Welcome to EZSandbox

In this series of workshops, we'll get you up and running to build your first community-hosted application in no time.

This sandbox will take you through a few phases of development to try using Koii Tasks at all levels.

  1. Deploy Locally on your Koii Task Node to Debug and Iterate Rapidly

  2. Deploy to Docker to test audits and incentive mechanisms

  3. Launch on the Community Cloud

Lessons and Code Samples

In this project, we'll start by demonstrating the key features of the Node compute environment. After some local testing, we'll harden our incentive mechanism and deploy it to the Koii cloud.

Koii is a network of people, using their nodes to support a diverse ecosystem of products and services, all operated by community members like you.

Decentralized Applications on the Koii Cloud run in modules called 'Tasks' and anyone can join by running a Koii Node, a program users install which manages and runs Tasks.

At the end of these tutorials, you'll be ready to build your first Koii Application that other community members can then run on their Node.



Koii tasks

Lesson 1: Introduction to Koii Tasks

In the first lesson, we'll set up a Koii Node and start debugging an existing Task.

This lesson will teach you:

  • How to debug tasks live with your Node
  • How Tasks run in the node
  • How to connect to your node

Start Here



Networking and storage

Lesson 2: Networking and Storage Task

Once we've got the basics down, we can move on to writing a task of our own. We'll learn how to use networking and storage with the example of a simple file server. We'll also see how to deploy our app on a Dockerized node and test it out locally.

Start Here



Secrets & Config

Lesson 3: Secrets & Config

One of the best use cases for Koii nodes is to gather data from the web. In this tutorial, we'll show you how to use local secrets on your node, take a closer look at the config options, and learn how to build out a full web crawler that runs on any participating Task Nodes.

Start Here



Auditing & Distribution

Lesson 4: Auditing & Distribution

We can now start to add audit and distribution mechanisms, learning more about how to verify work and define incentives. We'll also learn how data can be shared between nodes by looking at an example.

Start Here



Security & Hardening

Lesson 5: Security & Hardening

Now that you've seen several different types of tasks, this lesson will cover how to add authorized accounts, verify signatures, and manage general authentication and data authority issues.

Start Here



Custom Tokens

Lesson 6: Using Custom Tokens for Tasks

This lesson will teach you how to deploy your own custom KPL token on Koii.

Start Here



Deployment

Lesson 7: Deploying your Task

Once everything is tightened down, it's time to get your community and start running nodes. We'll get you a small grant in KOII to fund your task bounty, deploy the task, and run it on your node.

Start Here



Performance Improvements

Lesson 8: Performance Improvements

After your task is live, it's time to consider improving your work. In this final lesson, we'll cover some tips on debugging, multi-node simulations, and how to publish an update to your Task.

Start Here



Open Source Roadmap

Koii is committed to being an open source project, but we are a small team and focused on improving developer and user experience at the moment.

  • K2 has been audited by Halborn, a leading security firm and the original auditor of the Solana codebase which it was forked from. K2 is planned to be open sourced in mid July 2024. Click here for the Full Audit Report
  • The Task Node is currently being audited, and we plan to open source that codebase as soon as it has been fully audited. This decision was made to protect the community of node operators from any critical vulnerabilities, but we do offer the source code to community members, and you can ask to receive access by contacting us on discord. Usually these requests are resolved within 48 hrs.

We are sorry that we can't do this sooner.

This code base has been rapidly iterated, with now over 70 versions, so it was only recently possible to begin audits and we are keen to open source the codebase right away.

About

The best place to get started with all things decentralized

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published