README.md

near-social-js

Typescript SDK for interacting with the social contract (social.near)

Table of Contents

• Getting Started
  • Installing dependencies
  • Building for production
  • Running tests
• Contributing

About

This SDK provides a TypeScript interface for interacting with NEAR Social, a decentralized social network built on NEAR Protocol. It simplifies reading and writing data to the social.near contract.

Related Projects

• near.social - The live social network
• NearSocial/viewer - The original NEAR Social frontend
• NearSocial/social-db - The social.near smart contract

Getting Started

Installing dependencies

bun install

Building for production

bun run build

Running tests

bun run test

Appendix

Social Contract

Network	Account ID	Link
Mainnet	social.near	https://nearblocks.io/address/social.near
Testnet	v1.social08.testnet	https://testnet.nearblocks.io/address/v1.social08.testnet

Useful Commands

Command	Description
bun run build	Builds the source code into the dist/ directory.
bun run docs:build	Builds the documentation into the .docs/ directory.
bun run docs:serve	Serves the built documentation from the .docs/ directory.
bun run docs:start	Builds and runs the documentation in a development environment with hot reloading.
bun run lint	Runs the linter on .js and .ts files.
bun run fmt	Runs prettier on .js and .ts files.
bun run test	Runs the tests using Vitest and near-kit Sandbox.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you're interested in contributing to this project, please read the contribution guide.