diff --git a/docs/ai/shade-agents/examples.md b/docs/ai/shade-agents/examples.md index c2fc63d5910..3859c8d2e83 100644 --- a/docs/ai/shade-agents/examples.md +++ b/docs/ai/shade-agents/examples.md @@ -4,8 +4,6 @@ title: What can you Build? sidebar_label: What can you Build? --- -# What can you build with Shade Agents? - 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. ## Shade Agent Features diff --git a/docs/ai/shade-agents/production/deploying.md b/docs/ai/shade-agents/production/deploying.md index 81c76b54a91..3ad04cbef7e 100644 --- a/docs/ai/shade-agents/production/deploying.md +++ b/docs/ai/shade-agents/production/deploying.md @@ -6,8 +6,6 @@ sidebar_label: Deploying an Agent import { SigsSupport } from '@site/src/components/sigsSupport'; -# Deploying an Agent - In this section we'll walk through deploying your first Shade Agent. The template we're using is a simple Shade Agent built with NextJS that acts as a verifiable ETH price oracle. It takes prices from two different APIs, takes the average and then pushes the price to an Ethereum contract. We'll cover two deployment scenarios: diff --git a/docs/chain-abstraction/omnibridge/how-it-works.md b/docs/chain-abstraction/omnibridge/how-it-works.md index 44e3b8db824..011fff18890 100644 --- a/docs/chain-abstraction/omnibridge/how-it-works.md +++ b/docs/chain-abstraction/omnibridge/how-it-works.md @@ -4,8 +4,6 @@ sidebar_label: How It Works title: How Omni Bridge Works --- -## Background - 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. Omni Bridge introduces a more elegant solution using Chain Signatures. Instead of running light clients on each destination chain, it leverages Chain Signature's MPC Service to enable secure cross-chain message verification without the overhead of light client verification. This new approach reduces verification times from hours to minutes while significantly reducing gas costs across all supported chains. diff --git a/docs/chain-abstraction/wallet.md b/docs/chain-abstraction/wallet.md index 69d18126621..97e7cadc290 100644 --- a/docs/chain-abstraction/wallet.md +++ b/docs/chain-abstraction/wallet.md @@ -3,8 +3,6 @@ id: wallet title: Wallet Chain Key Rules --- -## Overview - 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. You'll also learn how to ensure that a signature on one chain is not used to take a meaningful action on another chain. diff --git a/docs/chain-abstraction/what-is.md b/docs/chain-abstraction/what-is.md index 469702e037b..a30ed2d8145 100644 --- a/docs/chain-abstraction/what-is.md +++ b/docs/chain-abstraction/what-is.md @@ -6,8 +6,6 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import {CodeTabs, Language, Github} from "@site/src/components/codetabs"; -# What is Chain Abstraction? - Blockchain development today faces a critical challenge: users need to understand complex blockchain concepts, manage multiple wallets, and deal with different networks just to use basic applications. Chain abstraction solves this by making blockchain technology invisible to end users while preserving all of the underlying benefits. ![img](/docs/assets/welcome-pages/2.chain-abstraction.png) diff --git a/docs/data-infrastructure/indexers.md b/docs/data-infrastructure/indexers.md index 0745888001c..b74fe2d8e19 100644 --- a/docs/data-infrastructure/indexers.md +++ b/docs/data-infrastructure/indexers.md @@ -2,8 +2,6 @@ sidebar_label: "Intro to Indexers" --- -# Introduction to Indexers - 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. :::info Disclaimer diff --git a/docs/data-infrastructure/lake-framework/building-indexers/js-lake-indexer.md b/docs/data-infrastructure/lake-framework/building-indexers/js-lake-indexer.md index 1b0f9600c36..8bcb10683fe 100644 --- a/docs/data-infrastructure/lake-framework/building-indexers/js-lake-indexer.md +++ b/docs/data-infrastructure/lake-framework/building-indexers/js-lake-indexer.md @@ -4,8 +4,9 @@ title: JS basic tutorial sidebar_label: JS basic tutorial --- -# NEAR Lake indexer basic tutorial +Recently we have [published a JavaScript version of the NEAR Lake Framework](https://www.npmjs.com/package/near-lake-framework) on npmjs.org +We want to empower you with a basic tutorial on how to use the JavaScript Library. Let's get started! :::info Source code for the tutorial @@ -13,10 +14,6 @@ sidebar_label: JS basic tutorial ::: -Recently we have [published a JavaScript version of the NEAR Lake Framework](https://www.npmjs.com/package/near-lake-framework) on npmjs.org - -We want to empower you with a basic tutorial on how to use the JavaScript Library. Let's get started! - ## Requirements diff --git a/docs/data-infrastructure/lake-framework/building-indexers/nft-indexer.md b/docs/data-infrastructure/lake-framework/building-indexers/nft-indexer.md index 8d0cc796353..c732d4f6bb6 100644 --- a/docs/data-infrastructure/lake-framework/building-indexers/nft-indexer.md +++ b/docs/data-infrastructure/lake-framework/building-indexers/nft-indexer.md @@ -2,8 +2,13 @@ sidebar_label: NFT Indexer --- -# Building an NFT indexer +This tutorial ends with a working NFT indexer built on top [NEAR Lake Framework JS](/data-infrastructure/lake-framework/near-lake-framework). The indexer is watching for `nft_mint` [Events](https://nomicon.io/Standards/EventsFormat) and prints some relevant data: +- `receiptId` of the [Receipt](/data-infrastructure/lake-data-structures/receipt) where the mint has happened +- Marketplace +- NFT owner account name +- Links to the NFTs on the marketplaces +The final source code is available on the GitHub [`near-examples/near-lake-nft-indexer`](https://github.com/near-examples/near-lake-nft-indexer) :::note Source code for the tutorial @@ -11,15 +16,6 @@ sidebar_label: NFT Indexer ::: -## The End - -This tutorial ends with a working NFT indexer built on top [NEAR Lake Framework JS](/data-infrastructure/lake-framework/near-lake-framework). The indexer is watching for `nft_mint` [Events](https://nomicon.io/Standards/EventsFormat) and prints some relevant data: -- `receiptId` of the [Receipt](/data-infrastructure/lake-data-structures/receipt) where the mint has happened -- Marketplace -- NFT owner account name -- Links to the NFTs on the marketplaces - -The final source code is available on the GitHub [`near-examples/near-lake-nft-indexer`](https://github.com/near-examples/near-lake-nft-indexer) ## Motivation diff --git a/docs/data-infrastructure/lake-framework/building-indexers/primitives.md b/docs/data-infrastructure/lake-framework/building-indexers/primitives.md index 415d0f60367..1c3952f0b0f 100644 --- a/docs/data-infrastructure/lake-framework/building-indexers/primitives.md +++ b/docs/data-infrastructure/lake-framework/building-indexers/primitives.md @@ -4,8 +4,6 @@ title: NEAR Lake Primitive Types sidebar_label: Lake Primitive Types --- -# NEAR Lake Primitive Types - 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. ## `Block` diff --git a/docs/data-infrastructure/lake-framework/building-indexers/python-nft-indexer.md b/docs/data-infrastructure/lake-framework/building-indexers/python-nft-indexer.md index 02096227669..a5d35633465 100644 --- a/docs/data-infrastructure/lake-framework/building-indexers/python-nft-indexer.md +++ b/docs/data-infrastructure/lake-framework/building-indexers/python-nft-indexer.md @@ -2,17 +2,6 @@ sidebar_label: "NFT indexer for Python" --- -# Building an NFT indexer for Python - - -:::note Source code for the tutorial - -[`frolvanya/near-lake-nft-indexer`](https://github.com/frolvanya/near-lake-nft-indexer): source code for this tutorial - -::: - -## The Goal - This tutorial ends with a working NFT indexer built on top [NEAR Lake Framework for Python](/data-infrastructure/lake-framework/near-lake-framework/). The indexer is watching for `nft_mint` [Events](https://nomicon.io/Standards/EventsFormat) and prints some relevant data: - `receipt_id` of the [Receipt](/data-infrastructure/lake-data-structures/receipt) where the mint has happened - Marketplace @@ -21,6 +10,12 @@ This tutorial ends with a working NFT indexer built on top [NEAR Lake Framework The final source code is available on the GitHub [`frolvanya/near-lake-nft-indexer`](https://github.com/frolvanya/near-lake-nft-indexer) +:::note Source code for the tutorial + +[`frolvanya/near-lake-nft-indexer`](https://github.com/frolvanya/near-lake-nft-indexer): source code for this tutorial + +::: + ## Motivation NEAR Protocol had introduced a nice feature [Events](https://nomicon.io/Standards/EventsFormat). The Events allow a contract developer to add standardized logs to the [`ExecutionOutcomes`](/data-infrastructure/lake-data-structures/execution-outcome) thus allowing themselves or other developers to read those logs in more convenient manner via API or indexers. diff --git a/docs/data-infrastructure/lake-framework/migrating-to-near-lake-framework.md b/docs/data-infrastructure/lake-framework/migrating-to-near-lake-framework.md index 5a46d743b6b..1758074854f 100644 --- a/docs/data-infrastructure/lake-framework/migrating-to-near-lake-framework.md +++ b/docs/data-infrastructure/lake-framework/migrating-to-near-lake-framework.md @@ -3,9 +3,6 @@ sidebar_label: Migrating to NEAR Lake framework id: migrating-to-near-lake-framework --- -# Migrating 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). In this tutorial we'll show you how to migrate the project using [indexer-tx-watcher-example](https://github.com/near-examples/indexer-tx-watcher-example) as a showcase. diff --git a/docs/data-infrastructure/lake-framework/running-near-lake/credentials.md b/docs/data-infrastructure/lake-framework/running-near-lake/credentials.md index c0ed5bdc4d1..9088b900941 100644 --- a/docs/data-infrastructure/lake-framework/running-near-lake/credentials.md +++ b/docs/data-infrastructure/lake-framework/running-near-lake/credentials.md @@ -3,8 +3,6 @@ sidebar_label: "Credentials" id: credentials --- -# Credentials - To access the data provided by [NEAR Lake](../near-lake.md) you need to provide valid AWS credentials in order to be charged by the AWS for the S3 usage. :::info AWS credentials diff --git a/docs/data-infrastructure/lake-framework/running-near-lake/lake-start-options.md b/docs/data-infrastructure/lake-framework/running-near-lake/lake-start-options.md index d2407b44114..2140d073bd4 100644 --- a/docs/data-infrastructure/lake-framework/running-near-lake/lake-start-options.md +++ b/docs/data-infrastructure/lake-framework/running-near-lake/lake-start-options.md @@ -3,11 +3,6 @@ sidebar_label: "Start options" id: lake-start-options --- -# Extending Lake indexer with start options - - -## The End - This tutorial ends with the example code of the simple indexer built on top of [NEAR Lake Framework](/data-infrastructure/lake-framework/near-lake-framework) that can start: - from specified block height (out of the box) ```bash diff --git a/docs/data-infrastructure/lake-framework/running-near-lake/run-near-lake.md b/docs/data-infrastructure/lake-framework/running-near-lake/run-near-lake.md index 09cb8f70a7f..288ba750477 100644 --- a/docs/data-infrastructure/lake-framework/running-near-lake/run-near-lake.md +++ b/docs/data-infrastructure/lake-framework/running-near-lake/run-near-lake.md @@ -3,7 +3,11 @@ id: run-lake-indexer sidebar_label: Running Lake Indexer --- -# Running NEAR Lake Indexer +The Lake Indexer setup consists of the following components: + +- AWS S3 Bucket as a storage +- NEAR Lake binary that operates as a regular NEAR Protocol peer-to-peer node, so you will operate it as + any other [Regular/RPC Node in NEAR](https://near-nodes.io/rpc/hardware-rpc) :::info @@ -12,14 +16,6 @@ to watch the network and store all the events as JSON files on AWS S3. ::: -## How to start - -The Lake Indexer setup consists of the following components: - -- AWS S3 Bucket as a storage -- NEAR Lake binary that operates as a regular NEAR Protocol peer-to-peer node, so you will operate it as - any other [Regular/RPC Node in NEAR](https://near-nodes.io/rpc/hardware-rpc) - ### Prepare Development Environment Before you proceed, make sure you have the following software installed: diff --git a/docs/integrations/accounts.md b/docs/integrations/accounts.md index 51aebaf860a..30448fc7a42 100644 --- a/docs/integrations/accounts.md +++ b/docs/integrations/accounts.md @@ -7,8 +7,6 @@ sidebar_label: Accounts import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Introduction {#introduction} - Please see the [documentation for accounts](/protocol/account-model) for basic information. - For exchanges, NEAR supports [implicit account](https://nomicon.io/DataStructures/Account.html#implicit-account-ids) creation which allows the creation of accounts without paying for transactions. diff --git a/docs/integrations/balance.md b/docs/integrations/balance.md index ba3fe101bef..fcc9055c138 100644 --- a/docs/integrations/balance.md +++ b/docs/integrations/balance.md @@ -7,8 +7,6 @@ sidebar_label: Balance Changes import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Prerequisites {#prerequisites} - - [NEAR Account](https://testnet.mynearwallet.com/create) - [NEAR-CLI](/tools/near-cli) - Credentials for sender account stored locally by running [`near login`](/tools/near-cli#import) diff --git a/docs/integrations/errors/token-loss.md b/docs/integrations/errors/token-loss.md index 3c05058b640..62cd3da73d7 100644 --- a/docs/integrations/errors/token-loss.md +++ b/docs/integrations/errors/token-loss.md @@ -4,17 +4,17 @@ title: Avoiding Token Loss sidebar_label: Avoiding Token Loss --- -:::warning -Careful! Losing tokens means losing money! -::: - - Token loss is possible under multiple scenarios. These scenarios can be grouped into a few related classes: 1. Improper key management 2. Refunding deleted accounts 3. Failed function calls in batches +:::warning +Careful! Losing tokens means losing money! +::: + + --- ## Improper key management diff --git a/docs/protocol/access-keys.md b/docs/protocol/access-keys.md index e2e6f03b395..038495b5364 100644 --- a/docs/protocol/access-keys.md +++ b/docs/protocol/access-keys.md @@ -3,6 +3,12 @@ id: access-keys title: Access Keys --- +In NEAR, users control their accounts using access keys, which can be full-access keys or function-call keys. Full-access keys allow complete control over the account, while function-call keys restrict actions to specific contracts. This system enables secure sharing of permissions and simplifies user interactions with applications. + +--- + +## Access Keys + In most blockchains, users control their accounts by holding a single [`private key`](https://en.wikipedia.org/wiki/Public-key_cryptography) (a secret only they know) and using it to sign [transactions](./transactions.md). ![img](@site/static/docs/assets/welcome-pages/access-keys.png) diff --git a/docs/protocol/account-id.md b/docs/protocol/account-id.md index c1efed30b7d..eb3988f9c53 100644 --- a/docs/protocol/account-id.md +++ b/docs/protocol/account-id.md @@ -6,6 +6,12 @@ title: Address (Account ID) import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +NEAR accounts are identified by a unique address, which can be either an implicit address (64 characters long) or a named address (like a domain). Implicit addresses are automatically created and controlled by private keys, while named addresses are user-friendly and can create sub-accounts. Named accounts have no control over their sub-accounts, which are treated as separate entities. + +--- + +## Types of Account IDs + NEAR accounts are identified by a unique address, which takes one of two forms: 1. [**Implicit address**](#implicit-address), which are 64 characters long (e.g. `fb9243ce...`) 2. [**Named address**](#named-address), which act as domains (e.g. `alice.near`) diff --git a/docs/protocol/data-flow/near-data-flow.md b/docs/protocol/data-flow/near-data-flow.md index f2c7b162388..a73234f79d1 100644 --- a/docs/protocol/data-flow/near-data-flow.md +++ b/docs/protocol/data-flow/near-data-flow.md @@ -1,9 +1,9 @@ --- +title: NEAR Data Flow sidebar_label: "NEAR Data Flow" --- -# NEAR Data Flow - +NEAR Protocol blockchain data flow might be a bit tricky at a glance. But it is pretty straightforward and follows well-defined rules. In this article, we are going to have a closer look at how the data flows in NEAR Protocol blockchain.