Skip to content
by Unity Nodes
LEARN · DOCUMENTATION

Documentation

Pages from 3 sources, kept in sync: the official NEAR documentation, documentation from teams building on NEAR, and readmes from their code. Search all of it, or start from a path below.

514pages
synced 4h ago3 sources
This week514pages updated upstreamNewestNEAR AI Cloud: Accept an organization invitationNov 4, 2026Official245pages from the official docs

Recently updated

245 pages
ShowingOfficial
OfficialNomicon · DataStructures › Account
Accounts
Accounts Account ID NEAR Protocol has an account names system. Account ID is similar to a username. Account IDs have to follow the rules. Account ID Rules • minimum length is 2 • maximum length is 64
Nov 4, 2026
OfficialNomicon · GenesisConfig › RuntimeFeeConfig
ActionCreationConfig
actioncreationconfig Describes the cost of creating a specific action, Action. It covers the actions up to delegatecost. The fees of newer actions, such as global contract, state init and gas key acti
Nov 4, 2026
OfficialNomicon · RuntimeSpec
Actions
Actions There are a several action types in Near: ![allow(unused)] fn main() { pub enum Action { CreateAccount(CreateAccountAction), DeployContract(DeployContractAction), FunctionCall(FunctionCallActi
Nov 4, 2026
OfficialNomicon · RuntimeSpec › Scenarios
Cross-ContractCall
Cross-Contract Call This guide assumes that you have read the Financial Transaction section. Suppose Alice is a calling a function reservetrip(city: String, date: u64) on a smart contract deployed to
Nov 4, 2026
OfficialNomicon · RuntimeSpec › Scenarios
Financial Transaction
Financial Transaction Suppose Alice wants to transfer 100 tokens to Bob. In this case we are talking about native Near Protocol tokens, oppose to user-defined tokens implemented through a smart contra
Nov 4, 2026
OfficialNomicon · GenesisConfig › RuntimeFeeConfig
Fraction
Fraction A rational number. In code it is a Rational32. In the genesis config and in RPC responses it is a JSON array of two signed 32-bit integers, [numerator, denominator]. For example, [3, 10] mean
Nov 4, 2026
OfficialNomicon · ChainSpec
Light Client
Light Client Note: This page is out of date and may contain errors. Do not use it as the only reference when you build a light client. Have any light client implementation reviewed independently befor
Nov 4, 2026
OfficialNomicon · NetworkSpec
Messages
Messages All messages sent in the network are of type PeerMessage. A PeerMessage is encoded with Protocol Buffers , using the schema in network.proto . Some fields of that schema are bytes fields that
Nov 4, 2026
OfficialNomicon · RuntimeSpec
Receipts
Receipt All cross-contract (we assume that each account lives in its own shard) communication in Near happens through Receipts. Receipts are stateful in a sense that they serve not only as messages be
Nov 4, 2026
OfficialNomicon · RuntimeSpec
Refunds
Refunds When execution of a receipt fails or there is some unused amount of prepaid gas left after a function call, the Runtime generates refund receipts. The are 2 types of refunds: • Refunds for the
Nov 4, 2026
OfficialNomicon · RuntimeSpec › Components
Runtime Crate
Runtime crate Runtime crate encapsulates the logic of how transactions and receipts should be handled. If it encounters a smart contract call within a transaction or a receipt it calls near-vm-runner,
Nov 4, 2026
OfficialNomicon · GenesisConfig
RuntimeConfig
RuntimeConfig The structure that holds the parameters of the runtime, mostly economics. It is not part of genesis. Each nearcore release contains the runtime config for every protocol version (core/pa
Nov 4, 2026
OfficialNomicon · GenesisConfig
RuntimeFeeConfig
RuntimeFeesConfig Economic parameters for runtime actionreceiptcreationconfig type: Fee Describes the cost of creating an action receipt, ActionReceipt, excluding the actual cost of actions. datarecei
Nov 4, 2026
OfficialNomicon · ChainSpec › SelectingBlockProducers
Selecting Chunk and Block Producers
Selecting Chunk and Block Producers Background Note: this section describes the Simple Nightshade design as of March 2021. Since stateless validation (protocol version 69), block producers no longer t
Nov 4, 2026
OfficialNomicon · GenesisConfig › RuntimeFeeConfig
StorageUsageConfig
StorageUsageConfig Describes how the storage that an account uses is counted for storage staking. numbytesaccount type: u64 Number of bytes counted for the account record, including rounding up for th
Nov 4, 2026
OfficialNomicon · GenesisConfig
VMConfig
VMConfig Config of wasm operations. The fields from maxgasburnt to maxtotalloglength belong to the limit config. In the JSON view they are nested under the limitconfig key of wasmconfig. extcosts type
Nov 4, 2026
Officialdocs.near.org · api reference
Post block
POST /block Returns block details for given height or hash Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be any string. - jsonrpc (string): JSON-RPC protocol
Nov 4, 2026
Officialdocs.near.org · api reference
Post block effects
POST /blockeffects Returns changes in block for given block height or hash over all transactions for all the types. Includes changes like accounttouched, accesskeytouched, datatouched, contractcodetou
Nov 4, 2026
Officialdocs.near.org · api reference
Post broadcast tx async
POST /broadcasttxasync [Deprecated] Sends a transaction and immediately returns transaction hash. Consider using sendtx instead. Request body (application/json): - id (string): JSON-RPC request id. Au
Nov 4, 2026
Officialdocs.near.org · api reference
Post broadcast tx commit
POST /broadcasttxcommit [Deprecated] Sends a transaction and waits until transaction is fully complete. (Has a 10 second timeout). Consider using sendtx instead. Request body (application/json): - id
Nov 4, 2026
Officialdocs.near.org · api reference
Post changes
POST /changes Returns changes for a given account, contract or contract code for given block height or hash. Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be
Nov 4, 2026
Officialdocs.near.org · api reference
Post chunk
POST /chunk Returns details of a specific chunk. You can run a block details query to get a valid chunk hash. Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can b
Nov 4, 2026
Officialdocs.near.org · api reference
Post client config
POST /clientconfig Queries client node configuration Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be any string. - jsonrpc (string): JSON-RPC protocol versi
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental call function
POST /EXPERIMENTALcallfunction Calls a view function on a contract and returns the result. Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be any string. - jso
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental changes
POST /EXPERIMENTALchanges [Deprecated] Returns changes for a given account, contract or contract code for given block height or hash. Consider using changes instead. Request body (application/json): -
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental changes in block
POST /EXPERIMENTALchangesinblock [Deprecated] Returns changes in block for given block height or hash over all transactions for all the types. Includes changes like accounttouched, accesskeytouched, d
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental congestion level
POST /EXPERIMENTALcongestionlevel Queries the congestion level of a shard. More info about congestion here Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be a
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental genesis config
POST /EXPERIMENTALgenesisconfig [Deprecated] Get initial state and parameters for the genesis block. Consider genesisconfig instead. Request body (application/json): - id (string): JSON-RPC request id
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental light client block proof
POST /EXPERIMENTALlightclientblockproof Returns the proofs for a transaction execution. Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be any string. - jsonrp
Nov 4, 2026
Officialdocs.near.org · api reference
Post experimental light client proof
POST /EXPERIMENTALlightclientproof Returns the proofs for a transaction execution. Request body (application/json): - id (string): JSON-RPC request id. Auto-populated; can be any string. - jsonrpc (st
Nov 4, 2026
Showing 1 to 30 of 245Search all sources →