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
1 change: 1 addition & 0 deletions docs/ai/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: introduction
title: AI and NEAR
sidebar_label: Introduction
description: "Introduction to NEAR's User-Owned AI vision, featuring Shade Agents for verifiable multichain AI agents, NEAR AI network infrastructure, and Bitte Protocol for smart contract interactions."
---

NEAR's vision is to create a future of **User-Owned AI**, where AI and agents serve their users, not corporations. For this vision to become a reality, AI must protect user data, prioritize the user's interests, and operate on a sustainable, user-aligned economic model. The NEAR ecosystem has multiple technologies to enable User-Owned AI.
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/custom-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: custom-agent-contract
title: Custom Agent Contract
sidebar_label: Custom Agent Contract
description: This document explains how to create and deploy a custom Shade Agent contract on NEAR, including compiling, deploying, and interacting with the contract.
---

import { SigsSupport } from '@site/src/components/sigsSupport';
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: examples
title: What can you Build?
sidebar_label: What can you Build?
description: "Explore example Shade Agent implementations and agentic protocol ideas, including trading agents, DeFi protocols, and autonomous applications."
---

With their extensive list of features, Shade Agents unlock a wide range of new use cases, enable many previously centralized apps to become decentralized, and change how blockchain applications are designed.
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: introduction
title: Shade Agents
sidebar_label: What are Shade Agents?
description: "Learn about Shade Agents - decentralized and trustless AI agents that control accounts and assets across multiple blockchains using TEEs and NEAR's decentralized key management."
---

import { SigsSupport } from '@site/src/components/sigsSupport';
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: plugins
title: Shade Agent Plugins
sidebar_label: Plugins
description: "Learn how to create and use plugins to extend Shade Agents functionality with custom capabilities and integrations."
---

Docs for integrating LLMs and Twitter APIs into your Shade Agent will be coming soon.
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/quickstart/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: components
title: Key Components
sidebar_label: Key Components
description: "Learn about the core components of production Shade Agents, including security considerations, worker agents, agent contracts, and deployment patterns."
---

import {Github} from "@site/src/components/codetabs"
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/quickstart/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: deploying
title: Deploying an Agent
sidebar_label: Deploying an Agent
description: "Learn how to deploy Shade Agents to production environments with full contract customization and flexible architecture for real-world applications."
---

import { SigsSupport } from '@site/src/components/sigsSupport';
Expand Down
1 change: 1 addition & 0 deletions docs/ai/shade-agents/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: security
title: Security Considerations
sidebar_label: Security Considerations
description: This document outlines security considerations for deploying Shade Agents on the NEAR blockchain, including duplicate actions, transaction restrictions, and RPC trust.
---

import { SigsSupport } from '@site/src/components/sigsSupport';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/access-keys.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: access-keys
title: Access Keys
description: "Retrieve information about an account's access keys using the NEAR RPC API, including viewing keys, listing all keys, and tracking access key changes."
---

import ViewAccessKey from '@site/src/components/docs/api/rpc/access-keys/view-access-key/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/block-chunk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: block-chunk
title: Block / Chunk
description: "Query the network and get details about specific blocks or chunks using the NEAR RPC API, including block details, changes in blocks, and chunk information."
---

import BlockDetails from '@site/src/components/docs/api/rpc/block-chunk/block-details/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/contracts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: contracts
title: Accounts / Contracts
description: "View details about accounts and contracts, check contract state and code, and perform contract function calls using NEAR RPC API."
---

import ViewAccount from '@site/src/components/docs/api/rpc/contracts/view-account/index.mdx';
Expand Down
3 changes: 2 additions & 1 deletion docs/api/rpc/gas.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: gas
title: Gas
title: Gas
description: "Query gas prices for specific blocks or hashes using the NEAR RPC API."
---

import GasPrice from '@site/src/components/docs/api/rpc/gas/gas-price/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: introduction
sidebar_label: Home
title: NEAR RPC API
description: "Learn how to interact with the NEAR network using the RPC API, including available providers, node snapshots, and quick links to all RPC endpoints."
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/maintenance-windows.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: maintenance-windows
title: Maintenance Windows
description: "Query future maintenance windows for validators in the current epoch using the NEAR RPC API."
---

