Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mirrorworld-universe/mirrorworld-sdk-js
Mirror World Web3 JS SDK
https://github.com/mirrorworld-universe/mirrorworld-sdk-js
blockchain dapp javascript nodejs solana typescript
Last synced: 3 months ago
JSON representation
Mirror World Web3 JS SDK
- Host: GitHub
- URL: https://github.com/mirrorworld-universe/mirrorworld-sdk-js
- Owner: mirrorworld-universe
- License: apache-2.0
- Created: 2022-07-23T10:32:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-26T06:57:25.000Z (about 1 year ago)
- Last Synced: 2024-04-30T09:44:14.451Z (8 months ago)
- Topics: blockchain, dapp, javascript, nodejs, solana, typescript
- Language: TypeScript
- Homepage: https://docs.mirrorworld.fun/js/js-installation
- Size: 1.2 MB
- Stars: 16
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mirror World Web TypeScript SDK
[Mirror World's](https://mirrorworld.fun/developer) Official TypeScript/JavaScript SDK
## Getting started
1. Create a developer account at https://app.mirrorworld.fun. Create project and create an API Key.
2. Install SDK in your project
```bash
yarn add @mirrorworld/web3.js
#or with npm
npm install @mirrorworld/web3.js
```
## Usage
```ts
import { MirrorWorld, Solana } from '@mirrorworld/web3.js';
const mirrorworld = ref(
new MirrorWorld({
apiKey: 'YOUR_SECRET_API_KEY',
chainConfig: Solana('mainnet-beta'),
})
);
// Login user with Social Authentication
async function login() {
const { refreshToken } = await mirrorworld.value.login();
}
```
## Full API Documentation
You can view the documentation for Mirror World SDK for Mobile on our [Official Documentation Site](https://docs.mirrorworld.fun/overview/introduction)
## Features:
1. Authentication
1. Social Authentication
2. Login with Email/Password
2. Asset Management
1. Get current user's NFTs
2. Mint NFTs
3. List NFTs
4. Buy NFTs
5. Cancel Listing
6. Update Listing
7. Transfer NFT
8. Query NFTs by owners
9. Query NFTs by creator addresses
10. Query NFTs by update authorities
11. Get NFT details
3. Wallet
1. Get account activity
2. Get account tokens
3. Transfer SPL Tokens
4. Transfer SOL
5. Transfer MATIC
6. Transfer BNB
## Get Started Today
1. Go to [Mirror World Developer Dashboard](https://app.mirrorworld.fun) and create a project, create an application.
2. Install Mirror World SDK Demo for Javascript using `yarn install @mirrorworld/web3.js` and start building.
## Community
- **Discord**: [Join Discord](https://mirrorworld.fun/discord)
- **Twitter**: [Follow us](https://twitter.com/joinmirrorworld)
- **Telegram Group**: [Join](https://t.me/mirrorworld_sdk)
- **Telegram Channel**: [Subscribe](https://t.me/mirrorworld_news)
## Licence
Apache 2.0
Copyright (c) 2021 Mirror World Inc.