Skip to content

Fix llms descriptions #2632

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 0 additions & 2 deletions docs/ai/shade-agents/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/ai/shade-agents/production/deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions docs/chain-abstraction/omnibridge/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/chain-abstraction/wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 0 additions & 2 deletions docs/chain-abstraction/what-is.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions docs/data-infrastructure/indexers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ 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

[`near-examples/near-lake-raw-printer-js`](https://github.com/near-examples/near-lake-raw-printer-js): source code for the tutorial on how to create an indexer that prints block height and number of shards

:::

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,20 @@
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

[`near-examples/near-lake-nft-indexer`](https://github.com/near-examples/near-lake-nft-indexer): source code for this tutorial

:::

## 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:
Expand Down
2 changes: 0 additions & 2 deletions docs/integrations/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions docs/integrations/balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
10 changes: 5 additions & 5 deletions docs/integrations/errors/token-loss.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions docs/protocol/access-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/protocol/account-id.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
Expand Down
6 changes: 2 additions & 4 deletions docs/protocol/data-flow/near-data-flow.md
Original file line number Diff line number Diff line change
@@ -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.

<iframe
width="100%"
Expand All @@ -22,8 +22,6 @@ In this video we give a quick overview on the main concept of how the data flows

:::

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.

In fact, any blockchain flow can be represented as an infinite timeline that has a start but has no end.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ import teachingDeployment from '/docs/assets/crosswords/teaching--jeheycell.near
import createAccount from '/docs/assets/crosswords/creating account with text--seanpineda.near--_seanpineda.png';
import chalkboardErase from '/docs/assets/crosswords/erasing-subaccount-chalkboard--iambon.near--JohnreyBona.mp4';

# Modifying the contract

This section will modify the smart contract skeleton from the previous section. This tutorial will start by writing a contract in a somewhat useless way in order to learn the basics. Once we've got a solid understanding, we'll iterate until we have a crossword puzzle.

## Add a const, a field, and functions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import TabItem from '@theme/TabItem';

import batchCookieTray from '/docs/assets/crosswords/batch-of-actions--dobulyo.near--w_artsu.jpg';

# Hash the solution, add basic unit tests

In the previous section, we stored the crossword solution as plain text as a `String` type on the smart contract. If we're trying to hide the solution from the users, this isn't a great approach as it'll be public to anyone looking at the state. Let's instead hash our crossword solution and store that instead. There are different ways to hash data, but let's use `sha256` which is one of the hashing algorithms available in [the Rust SDK](https://docs.rs/near-sdk/latest/near_sdk/env/fn.sha256.html).

:::info Remind me about hashing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ import TabItem from '@theme/TabItem';
import loggingIn from '/docs/assets/crosswords/logging-in.png';
import explorerTransfer from '/docs/assets/crosswords/chapter-2-explorer-transfer.jpg';

# Add the login functionality

## Plan

We're going to add a login button that uses `near-api-js` to login with NEAR.

Below is the workflow of logging in:
Expand Down
2 changes: 0 additions & 2 deletions docs/web3-apps/ethereum-wallets.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ id: ethereum-wallets

import { Github } from "@site/src/components/codetabs"

# How to integrate Ethereum Wallets to Near DApps?

In this article we will describe how to add EVM wallets support to your Near app, which is already uses the [Near Wallet Selector](https://github.com/near/wallet-selector/).

To integrate Metamask and other EVM wallets you will need to:
Expand Down
Loading