Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added links, BiAs #99

Merged
merged 1 commit into from
Jul 12, 2024
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
8 changes: 4 additions & 4 deletions docs/capabilities/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_position: 1
**Gear** enables individuals to create and execute custom-logic programs in a decentralized manner and more.

Gear can be considered as a go-to solution for the following cases:
- Provide a technological foundation for constructing highly scalable and rapid decentralized Layer-1 networks.
- Run arbitrary business logic dApps on Gear Networks at near-native speeds. Upload programs to the network and interact with them.
- Establish cross-chain communications between other Substrate-supported blockchains.
- Provide a technological foundation for constructing highly scalable and rapid decentralized Layer-1 networks (such as the [Vara Network](https://vara.network/)).
- Run arbitrary business logic dApps on Gear-powered networks at near-native speeds. Upload programs to the network and interact with them.
- Reduce the computational burden on blockchains by offloading highly intensive calculations using Gear node with WAVM, and then prove the correctness of these calculations on any blockchain.
- Use a Gear node as a standalone instance running microservices, middleware, open API and more
- Use a Gear node as a standalone instance running microservices, middleware, open API and more.
- Establish cross-chain communications between other Substrate-supported blockchains.
8 changes: 5 additions & 3 deletions docs/capabilities/use-cases/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ title: Onboarding
sidebar_position: 1
---

# Onboarding

The key to the success and broad adoption of Gear technology lies in its ease of use and fast onboarding process, especially for program developers.

To facilitate this, a comprehensive knowledge hub, the **[Gear Wiki](https://wiki.gear-tech.io/)**, is available. This resource includes detailed information about Gear's components, Rust libraries, how to build, run, and interact with the Node, and how to write and test programs.
To facilitate this, a comprehensive knowledge hub, the **[Vara Wiki](https://wiki.vara.network/)**, is available. This resource includes detailed information for developers about Gear's components, Rust libraries, how to build, run, and interact with the Node, and how to write and test programs.

The Wiki also offers multiple **[examples](https://wiki.gear-tech.io/docs/examples/prerequisites)** of programs and smart contracts for popular use cases such as token standards (fungible, non-fungible and more), games, DeFi, infrastructure, auctions, supply chain, ZK, DAO and more. Some smart contract examples are accompanied with the user interface implementation that demonstrates integration capabilities between the frontend/backend and smart contracts on a Gear Network.
The Wiki also offers multiple **[examples](https://wiki.vara.network/docs/examples/)** of programs and smart contracts for popular use cases such as token standards (fungible, non-fungible, and more), games, DeFi, infrastructure, auctions, supply chain, ZK, DAO, and more. Some smart contract examples are accompanied by user interface implementations that demonstrate integration capabilities between the frontend/backend and smart contracts on the Gear Network.

Alongside the Wiki is **[Gear IDEA](https://idea.gear-tech.io/)**, a tool that provides developers with an easy and efficient way to deploy programs to Gear networks and interact with them directly in their browser. It's designed to make it easier for developers to get familiar with the Gear Protocol, manage accounts and balances, observe transaction events, and more.
Alongside the Wiki is **[Gear IDEA](https://idea.gear-tech.io/)**, a tool that provides developers with an easy and efficient way to deploy programs to the Vara network and interact with them directly in their browser. It's designed to make it easier for developers to get familiar with the Gear Protocol, manage accounts and balances, observe transaction events, and more.
4 changes: 1 addition & 3 deletions docs/conclusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,10 @@ https://github.com/gear-tech/gear

https://docs.gear.rs/

https://wiki.gear-tech.io/
https://wiki.vara.network/

https://vara.network/

https://wiki.vara.network/

https://idea.gear-tech.io/

https://docs.substrate.io/v3
10 changes: 10 additions & 0 deletions docs/features/bias.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Built-in-Actors
sidebar_position: 6
---

# Built-in-Actors

Built-in-Actors (BiAs) are specialized entities within the Gear runtime that execute specific business logic when programs communicate with them via messages. This feature addresses a key limitation: while users can directly interact with pallets through extrinsics like bond, nominate, vote, etc., programs within the Gear Protocol can only send messages, not extrinsics.

BiAs enhance the capabilities of programs (smart contracts) to the user level. Features typically implemented through pallets and accessible only via extrinsics are now available to programs. This includes using balances for governance voting, issuing vouchers, staking funds, enabling other actors to perform operations on behalf of the program (proxying), conducting complex computations, and more. This expansion significantly enhances the functionality and potential applications of blockchain programs.
2 changes: 1 addition & 1 deletion docs/features/gasless.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Gasless Transactions
sidebar_position: 6
sidebar_position: 7
---

Gear Protocol's capability to enable gasless transactions in decentralized applications (dApps) for end-users revolutionizes the Web3 landscape, fostering widespread adoption of dApps and aligning their user experience with the ease of use found in Web2 services.
Expand Down
2 changes: 1 addition & 1 deletion docs/features/signless.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Signless Transactions
sidebar_position: 7
sidebar_position: 8
---

One of the most frustrating aspects of blockchain technology is the need for users to manually sign transactions. When interacting with digital applications, users must sign transactions with their private keys in order to send commands, such as requesting funds or taking actions in a game. This tedious process significantly hinders the adoption of blockchain applications, as users tend to prefer less secure but more convenient web2 services.
Expand Down
8 changes: 4 additions & 4 deletions docs/foundation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Gear Foundation
sidebar_position: 7
---

While Gear Development Company is one of many contributors to the Gear Protocol, the **Gear Foundation** is an independent nonprofit foundation intended to support the development and usage of a Gear Network.
While Gear Development Company is one of many contributors to the Gear Protocol, the **[Gear Foundation](https://gear.foundation/)** is an independent nonprofit foundation intended to support the development and usage of a Gear-powered **[Vara Network](https://vara.network/)**.

The Gear Foundation's mission is to lower the barrier to entry for blockchain development, to introduce an entirely new pool of talented developers to the Web3 and blockchain industry, onboarding them to the innovative and interoperable Substrate ecosystem. This will spur adoption and usage of blockchain technology, unleashing the potential of the next evolution of the internet - Web3.

**Gear Foundation** wants to support developers and applications that will add utility to the Gear ecosystem. Projects have the ability to participate in the Gear ecosystem by joining the Grants Program. It provides support and expertise that will maximize the project's usage and development. Projects joined the program may receive access to resourcing, developer tools, end-to-end support and a network of developers and connections throughout the industry.
**Gear Foundation** wants to support developers and applications that will add utility to the Gear ecosystem. Projects have the ability to participate in the Gear ecosystem by joining the **[Grants Program](https://vara.network/grants)**. It provides support and expertise that will maximize the project's usage and development. Projects joined the program may receive access to resourcing, developer tools, end-to-end support and a network of developers and connections throughout the industry.

Another initiative set up by **Gear Foundation** is the Gear Ambassador program. It is intended to provide a platform for members of the Gear community to organize, participate in, and create awareness about the Gear ecosystem. The main goal of the ambassador program is to educate the Gear community and others about developments in Web3 technology and Gear Network. This includes producing original educational and informational content like videos and articles, organizing and hosting online and in-person development workshops and hackathons, contributing to technical documentation, translating existing educational material, and engaging with community platforms by sharing knowledge about Gear and answering questions on Discord or partaking in conversations on platforms like Telegram.
Another initiative set up by **Gear Foundation** is the **[Vara Ambassador program](https://vara.network/ambassadors)**. It is intended to provide a platform for members of the Vara community to organize, participate in, and create awareness about the Gear ecosystem. The main goal of the ambassador program is to educate the Gear community and others about developments in Web3 technology and Gear Network. This includes producing original educational and informational content like videos and articles, organizing and hosting online and in-person development workshops and hackathons, contributing to technical documentation, translating existing educational material, and engaging with community platforms by sharing knowledge about Gear and answering questions on Discord or partaking in conversations on platforms like Telegram.

Moreover, the **Gear Foundation** collaborates with, and supports, existing projects that are written on different frameworks and running on other networks to deploy their applications on a Gear Network. Gear’s simple and understandable framework is capable of enabling effortless re-implementation of existing smart contracts from other networks. This, in turn, has the potential to enhance cross-chain interoperability and expand the utilization of these applications.
Moreover, the **Gear Foundation** collaborates with, and supports, [many projects](https://vara.network/ecosystem) that can be written on different frameworks and running on other networks to deploy their applications on the Vara network. Gear’s simple and understandable framework is capable of enabling effortless re-implementation of existing smart contracts from other networks. This, in turn, has the potential to enhance cross-chain interoperability and expand the utilization of these applications.
2 changes: 1 addition & 1 deletion docs/intro/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Introduction",
"label": "About Gear",
"position": 2
}
6 changes: 3 additions & 3 deletions docs/intro/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ sidebar_position: 3

Gear Protocol is an advanced Substrate-based Wasm programming platform. It was designed to enable developers to build and operate custom-logic decentralized applications (dApps) efficiently. The versatility of Gear Protocol makes it an ideal solution for a range of scenarios:

- Gear empowers developers to execute custom logic programs and create dApps on a decentralized Gear Network at speeds comparable to native execution. This allows developers to deploy practically any codebase to the network and have their users interact with it seamlessly.
- A Gear node can be used as a standalone instance running microservices, middleware, open APIs, and more, offering enhanced flexibility and autonomy.
- Gear empowers developers to execute custom logic programs and create dApps on a decentralized Gear-powered network (such as the [Vara Network](https://vara.network/)) at speeds comparable to native execution. This allows developers to deploy practically any codebase to the network and have their users interact with it seamlessly.
- A [Gear node](/docs/components/node.md) can be used as a standalone instance running microservices, middleware, open APIs, and more, offering enhanced flexibility and autonomy.
- Gear offers compatibility with Substrate-supported blockchains on platforms, further expanding its functional reach and versatility.
- Networks deployed using Gear Protocol can provide functionality typically only available to centralized Web2 environments, like parallel processing, autonomous execution, gasless transactions and more. This enables developers to create a wider range of dApps and services with richer feature sets.

Substrate-based chains, like those deployed using Gear Protocol, bring significant enhancements to the blockchain landscape, such as employing energy-efficient proof-of-stake consensus mechanisms, and facilitating community-based authority with Decentralized Autonomous Organizations (DAOs). Furthermore, these chains make use of fast and cost-effective program and smart contract engines powered by the Wasm Virtual Machine. This virtual machine is capable of supporting any general-purpose programming language that can be compiled into Wasm, providing a welcoming and universal runtime for developers.
Substrate-based chains, like those deployed using Gear Protocol, bring significant enhancements to the blockchain landscape, such as employing energy-efficient proof-of-stake consensus mechanisms, and facilitating community-based authority. Furthermore, these chains make use of fast and cost-effective program and smart contract engines powered by the Wasm Virtual Machine. This virtual machine is capable of supporting any general-purpose programming language that can be compiled into Wasm, providing a welcoming and universal runtime for developers.
8 changes: 4 additions & 4 deletions docs/intro/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar_position: 1

Blockchain technology, previously seen as complex and niche, is now gaining wider recognition and use across different sectors. It's increasingly evident that the majority of human interactions - spanning trade, finance, legal matters, environment, and entertainment - are set to have their foundations deeply embedded in blockchain technology. Despite skepticism and pushback against this revolutionary innovation, the unstoppable tide of progress will continue, compelling the world to adapt to the transformative possibilities unlocked by blockchain.

Modern blockchains promise to remedy the constraints of traditional systems. However, due to its unique design decisions, the **Gear Protocol** - hereinafter referred to simply as "**Gear**" - goes beyond providing a highly efficient platform for developing and running decentralized applications.
Modern blockchains promise to remedy the constraints of traditional systems. However, due to its unique design decisions, the **[Gear Protocol](https://gear-tech.io/)** - hereinafter referred to simply as "**Gear**" - goes beyond providing a highly efficient platform for developing and running decentralized applications.

Employing the Actor model at its core, Gear harnesses the power of asynchronous messaging as well as parallel computing. Advanced memory management for programs, coupled with the use of WebAssembly (Wasm), underpins a highly efficient and feature-rich programming platform that operates at minimal cost and that enables applications to run at near-native speeds.
Employing the [Actor model](/docs/features/actor-model.md) at its core, Gear harnesses the power of asynchronous messaging as well as [parallel computing](/docs/features/parallel.md). Advanced memory management for programs, coupled with the use of WebAssembly (Wasm), underpins a highly efficient and feature-rich programming platform that operates at minimal cost and that enables applications to run at near-native speeds.

By implementing deferred messaging, developers can enable continuous automation of their fully on-chain and truly decentralized applications. Gasless and signless transactions, gas reservations, and other features serve as important tools for developers who aim to make their applications as user-friendly as Web2, bringing the benefits of Web3.
By implementing deferred messaging, developers can enable continuous [automation](/docs/features/automation.md) of their fully on-chain and truly decentralized applications. [Built-in-Actors](/docs/features/bias.md) enable programs on the blockchain to access and utilize the functionalities of pallets. Gas reservations, Gasless and signless transaction capabilities, and other features serve as important tools for developers who aim to make their applications as user-friendly as Web2, bringing the benefits of Web3.

In short, Gear offers significant advantages relative to other modern blockchains and Substrate-based platforms, namely:
- Enhanced security and resilience owing to the Actor model that governs communication between users and programs.
Expand All @@ -18,6 +18,6 @@ In short, Gear offers significant advantages relative to other modern blockchain
- Streamlined program development, thanks to a custom runtime and simple yet feature rich native library on Rust.
- Easier onboarding for developers thanks to an extensive set of programs and smart contract examples for a majority of modern use cases.

The term '**Gear Network**', as referred to in this document, encompasses any network that employs the Gear Protocol for deployment, such as Gear’s first standalone L1 network: **[Vara](https://vara.network/)**.
The term '**Gear Network**', as referred to in this document, encompasses any network that employs the Gear Protocol for deployment, such as Gear’s first standalone L1 network: **[Vara Network](https://vara.network/)**.

Primarily, this document serves as a resource to explore the technology, architecture, and components that make up the Gear Protocol, to illuminate the challenges it resolves, and to understand what differentiates Gear from other smart contract platforms for dApp development.
4 changes: 2 additions & 2 deletions docs/vara.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ The fast and scalable Vara Network, which is non-fork upgradable, provides an op

Many next-generation applications, such as gaming and payments, demand low-latency execution. The Vara standalone network offers the fastest on-ramp for these applications, unlocking new potential uses. Additionally, Vara Network presents low transaction costs for users and dApp creators.

Vara Network employs an inclusive and reliable Nominated Proof-of-Stake (NPoS) mechanism to select validators for its consensus protocol. This mechanism selects validators based on their stakes and the funds nominated by other token holders. Running a node or supporting the network as a nominator is incentivized. This approach fosters a more democratic and decentralized process, reducing the risk of centralization, where only the wealthiest entities could become validators.
Vara Network employs an inclusive and reliable **[Nominated Proof-of-Stake (NPoS)](https://wiki.vara.network/docs/staking/)** mechanism to select validators for its consensus protocol. This mechanism selects validators based on their stakes and the funds nominated by other token holders. Running a node or supporting the network as a nominator is incentivized. This approach fosters a more democratic and decentralized process, reducing the risk of centralization, where only the wealthiest entities could become validators.

The vast majority of tokens are held by the community. Vara empowers its community to steer the network's evolution through its on-chain governance mechanism. To ensure decentralization, longevity, and flexibility, Vara adopts the widely accepted OpenGov framework as its native governance model. This framework enables any VARA token holder to participate in Vara’s decentralized governance, influencing future updates or modifications to the network.
The vast majority of tokens are held by the community. Vara empowers its community to steer the network's evolution through its on-chain **[governance](https://wiki.vara.network/docs/governance/)** mechanism. To ensure decentralization, longevity, and flexibility, Vara adopts the widely accepted OpenGov framework as its native governance model. This framework enables any VARA token holder to participate in Vara’s decentralized governance, influencing future updates or modifications to the network.

The primary features of the Vara Network include:
- Fast truly decentralized L1.
Expand Down
Loading