NEAR JavaScript SDK

A JavaScript library for writing NEAR smart contracts.

import { NearBindgen, near, call, view } from 'near-sdk-js';

@NearBindgen({})
class HelloNear {
  greeting: string = 'Hello';

  @view({}) // This method is read-only and can be called for free
  get_greeting(): string {
    return this.greeting;
  }

  @call({}) // This method changes the state, for which it cost gas
  set_greeting({ greeting }: { greeting: string }): void {
    near.log(`Saving greeting ${greeting}`);
    this.greeting = greeting;
  }
}

See more in the Anatomy of a Contract.

Documentation

Learn how to use
Learn by example with AgorApp
Learn by example with NEAR Docs
Check our detailed examples and tutorials
Find source code examples with common use cases
Lookup available features in API reference
🏠 Learn more about NEAR on our Documentation website
Breaking features diff from SDK 2.0.0 to 1.0.0

Prerequisites

node >=14 <16.6.0 || >16.6.0
pnpm >=7

Quick Start

Use create-near-app to quickly get started writing smart contracts in JavaScript on NEAR.

npx create-near-app

This will scaffold a basic template for you 😎

Contributing

If you are interested in contributing, please look at the contributing guidelines.

License