NearApi Build StatusHex pmhex.pm downloads

Elixir library for DApps development on the NEAR blockchain platform

Currently in active development, so not recommended to use in production

Installation

If available in Hex, the package can be installed by adding near_api to your list of dependencies in mix.exs:

def deps do
[
{:near_api, "~> 0.1.1"}
]
end

Usage

We used Livebook for API documentation. To see NEAR API in action please clone this repository and run Livebook locally from your project folder with corresponding .livemd file loaded.

Access Keys

Retrieve information about an account's access keys.

Docs: NEAR API Docs: Access Keys

Livebook

Accounts / Contracts (Backlog)

View details about accounts and contracts as well as perform contract calls.

Docs: NEAR API Docs: Accounts / Contracts

Block / Chunk (Backlog)

Query the network and get details about specific blocks or chunks.

Docs: NEAR API Docs: Block / Chunk

Gas (Backlog)

Get gas price for a specific block or hash.

Docs: NEAR API Docs: Gas

Protocol (Backlog)

Retrieve current genesis and protocol configuration.

Docs: NEAR API Docs: Protocol

Network (Backlog)

Return status information for nodes and validators.

Docs: NEAR API Docs: Network

Transactions (Backlog)

Send transactions and query their status.

Docs: NEAR API Docs: Transactions

Sandbox (Backlog)

Patch state on a local sandbox node.

Docs: NEAR API Docs: Sandbox

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/alexfilatov/near_api.

  1. Fork
  2. Create Pull request

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/near_api.