Near SDK GO

Near SDK GO is a library designed for smart contract development on the Near Blockchain. This SDK provides all the necessary tools for creating, deploying, and testing smart contracts written in Go for the Near Blockchain.

🚨 IMPORTANT PREREQUISITES 🚨

For an optimal development experience, use Go version 1.23.7 and Tinygo version 0.36.0.

For more information about the compatibility between Go and Tinygo, please refer to the following:

• Go Compatibility Matrix
• Go language features Support

Please note that smart contracts run in an isolated environment without access to sockets, files, or other APIs. Therefore, you must test them separately in the Near Blockchain environment before deploying them to production.

---

Quick Start

1.Create project

go mod init github.com/vlmoon99/near-sdk-go/examples/quick_intro

2.Add dependencies

go get github.com/vlmoon99/[email protected]

3.Add code

touch main.go && echo 'package main
       
import (
    "github.com/vlmoon99/near-sdk-go/env"
)

//go:export InitContract
func InitContract() {
    env.LogString("Init Smart Contract")
}' > main.go

4.Build code

tinygo build -size short -no-debug -panic=trap -scheduler=none -gc=leaking -o main.wasm -target wasm-unknown ./ && ls -lh main.wasm

IMPORTANT - If your build will produce some errors like this one -

unsupported parameter type "xyz" 

You will need to build it again, this problem solved in CLI which u can use instead of raw tinygo builds

---

Documentation

For detailed documentation, refer to the doc folder. It contains all the essential information required for building smart contracts using Go.

If you're a beginner, it's highly recommended to start with the tutorials in doc/beginners/, which take you through three step-by-step lessons. These lessons cover:
1. Core concepts of the Blockchain technology and Near Blockchain.
2. Smart contract basics.
3. Client(Frontend) WEB 3 basics.

Once you've mastered these foundational concepts, proceed to Full-Stack App Tutorial. This tutorial guides you through developing and deploying a full-stack application, demonstrating end-to-end development on the Near Blockchain.

---