Skip to main content

sdk-js

MultiversX SDK for TypeScript and JavaScript

This SDK consists of TypeScript / JavaScript helpers and utilities for interacting with the Blockchain (in general) and with Smart Contracts (in particular).

Packages

Base libraries:

PackageSource codeDescription
sdk-coreGithubBasic components for interacting with the blockchain and with smart contracts.
sdk-walletGithubCore wallet components (generation, signing).
sdk-network-providersGithubNetwork Provider (API, Gateway) components (compatible with sdk-js).
sdk-exchangeGithubUtilities modules for xExchange interactions.

Signing providers for dApps:

PackageDocsSource codeDescription
sdk-hw-providerdocumentationGithubSign using the hardware wallet (Ledger).
sdk-wallet-connect-providerdocumentationGithubSign using WalletConnect.
sdk-extension-providerdocumentation | interactive documentationGithubSign using the MultiversX DeFi Wallet (browser extension).
sdk-web-wallet-providerdocumentationGithubSign using the MultiversX web wallet, using webhooks (DEPRECATED).
mx-sdk-js-web-wallet-cross-window-providerdocumentation | interactive documentationGithubSign using the MultiversX web wallet, by opening the wallet in a new tab.
mx-sdk-js-metamask-proxy-providerdocumentation | interactive documentationGithubSign using the Metamask wallet, by using web wallet as a proxy widget in iframe.

For more details about integrating a signing provider into your dApp, please follow this guide or the mx-sdk-js-examples repository.

Signing SDKs:

PackageSource codeDescription
sdk-dappGithubA library that holds the core functional & signing logic of a dapp on the MultiversX Network.
sdk-guardians-providerGithubHelper library for integrating a co-signing provider (Guardian) into dApps.
important

For all purposes, we recommend using sdk-dapp instead of integrating the signing providers on your own.

Native Authenticator libraries:

PackageSource codeDescription
sdk-native-auth-clientGithubNative Authenticator - client-side components.
sdk-native-auth-serverGithubNative Authenticator - server-side components.

Additional utility packages:

PackageSource codeDescription
transaction-decoderGithubDecodes transaction metadata from a given transaction.