Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions docs/intro.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/overview/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Overview",
"position": 1,
"collapsed": false
}
59 changes: 59 additions & 0 deletions docs/overview/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: intro
slug: /
title: Welcome to Overlock Network
sidebar_position: 0
sidebar_label: 'Introduction'
---

# 🌐 Welcome to Overlock Network

**Overlock Network** is a decentralized system for managing external infrastructure through distributed execution.
It is built with the [**Cosmos SDK**](https://cosmos.network/appchains/) and extends the control plane model using [**Crossplane**](https://crossplane.io) .

In Overlock Network, Active Resources are on-chain definitions that tell provider-hosted controllers how to create and manage infrastructure in cloud and edge environments.
As a result, Overlock Network can coordinate infrastructure on platforms such as GCP, AWS, Azure, Akash, DigitalOcean, and others.

---

## 🧱 Core Concepts

The network is centered around a small number of composable, on-chain objects:

- **Active Resources**
Describe the infrastructure or services to be created and managed externally.

- [**Configuration NFTs**](./overview/nft-config)
Represent access to reusable infrastructure definitions (similar to a configuration library).

- [**Gas NFTs**](./overview/nft-gas)
Store a balance of execution tokens, which are gradually consumed as infrastructure operations are performed.

---


## 🌍 Distributed Providers

Overlock does not run infrastructure itself.
Instead, it relies on an open set of **independent providers** who run trusted execution environments and Crossplane-based controllers.
These providers process on-chain requests, access cloud APIs, and consume gas as work is completed.

Each interaction is tied to ownership:
- users retain control through NFTs and token balances
- providers receive compensation through gas consumption

---

## 🧩 Modularity and Extensibility

Overlock is designed to support many use cases:
- cloud automation
- edge orchestration
- multi-provider workflows
- agent-based infrastructure management

Its primitives — Active Resources, Configuration NFTs, and Gas NFTs — can be extended or composed to support increasingly complex systems and tooling.

---

Overlock Network provides a programmable and verifiable way to control external infrastructure — with ownership and automation at its core.
65 changes: 65 additions & 0 deletions docs/overview/nft-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
id: nft-config
title: Configuration NFTs
sidebar_position: 1
label: 'Overview'

---

Configuration NFTs represent ownership of a resource library — a packaged set of instructions and definitions used to create Active Resources within the network.

These NFTs do not activate resources directly. Instead, they grant the user the right to use a specific configuration when creating new resources.

---

## 🎯 What They Represent

Each Configuration NFT corresponds to a resource library.
This library defines how a particular type of infrastructure or service is created, including parameters, components, and system behavior.

Owning the NFT means the user is allowed to use that configuration across the network.

---

## ⚙️ How It Works

When a user obtains a Configuration NFT, it is stored in their wallet.
Later, when they create a new Active Resource through the Console or API, the system automatically checks if they own the required NFT.

If they do, the configuration is installed during resource creation.
This process is seamless — the resource provider doesn't need to manage configurations manually.

---

## 🧩 Why It’s Needed

Configuration NFTs make it possible to:

- Distribute infrastructure templates across the network
- Prove configuration ownership on-chain
- Allow providers to install and apply user-selected logic securely
- Ensure only authorized users can trigger configuration-based resource creation

---

## 🔄 Transfer and Reuse

Configuration NFTs are transferable. A user can pass or sell the NFT to another wallet, which then gains the right to use that configuration.

The same configuration can be used by many users — each with their own copy of the NFT.

---

## 📌 Features

- Can include versioning, expiration, or policy metadata
- May be bundled with Gas NFTs or other entitlements
- Enable modular, reusable, and decentralized infrastructure logic

---

## ✅ Summary

Configuration NFTs are the key to owning and using resource creation logic in the network.
They do not execute or control anything directly — but without them, resources cannot be created.
They let the Console and providers know: *“this user has the right to use this library.”*
59 changes: 59 additions & 0 deletions docs/overview/nft-gas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: nft-gas
title: Gas NFTs
sidebar_position: 2
---

Gas NFTs (Execution Credit Containers) are digital containers that store execution credit.
They allow you to run and maintain Active Resources in the network by holding a prepaid balance of resource tokens.

These tokens are securely stored on a dedicated account linked to the NFT.
You don’t need to manage this account directly — the system handles everything automatically during usage.

---

## 🎯 What a Gas NFT Does

If you hold a Gas NFT, it means you have fuel to power your infrastructure.

Whenever you create or use an Active Resource, the system checks the available credit and deducts what’s needed from the linked account.

---

## 🔁 Using and Reusing

You can use a Gas NFT until its credit is fully spent.
You can also transfer it to someone else — they’ll get access to the remaining gas.

There’s no need to refill or adjust anything manually. If you need more gas, simply get another NFT or receive one from someone else.

---

## 🔄 Flexible and Transferable

Gas NFTs are easy to trade, gift, or bundle with other types of NFTs.
For example, you might receive a configuration and gas together as part of a setup pack.

As long as the NFT still holds credit, it can be used by whoever owns it.

---

## 💡 Types of Gas NFTs

Some Gas NFTs might include additional features:

- **Nitro Packs** for high-performance access
- **Promo Drops** with bonus fuel
- **Timed Fuel** that expires if not used by a certain date

These variations let users choose the right kind of gas for their needs.

---

## ✅ Summary

A Gas NFT is your prepaid fuel card for the network.
It connects to a special account that holds your resource credit, which is used automatically as you create and run Active Resources.

You stay in control — just hold it, use it, or pass it on.
When it’s empty, get a new one and keep going.