Skip to content

Commit 6b47e97

Browse files
authored
added intro, GNFT and CNFT overview pages (#11)
1 parent a81fed7 commit 6b47e97

File tree

5 files changed

+188
-48
lines changed

5 files changed

+188
-48
lines changed

docs/intro.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

docs/overview/_category_.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "Overview",
3+
"position": 1,
4+
"collapsed": false
5+
}

docs/overview/intro.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
id: intro
3+
slug: /
4+
title: Welcome to Overlock Network
5+
sidebar_position: 0
6+
sidebar_label: 'Introduction'
7+
---
8+
9+
# 🌐 Welcome to Overlock Network
10+
11+
**Overlock Network** is a decentralized system for managing external infrastructure through distributed execution.
12+
It is built with the [**Cosmos SDK**](https://cosmos.network/appchains/) and extends the control plane model using [**Crossplane**](https://crossplane.io) .
13+
14+
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.
15+
As a result, Overlock Network can coordinate infrastructure on platforms such as GCP, AWS, Azure, Akash, DigitalOcean, and others.
16+
17+
---
18+
19+
## 🧱 Core Concepts
20+
21+
The network is centered around a small number of composable, on-chain objects:
22+
23+
- **Active Resources**
24+
Describe the infrastructure or services to be created and managed externally.
25+
26+
- [**Configuration NFTs**](./overview/nft-config)
27+
Represent access to reusable infrastructure definitions (similar to a configuration library).
28+
29+
- [**Gas NFTs**](./overview/nft-gas)
30+
Store a balance of execution tokens, which are gradually consumed as infrastructure operations are performed.
31+
32+
---
33+
34+
35+
## 🌍 Distributed Providers
36+
37+
Overlock does not run infrastructure itself.
38+
Instead, it relies on an open set of **independent providers** who run trusted execution environments and Crossplane-based controllers.
39+
These providers process on-chain requests, access cloud APIs, and consume gas as work is completed.
40+
41+
Each interaction is tied to ownership:
42+
- users retain control through NFTs and token balances
43+
- providers receive compensation through gas consumption
44+
45+
---
46+
47+
## 🧩 Modularity and Extensibility
48+
49+
Overlock is designed to support many use cases:
50+
- cloud automation
51+
- edge orchestration
52+
- multi-provider workflows
53+
- agent-based infrastructure management
54+
55+
Its primitives — Active Resources, Configuration NFTs, and Gas NFTs — can be extended or composed to support increasingly complex systems and tooling.
56+
57+
---
58+
59+
Overlock Network provides a programmable and verifiable way to control external infrastructure — with ownership and automation at its core.

docs/overview/nft-config.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
id: nft-config
3+
title: Configuration NFTs
4+
sidebar_position: 1
5+
label: 'Overview'
6+
7+
---
8+
9+
Configuration NFTs represent ownership of a resource library — a packaged set of instructions and definitions used to create Active Resources within the network.
10+
11+
These NFTs do not activate resources directly. Instead, they grant the user the right to use a specific configuration when creating new resources.
12+
13+
---
14+
15+
## 🎯 What They Represent
16+
17+
Each Configuration NFT corresponds to a resource library.
18+
This library defines how a particular type of infrastructure or service is created, including parameters, components, and system behavior.
19+
20+
Owning the NFT means the user is allowed to use that configuration across the network.
21+
22+
---
23+
24+
## ⚙️ How It Works
25+
26+
When a user obtains a Configuration NFT, it is stored in their wallet.
27+
Later, when they create a new Active Resource through the Console or API, the system automatically checks if they own the required NFT.
28+
29+
If they do, the configuration is installed during resource creation.
30+
This process is seamless — the resource provider doesn't need to manage configurations manually.
31+
32+
---
33+
34+
## 🧩 Why It’s Needed
35+
36+
Configuration NFTs make it possible to:
37+
38+
- Distribute infrastructure templates across the network
39+
- Prove configuration ownership on-chain
40+
- Allow providers to install and apply user-selected logic securely
41+
- Ensure only authorized users can trigger configuration-based resource creation
42+
43+
---
44+
45+
## 🔄 Transfer and Reuse
46+
47+
Configuration NFTs are transferable. A user can pass or sell the NFT to another wallet, which then gains the right to use that configuration.
48+
49+
The same configuration can be used by many users — each with their own copy of the NFT.
50+
51+
---
52+
53+
## 📌 Features
54+
55+
- Can include versioning, expiration, or policy metadata
56+
- May be bundled with Gas NFTs or other entitlements
57+
- Enable modular, reusable, and decentralized infrastructure logic
58+
59+
---
60+
61+
## ✅ Summary
62+
63+
Configuration NFTs are the key to owning and using resource creation logic in the network.
64+
They do not execute or control anything directly — but without them, resources cannot be created.
65+
They let the Console and providers know: *“this user has the right to use this library.”*

docs/overview/nft-gas.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
id: nft-gas
3+
title: Gas NFTs
4+
sidebar_position: 2
5+
---
6+
7+
Gas NFTs (Execution Credit Containers) are digital containers that store execution credit.
8+
They allow you to run and maintain Active Resources in the network by holding a prepaid balance of resource tokens.
9+
10+
These tokens are securely stored on a dedicated account linked to the NFT.
11+
You don’t need to manage this account directly — the system handles everything automatically during usage.
12+
13+
---
14+
15+
## 🎯 What a Gas NFT Does
16+
17+
If you hold a Gas NFT, it means you have fuel to power your infrastructure.
18+
19+
Whenever you create or use an Active Resource, the system checks the available credit and deducts what’s needed from the linked account.
20+
21+
---
22+
23+
## 🔁 Using and Reusing
24+
25+
You can use a Gas NFT until its credit is fully spent.
26+
You can also transfer it to someone else — they’ll get access to the remaining gas.
27+
28+
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.
29+
30+
---
31+
32+
## 🔄 Flexible and Transferable
33+
34+
Gas NFTs are easy to trade, gift, or bundle with other types of NFTs.
35+
For example, you might receive a configuration and gas together as part of a setup pack.
36+
37+
As long as the NFT still holds credit, it can be used by whoever owns it.
38+
39+
---
40+
41+
## 💡 Types of Gas NFTs
42+
43+
Some Gas NFTs might include additional features:
44+
45+
- **Nitro Packs** for high-performance access
46+
- **Promo Drops** with bonus fuel
47+
- **Timed Fuel** that expires if not used by a certain date
48+
49+
These variations let users choose the right kind of gas for their needs.
50+
51+
---
52+
53+
## ✅ Summary
54+
55+
A Gas NFT is your prepaid fuel card for the network.
56+
It connects to a special account that holds your resource credit, which is used automatically as you create and run Active Resources.
57+
58+
You stay in control — just hold it, use it, or pass it on.
59+
When it’s empty, get a new one and keep going.

0 commit comments

Comments
 (0)