https://github.com/unboxed-software/mobile-wallet-adapter-walletlib
https://github.com/unboxed-software/mobile-wallet-adapter-walletlib
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/unboxed-software/mobile-wallet-adapter-walletlib
- Owner: Unboxed-Software
- License: other
- Created: 2023-10-30T20:29:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T20:33:17.000Z (over 2 years ago)
- Last Synced: 2025-10-08T21:17:57.056Z (8 months ago)
- Language: Kotlin
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unboxed Edits
Let's clone and extract the package into a new directory `lib`:
```bash
git clone https://github.com/solana-mobile/mobile-wallet-adapter.git
mkdir lib
cp -rf mobile-wallet-adapter/js/packages/mobile-wallet-adapter-walletlib ./lib
rm -rf mobile-wallet-adapter
```
Now we have to make some slight edits for our app to compile and resolve the new package.
First, in `android/build.gradle`, change the `minSdkVersion` to version `23`.
```gradle
minSdkVersion = 23
```
In `lib/mobile-wallet-adapter-walletlib/src/index.ts` remove all `.js` from the end of the exports.
```ts
export * from './mwaSessionEvents';
export * from './resolve';
export * from './useMobileWalletAdapterSession';
export * from './useDigitalAssetLinks';
```
In `lib/mobile-wallet-adapter-walletlib/src/useMobileWalletAdapterSession.ts` remove the `.js` from the following imports:
```ts
import { MWASessionEvent, MWASessionEventType } from './mwaSessionEvents';
import { MWARequest, MWARequestType } from './resolve';
```
In `lib/mobile-wallet-adapter-walletlib\android\src\main\java\com\solanamobile\mobilewalletadapterwalletlib\reactnative\MobileWalletAdapterBottomSheetActivity.kt` comment out the `protected fun isConcurrentRootEnabled() = false` line at the very bottom.
```kt
// override protected fun isConcurrentRootEnabled() = false
```
Lastly, add `@solana-mobile/mobile-wallet-adapter-walletlib` to our `package.json` dependancies with the filepath as the resolution:
```json
"dependencies": {
"@solana-mobile/mobile-wallet-adapter-walletlib": "file:./lib/mobile-wallet-adapter-walletlib",
}
```
# `@solana-mobile/mobile-wallet-adapter-walletlib`
This is a package that provides React Native bridge for the native `mobile-wallet-adapter-walletlib` library and it is designed for *Wallet apps* built in React Native. It provides an API to implement the wallet endpoint of the [mobile wallet adapter protocol](https://github.com/solana-mobile/mobile-wallet-adapter/blob/main/spec/spec.md).
Deep dive and read the full Mobile Wallet Adapter protocol [specification](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#mobile-wallet-adapter-specification).
## TODO
- Separate bottom sheet signing experience or make optional
## Note
This package is still in alpha and is not production ready. However, the API is stable and will not change drastically, so you can begin integration with your wallet.
## Quickstart
### 1. Define your MWA entrypoint
To support bottom sheet signing flow, you need to define a React component to be the entrypoint for MWA. When the dApp sends out an intent for `solana-wallet://`, this entrypoint component will be rendered.
Define your entrypoint component in `index.js`:
```typescript
AppRegistry.registerComponent(
'MobileWalletAdapterEntrypoint', // Constant
() => YourMWAComponent,
);
```
### 2. Start listening and handling MWA requests
Use this API to start a session and start handling requests:
```typescript
import {
MobileWalletAdapterConfig,
MWARequest,
MWASessionEvent,
useMobileWalletAdapterSession,
} from '@solana-mobile/mobile-wallet-adapter-protocol-walletlib';
const config: MobileWalletAdapterConfig = useMemo(() => {
return {
supportsSignAndSendTransactions: true,
maxTransactionsPerSigningRequest: 10,
maxMessagesPerSigningRequest: 10,
supportedTransactionVersions: [0, 'legacy'],
noConnectionWarningTimeoutMs: 3000,
};
}, []);
// MWA Session Handlers
const handleRequest = useCallback((request: MWARequest) => {
/* ... */
}, []);
const handleSessionEvent = useCallback((sessionEvent: MWASessionEvent) => {
/* ... */
}, []);
// Connect to the calling dApp and begin handling dApp requests
useMobileWalletAdapterSession(
'Example Wallet Label',
config,
handleRequest,
handleSessionEvent,
);
```
### 3. Handling requests
A `MWARequest` is handled by calling `resolve(request, response)` and each request have their appropriate response types.
An example of handling an `AuthorizationRequest`:
```typescript
import {
AuthorizeDappResponse
} from '@solana-mobile/mobile-wallet-adapter-protocol-walletlib';
const response = {
publicKey: Keypair.generate().publicKey.toBytes(),
label: 'Wallet Label',
} as AuthorizeDappResponse;
resolve(authorizationRequest, response)
```
There are a a selection of "fail" responses that you can return to the dApp. These are for cases where the user declines, or an error occurs during signing, etc.
```typescript
import {
UserDeclinedResponse
} from '@solana-mobile/mobile-wallet-adapter-protocol-walletlib';
const response = {
failReason: MWARequestFailReason.UserDeclined,
} as UserDeclinedResponse;
// Tells the dApp user has declined the authorization request
resolve(authorizationRequest, response)
```
## Properties of an MWA Request
Each MWA Request is defined in [`resolve.ts`](https://github.com/solana-mobile/mobile-wallet-adapter/blob/main/js/packages/mobile-wallet-adapter-walletlib/src/resolve.ts#L38).
Each come with their own properties and completion response structures.
If you want to understand the dApp perspective and how a dApp would send these requests, see [MWA API Documentation](https://docs.solanamobile.com/reference/) for dAppstypescript/mobile-wallet-adapter.
## MWARequest Interfaces
### `IMWARequest`
This is the base interface that all MWARequsts inherit from. The fields defined here are used in the package's internal implementation and the package consumer will generally not use them.
Fields:
- `__type`: An enum defining the type of MWA Request it is.
- `requestId`: A unique identifier of this specific MWA Request
- `sessionId`: A unique identifier of the MWA Session this request belongs to.
### `IVerifiableIdentityRequest`
This an interface that describes MWA Requests that come with a verifiable identity and the following 3 fields.
Fields:
- `authorizationScope`: A byte representation of the authorization token granted to the dApp.
- `cluster`: The Solana RPC cluster that the dApp intends to use.
- `appIdentity`: An object containing 3 optional identity fields about the dApp:
- Note: The `iconRelativeUri` is a relative path, relative to `identityUri`.
```
{
identityName: 'dApp Name',
identityUri: 'https://yourdapp.com'
iconRelativeUri: "favicon.ico", // Full path resolves to https://yourdapp.com/favicon.ico
}
```
### MWARequest Types
- `AuthorizeDappRequest`
- [Spec](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#authorize)
- Interfaces: `IMWARequest`
- `ReauthorizeDappRequest`
- [Spec](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#reauthorize)
- Interfaces: `IMWARequest`, `IVerifiableIdentityRequest`
- `DeauthorizeDappRequest`
- [Spec](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#deauthorize)
- Interfaces: `IMWARequest`, `IVerifiableIdentityRequest`
- `SignMessagesRequest`
- [Spec](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#sign_messages)
- Interfaces: `IMWARequest`, `IVerifiableIdentityRequest`
- `SignTransactionsRequest`
- [Spec](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#sign_transactions)
- Interfaces: `IMWARequest`, `IVerifiableIdentityRequest`
- `SignAndSendTransactionsRequest`
- [Spec](https://solana-mobile.github.io/mobile-wallet-adapter/spec/spec.html#sign_and_send_transactions)
- Interfaces: `IMWARequest`, `IVerifiableIdentityRequest`
# Changelog
## 1.0.3
- Fixed a rerender bug within `useMobileWalletAdapterSession` where `initializeScenario` was needlessly called on rerender.
- Added `DeauthorizeDappRequest` type, so Javascript side now knows when a dApp requests for deauthorization.
- Added `ReauthorizeDappRequest` type, so Javascript side now knows when a dApp requests for reauthorization.
- Refactored `IMWARequest` to only include fields `requestId`, `sessionId`, and `__type`.
- Added `IVerifableIdentityRequest` to take on the fields `authorizationScope`, `cluster`, and `appIdentity`.
- `AuthorizeDappRequest` now no longer includes `authorizationScope`. This was mistakenly included previously.
- Updated documentation in the README. See "Properties of an MWA Request".
# mobile-wallet-adapter-walletlib