https://github.com/near/near-sdk-js
Tools for building NEAR smart contracts in JavaScript
https://github.com/near/near-sdk-js
near near-protocol sdk smart-contract-tools
Last synced: 4 days ago
JSON representation
Tools for building NEAR smart contracts in JavaScript
- Host: GitHub
- URL: https://github.com/near/near-sdk-js
- Owner: near
- License: mit
- Created: 2021-12-15T02:05:40.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-22T10:38:45.000Z (12 months ago)
- Last Synced: 2024-05-23T05:43:18.937Z (12 months ago)
- Topics: near, near-protocol, sdk, smart-contract-tools
- Language: TypeScript
- Homepage: https://near.github.io/near-sdk-js/
- Size: 93.2 MB
- Stars: 191
- Watchers: 10
- Forks: 66
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-near - near-sdk-js
README
# NEAR JavaScript SDK
A JavaScript library for writing NEAR smart contracts.
```typescript
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](https://docs.near.org/build/smart-contracts/anatomy/).
## Documentation
- [Learn how to use](https://github.com/near/create-near-app/tree/master/templates/contracts/ts)
- [Learn by example with AgorApp](https://agorapp.dev/catalog/all?difficulty=&chains=near)
- [Learn by example with NEAR Docs](https://docs.near.org/build/smart-contracts/quickstart)
- Check our [detailed examples and tutorials](https://docs.near.org/tutorials/welcome)
- Find [source code examples](https://github.com/near/near-sdk-js/tree/develop/examples) with common use cases
- Lookup available features in [API reference](https://near.github.io/near-sdk-js/)
- 🏠 Learn more about NEAR on our [Documentation website](https://docs.near.org/)
- Breaking features diff from [SDK 2.0.0 to 1.0.0](https://github.com/near/near-sdk-js/tree/develop/[email protected])
## Prerequisites
- node >=14 <16.6.0 || >16.6.0
- pnpm >=7
## Quick Start
Use [`create-near-app`](https://github.com/near/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](https://github.com/near/near-sdk-js/tree/develop/CONTRIBUTING.md).
- [Report issues you encounter](https://github.com/near/near-sdk-js/issues) 🐞
- [Provide suggestions or feedback](https://github.com/near/near-sdk-js/discussions) 💡
- [Show us what you've built!](https://github.com/near/near-sdk-js/discussions/categories/show-and-tell) 💪
## License
This repository is distributed under the terms of both the [MIT license](https://github.com/near/near-sdk-js/blob/develop/LICENSE) and the [Apache License](https://github.com/near/near-sdk-js/blob/develop/LICENSE-APACHE) (Version 2.0).
See [LICENSE](https://github.com/near/near-sdk-js/tree/develop/LICENSE) and [LICENSE-APACHE](https://github.com/near/near-sdk-js/tree/develop/LICENSE-APACHE) for details.