Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multiversx/mx-sdk-js-core
MultiversX SDK for interacting with the MultiversX blockchain (in general) and Smart Contracts (in particular).
https://github.com/multiversx/mx-sdk-js-core
Last synced: about 2 months ago
JSON representation
MultiversX SDK for interacting with the MultiversX blockchain (in general) and Smart Contracts (in particular).
- Host: GitHub
- URL: https://github.com/multiversx/mx-sdk-js-core
- Owner: multiversx
- License: other
- Created: 2021-05-27T14:18:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T11:58:43.000Z (8 months ago)
- Last Synced: 2024-04-01T15:08:41.730Z (8 months ago)
- Language: TypeScript
- Homepage: https://multiversx.github.io/mx-sdk-js-core/
- Size: 5.54 MB
- Stars: 55
- Watchers: 26
- Forks: 39
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-multiversx-dev-resources - Javascript SDK - Official TS/JS SDK for interacting with the MultiversX Network and MultiversX Smart Contracts using Javascript (written in Typescript) (MultiversX official / SDKs and dev tools)
- awesome - multiversx/mx-sdk-js-core - MultiversX SDK for interacting with the MultiversX blockchain (in general) and Smart Contracts (in particular). (TypeScript)
README
# MultiversX SDK for JavaScript and TypeScript
MultiversX SDK for JavaScript and TypeScript (written in TypeScript).
## Documentation
- [Cookbook](https://docs.multiversx.com/sdk-and-tools/sdk-js/sdk-js-cookbook/)
- [Auto-generated documentation](https://multiversx.github.io/mx-sdk-js-core/)
## Distribution
[npm](https://www.npmjs.com/package/@multiversx/sdk-core)
## Installation
`sdk-core` is delivered via **npm** and it can be installed as follows:
```
npm install @multiversx/sdk-core
```
## Development
Feel free to skip this section if you are not a contributor.
### Prerequisites
`browserify` and `esmify` are required to compile the browser-friendly versions of `sdk-core`. They can be installed as follows:
```
npm install --global browserify
npm install esmify
```
### Building the library
In order to compile the library, run the following:
```
npm install
npm run compile
npm run compile-browser
```
### Running the tests
In order to run the tests **on NodeJS**, do as follows:
```
npm run tests-unit
npm run tests-localnet
npm run tests-devnet
npm run tests-testnet
```
Before running the tests **in the browser**, make sure you have the package `http-server` installed globally.
```
npm install --global http-server
```
In order to run the tests **in the browser**, do as follows:
```
make clean && npm run browser-tests
```
For the `localnet` tests, make sure you have a _local testnet_ up & running. In order to start a _local testnet_, follow [this](https://docs.multiversx.com/developers/setup-local-testnet/).