near-syn

near-syn is a library and command line utilities to make contract development for the NEAR platform easier.

The near-syn package contains two command line utilities:

• near-ts generates TypeScript bindings from Rust source files.
• near-md generates Markdown documentation from Rust source files.

Installation

To install the near-syn command line utilities use

cargo install near-syn

Or alternatively you can install it directly from GitHub

cargo install --git https://github.com/acuarica/near-syn --branch main

Usage

The near-ts utility takes a group of Rust source files, and outputs the generated TypeScript bindings.

near-ts path/to/src/lib.rs > src/contract.ts

Similarly, the near-md utility takes a group of Rust source files, and outputs the generated Markdown documentation.

near-md path/to/src/lib.rs > path/to/README.md