Practical overview
When it fits
Use it when building a JavaScript or TypeScript application that needs Mirror World login together with NFT or wallet operations, and your integration can be configured with a developer API key.
Who it is for
- Web application developers adding Mirror World authentication and Web3 features.
- Teams building NFT management, discovery or marketplace workflows.
- Developers creating wallet views for account activity, tokens and transfers.
Documented uses
- Add social or email/password authentication to an application.
- Mint, list, buy, update, cancel listings for, or transfer NFTs.
- Find NFTs by owner, creator address or update authority and retrieve NFT details.
- Show account activity and tokens, or initiate documented token and SOL transfers.
Requirements & limits
The documented setup requires a developer account and API key. The repository states that the SDK is open source under Apache 2.0.
- The setup example configures Solana mainnet-beta.
- The feature list includes MATIC and BNB transfers, but the supplied initialization example documents only Solana configuration.
- The repository links to full API documentation for further implementation details.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up the SDK in a JavaScript or TypeScript project
Create the documented developer credentials, install the package and initialize it for Solana mainnet-beta.
Before you start
- A developer account
- A project and API key
- A JavaScript or TypeScript project
- Yarn or npm
Steps
Create a developer account, project and API key in the Mirror World dashboard.
Install the package with
yarn add @mirrorworld/web3.jsor the command below.npm install @mirrorworld/web3.jsImport
MirrorWorldandSolanafrom@mirrorworld/web3.js.Initialize
MirrorWorldwith the API key andSolana('mainnet-beta')chain configuration.
Expected outcome
The SDK is installed and initialized in the project with the documented Solana configuration.
Guide limitations
- The README does not provide a complete application flow beyond initialization and a social-login example.
- Keep the API key secret, as the example labels it a secret API key.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 16 October 2026
- Original website title
- mirrorworld-universe/mirrorworld-sdk-js · Official homepage title · retained in its source language