import MaintenanceWindows from '@site/src/components/docs/api/rpc/maintenance-windows/maintenance-windows/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/network.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: network
title: Network
description: "Query status information for nodes and validators in the NEAR network, including node status, network info, and validation status."
---

import NodeStatus from '@site/src/components/docs/api/rpc/network/node-status/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/protocol.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: protocol
title: Protocol
description: "Retrieve current genesis and protocol configuration using the NEAR RPC API, including network parameters and protocol versions."
---

import GenesisConfig from '@site/src/components/docs/api/rpc/protocol/genesis-config/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/providers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: providers
title: RPC Providers
description: "Comprehensive list of NEAR RPC providers for mainnet and testnet, including public endpoints, archival nodes, and information about the deprecation of NEAR.org RPC endpoints."
---

There are multiple RPC providers from which you can choose from. These providers will work as intermediaries to help you interact with the NEAR network.
Expand Down
3 changes: 2 additions & 1 deletion docs/api/rpc/setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: setup
title: Setup
title: Setup
description: "Learn how to set up RPC endpoints for NEAR networks, configure authentication, and use tools like Postman, JavaScript, and HTTPie to interact with the API."
---

In order to use the RPC API you will need to setup the correct RPC endpoints.
Expand Down
1 change: 1 addition & 0 deletions docs/api/rpc/transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: transactions
title: RPC Endpoints
sidebar_label: Transactions
description: "Send transactions and query their status using the NEAR RPC API, including transaction status, receipts, and deprecated methods."
---

import SendTx from '@site/src/components/docs/api/rpc/transactions/send-tx/index.mdx';
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/chain-signatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: chain-signatures
title: What are Chain Signatures?
sidebar_label: What are Chain Signatures?
description: "Learn how Chain Signatures enable NEAR accounts to sign and execute transactions across multiple blockchains using Multi-Party Computation for secure cross-chain operations."
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: getting-started
title: Getting Started with Chain Signatures
description: "Learn how to get started with Chain Signatures on NEAR, a groundbreaking technology that enables accounts to sign and execute transactions across multiple blockchains using MPC."
---

Chain Signatures is a groundbreaking technology built on NEAR that enables all accounts, including smart contracts, to sign and execute transactions across multiple blockchains.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: implementation
title: Implementing Chain Signatures
description: "Learn how to implement Chain Signatures to enable NEAR accounts to sign and execute transactions across multiple blockchain protocols using the chainsig.js library."
---

import Tabs from '@theme/Tabs';
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/data-availability.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: data-availability
title: Rollup Data Availability
description: "Learn about NEAR's Data Availability layer for rollups, including blob store contracts, light clients, RPC nodes, and integrations with L2 solutions like Polygon CDK and Optimism."
---

Every monolithic blockchain has a data availability layer. NEAR's Data Availability (DA) represents a pioneering initiative to modularize the data availability layer from the NEAR blockchain to make it available as a roll-up solution for builders on other chains.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/fastauth-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: fastauth-sdk
title: FastAuth SDK
sidebar_label: FastAuth (Email Login)
description: "Learn about FastAuth SDK, a key management system that enables users to recover or sign up for NEAR accounts using their email address."
---

FastAuth is a key management system that allows users to **recover or sign-up for** a NEAR account using their **email address**.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/intents/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: overview
title: NEAR Intents
sidebar_label: NEAR Intents
description: "Learn about NEAR Intents, a multichain transaction protocol where users specify desired outcomes and market makers compete to provide optimal solutions across crypto and traditional services."
---

NEAR Intents is a multichain transaction protocol where users specify what they want and let third parties compete to provide the best solution. This works for everything from token swaps to pizza delivery, creating a universal marketplace across crypto and traditional services.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/meta-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: meta-transactions-relayer
title: Building a Meta Transaction Relayer
sidebar_label: Building a Relayer
description: "Learn how to build a meta transaction relayer that allows users to transact on NEAR without paying gas fees while maintaining transaction security through signed delegates."
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/meta-tx.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: meta-transactions
title: Meta Transactions
description: "Learn about NEP-366 meta transactions on NEAR, allowing users to execute transactions without owning gas tokens by using relayers to cover transaction fees."
---

[NEP-366](https://github.com/near/NEPs/pull/366) introduced the concept of meta transactions to Near Protocol. This feature allows users to execute transactions on NEAR without owning any gas or tokens. In order to enable this, users construct and sign transactions off-chain. A third party (the relayer) is used to cover the fees of submitting and executing the transaction.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/nft-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: nft-chain-keys
title: NFT Chain Keys Smart Contract
sidebar_label: NFT Chain Keys Contract
description: "Learn about NFT Chain Keys, a smart contract that makes remote account ownership provable and transferrable using NEP-171 NFT standards and MPC signatures."
---

The NFT Chain Keys smart contract makes the ownership of remote accounts both provable and transferrable. This new paradigm allows you to create new end-user experiences that leverage provable and transferrable remote accounts as a core primitive.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/omnibridge/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: how-it-works
sidebar_label: How It Works
title: How Omni Bridge Works
description: "Understand how Omni Bridge works using Chain Signatures and MPC services to enable trustless cross-chain transfers without complex light client implementations."
---

The journey toward truly trustless cross-chain communication took a significant leap forward when the NEAR team [created the first trustless bridge with Ethereum](https://near.org/blog/the-rainbow-bridge-is-live) (Rainbow Bridge). This pioneering achievement demonstrated that completely trustless cross-chain communication was possible, marking a crucial step toward the vision of chain abstraction. However, this approach relied on implementing a NEAR light client directly on Ethereum - essentially requiring Ethereum to understand and verify NEAR's complex blockchain rules.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/omnibridge/implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: implementation-details
sidebar_label: Implementation Details
title: Implementation Details
description: "Learn about the technical implementation of Omni Bridge, including bridge token factory patterns, MPC signing, security models, and relayer networks for cross-chain transfers."
---

The Omni Bridge is a sophisticated cross-chain bridge infrastructure that enables secure and efficient token transfers between NEAR Protocol and various other blockchain networks. This document provides a detailed technical overview of the bridge's architecture, covering its core components, security model, and operational mechanisms. By leveraging a combination of Multi-Party Computation (MPC), chain-specific light clients, and a permissionless relayer network, the bridge achieves a robust balance of security, decentralization, and user experience.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/omnibridge/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: overview
sidebar_label: Overview
title: Omni Bridge Overview
description: "Learn about Omni Bridge, a multi-chain asset bridge that enables secure and efficient transfers between blockchain networks using Chain Signatures and MPC technology."
---

The [Omni Bridge](https://github.com/Near-One/omni-bridge) is a multi-chain asset bridge that facilitates secure and efficient asset transfers between different blockchain networks. It solves key challenges in cross-chain communication by leveraging [Chain Signatures](/chain-abstraction/chain-signatures) and its decentralized [Multi-Party Computation (MPC) service](/chain-abstraction/chain-signatures#multi-party-computation-service) to enable trustless cross-chain asset transfers.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/omnibridge/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: roadmap
sidebar_label: Roadmap
title: Omni Bridge Roadmap
description: "Explore the Omni Bridge roadmap, including hybrid architecture launch, Chain Signatures migration path, and future development plans for cross-chain infrastructure."
---

Omni Bridge launches with a hybrid architecture, utilizing different verification methods based on chain-specific requirements and technical constraints. This approach allows us to support multiple chains from day one while progressively transitioning to full Chain Signatures integration.
Expand Down
3 changes: 2 additions & 1 deletion docs/chain-abstraction/wallet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: wallet
title: Wallet Chain Key Rules
title: Wallet Chain Key Rules
description: "Learn about wallet chain key rules for multichain transactions, including key derivation, signature security, and user flow patterns to prevent cross-chain signature attacks."
---

In this article you'll find details on how to parse and present multichain transactions to the user so they can take an informed decision about their wallet's assets, while minimizing the number of times the user has to consent.
Expand Down
1 change: 1 addition & 0 deletions docs/chain-abstraction/what-is.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: what-is
title: What is Chain Abstraction?
description: "Learn about chain abstraction and how NEAR's framework makes blockchain technology invisible to users while preserving benefits through NEAR Intents, Chain Signatures, and OmniBridge."
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
1 change: 1 addition & 0 deletions docs/data-infrastructure/big-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: big-query
title: BigQuery Public Dataset
sidebar_label: BigQuery
description: "Learn how to use NEAR Protocol's BigQuery public dataset for blockchain data analysis, including querying on-chain data, understanding costs, and accessing historical transaction data."
---

This document provides an overview of the BigQuery public dataset that allows users to query historical on-chain data from the NEAR Protocol. It includes setup instructions, example queries, and information about the available data structures.
Expand Down
1 change: 1 addition & 0 deletions docs/data-infrastructure/data-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: data-apis
title: Data APIs
description: "Explore community-built APIs for accessing NEAR Protocol on-chain data, including NearBlocks, FastNear, The Graph, PIKESPEAK, and other indexing solutions."
---

Members of the NEAR community have built a set of APIs to access and monitor on-chain data. These APIs are designed to be easy to use and can be accessed from any application through a simple API call.
Expand Down
3 changes: 2 additions & 1 deletion docs/data-infrastructure/indexers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_label: "Intro to Indexers"
sidebar_label: Intro to Indexers
description: "Learn about blockchain indexers, how they work with NEAR Protocol, the difference between pull and push models, and when to use indexers for data querying."
---

Here you will find everything you need to know in order to familiarize yourself with the concept of indexers and even build your own one.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: js-lake-indexer
title: JS basic tutorial
sidebar_label: JS basic tutorial
description: "This tutorial will guide you through creating a simple indexer using the JavaScript version of the NEAR Lake Framework. The indexer will print block height and number of shards to the console."
---
This tutorial will guide you through creating a simple indexer using the JavaScript version of the NEAR Lake Framework. The indexer will print block height and number of shards to the console.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_label: NFT Indexer
description: "This tutorial will guide you through building a simple NFT indexer using the JavaScript version of the NEAR Lake Framework JS. The indexer will listen for nft_mint events and print relevant data about newly minted NFTs."
---

This tutorial will guide you through building a simple NFT indexer using the JavaScript version of the [NEAR Lake Framework JS](/data-infrastructure/lake-framework/near-lake-framework). The indexer will listen for `nft_mint` events and print relevant data about newly minted NFTs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: primitives
title: NEAR Lake Primitive Types
sidebar_label: Lake Primitive Types
description: "This article contains the primitive types used by the NEAR Lake Framework package. These types are used to define the data structures used by the framework as well as provide some popular helper functions."
---

This article contains the primitive types used by the [NEAR Lake Framework package](https://www.npmjs.com/package/@near-lake/framework). These types are used to define the data structures used by the framework as well as provide some popular helper functions.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_label: "Python tutorial"
sidebar_label: Python tutorial
description: "This tutorial will guide you through creating a simple indexer using the Python version of the NEAR Lake Framework. The indexer will print block height and number of shards to the console."
---

This tutorial will guide you through creating a simple indexer using the Python version of the NEAR Lake Framework. The indexer will print block height and number of shards to the console.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_label: "NFT indexer for Python"
sidebar_label: NFT indexer for Python
description: "This tutorial shows how to build a fully functional NFT indexer built using the NEAR Lake Framework for Python, which monitors nft_mint events and outputs relevant details such as the receipt_id of the receipt where the mint occurred, the marketplace, the NFT owner's account name, and links to the NFTs on the marketplaces."
---

This tutorial shows how to build a fully functional NFT indexer built using the [NEAR Lake Framework for Python](/data-infrastructure/lake-framework/near-lake-framework/), which monitors `nft_mint` [events](https://nomicon.io/Standards/EventsFormat) and outputs relevant details such as the `receipt_id` of the [receipt](/data-infrastructure/lake-data-structures/receipt) where the mint occurred, the marketplace, the NFT owner's account name, and links to the NFTs on the marketplaces.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Migrating to NEAR Lake framework
id: migrating-to-near-lake-framework
description: "We encourage everyone who don't have a hard requirement to use NEAR Indexer Framework consider the migration to NEAR Lake Framework."
---

We encourage everyone who don't have a hard requirement to use [NEAR Indexer Framework](https://github.com/near/nearcore/tree/master/chain/indexer) consider the migration to [NEAR Lake Framework](/data-infrastructure/lake-framework/near-lake-framework).
Expand Down
Loading
Loading