@solana-mobile/mobile-wallet-adapter-walletlib 1.0.0

package/lib/typescript/resolve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../src/resolve.ts"],"names":[],"mappings":"AA0BA,aAAK,WAAW,GAAG,QAAQ,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC,CAAC;AAEH;;;GAGG;AAEH,oBAAY,UAAU,GAChB,mBAAmB,GACnB,uBAAuB,GACvB,8BAA8B,GAC9B,oBAAoB,CAAC;AAE3B,oBAAY,cAAc;IACtB,oBAAoB,mBAAmB;IACvC,sBAAsB,qBAAqB;IAC3C,sBAAsB,qBAAqB;IAC3C,mBAAmB,kBAAkB;IACrC,uBAAuB,sBAAsB;IAC7C,8BAA8B,+BAA+B;CAChE;AACD,UAAU,WAAW;IACjB,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,UAAU,CAAC;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B;AAED,oBAAY,oBAAoB,GAAG,QAAQ,CAAC;IACxC,MAAM,EAAE,cAAc,CAAC,oBAAoB,CAAC;CAC/C,CAAC,GACE,WAAW,CAAC;AAEhB,oBAAY,sBAAsB,GAAG,QAAQ,CAAC;IAC1C,MAAM,EAAE,cAAc,CAAC,sBAAsB,CAAC;CACjD,CAAC,GACE,WAAW,CAAC;AAEhB,oBAAY,sBAAsB,GAAG,QAAQ,CAAC;IAC1C,MAAM,EAAE,cAAc,CAAC,sBAAsB,CAAC;CACjD,CAAC,GACE,WAAW,CAAC;AAEhB,oBAAY,mBAAmB,GAAG,QAAQ,CAAC;IACvC,MAAM,EAAE,cAAc,CAAC,mBAAmB,CAAC;IAC3C,QAAQ,EAAE,UAAU,EAAE,CAAC;CAC1B,CAAC,GACE,WAAW,CAAC;AAEhB,oBAAY,uBAAuB,GAAG,QAAQ,CAAC;IAC3C,MAAM,EAAE,cAAc,CAAC,uBAAuB,CAAC;IAC/C,QAAQ,EAAE,UAAU,EAAE,CAAC;CAC1B,CAAC,GACE,WAAW,CAAC;AAEhB,oBAAY,8BAA8B,GAAG,QAAQ,CAAC;IAClD,MAAM,EAAE,cAAc,CAAC,8BAA8B,CAAC;IACtD,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC,GACE,WAAW,CAAC;AAEhB;;GAEG;AAEH,oBAAY,WAAW,GACjB,qBAAqB,GACrB,oBAAoB,GACpB,wBAAwB,GACxB,+BAA+B,CAAC;AAGtC,oBAAY,oBAAoB;IAC5B,YAAY,kBAAkB;IAC9B,eAAe,sBAAsB;IACrC,iBAAiB,uBAAuB;IACxC,qBAAqB,4BAA4B;CACpD;AAED,oBAAY,oBAAoB,GAAG,QAAQ,CAAC;IACxC,UAAU,EAAE,oBAAoB,CAAC,YAAY,CAAC;CACjD,CAAC,CAAC;AAEH,oBAAY,uBAAuB,GAAG,QAAQ,CAAC;IAC3C,UAAU,EAAE,oBAAoB,CAAC,eAAe,CAAC;CACpD,CAAC,CAAC;AAEH,oBAAY,6BAA6B,GAAG,QAAQ,CAAC;IACjD,UAAU,EAAE,oBAAoB,CAAC,qBAAqB,CAAC;CAC1D,CAAC,CAAC;AAEH,oBAAY,yBAAyB,GAAG,QAAQ,CAAC;IAC7C,UAAU,EAAE,oBAAoB,CAAC,iBAAiB,CAAC;IACnD,KAAK,EAAE,OAAO,EAAE,CAAC;CACpB,CAAC,CAAC;AAGH,oBAAY,6BAA6B,GAAG,QAAQ,CAAC;IACjD,SAAS,EAAE,UAAU,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,UAAU,CAAC;CACnC,CAAC,CAAC;AACH,oBAAY,qBAAqB,GAAG,6BAA6B,GAAG,oBAAoB,CAAC;AAGzF,oBAAY,4BAA4B,GAAG,QAAQ,CAAC;IAAE,cAAc,EAAE,UAAU,EAAE,CAAA;CAAE,CAAC,CAAC;AACtF,oBAAY,wBAAwB,GAC9B,oBAAoB,GACpB,uBAAuB,GACvB,6BAA6B,GAC7B,yBAAyB,CAAC;AAEhC,oBAAY,wBAAwB,GAAG,4BAA4B,GAAG,wBAAwB,CAAC;AAC/F,oBAAY,oBAAoB,GAAG,4BAA4B,GAAG,wBAAwB,CAAC;AAG3F,oBAAY,uCAAuC,GAAG,QAAQ,CAAC;IAAE,kBAAkB,EAAE,UAAU,EAAE,CAAA;CAAE,CAAC,CAAC;AACrG,oBAAY,+BAA+B,GACrC,uCAAuC,GACvC,oBAAoB,GACpB,uBAAuB,GACvB,6BAA6B,GAC7B,yBAAyB,CAAC;AAEhC,wBAAgB,OAAO,CAAC,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAC;AAC9F,wBAAgB,OAAO,CAAC,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,oBAAoB,GAAG,IAAI,CAAC;AAC5F,wBAAgB,OAAO,CAAC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,wBAAwB,GAAG,IAAI,CAAC;AACpG,wBAAgB,OAAO,CAAC,OAAO,EAAE,8BAA8B,EAAE,QAAQ,EAAE,+BAA+B,GAAG,IAAI,CAAC"}

package/lib/typescript/useMobileWalletAdapterSession.d.ts

@@ -0,0 +1,12 @@
+import type { TransactionVersion } from '@solana/web3.js';
+import { MWASessionEvent } from './mwaSessionEvents.js';
+import { MWARequest } from './resolve.js';
+export interface MobileWalletAdapterConfig {
+    supportsSignAndSendTransactions: boolean;
+    maxTransactionsPerSigningRequest: number;
+    maxMessagesPerSigningRequest: number;
+    supportedTransactionVersions: Array<TransactionVersion>;
+    noConnectionWarningTimeoutMs: number;
+}
+export declare function useMobileWalletAdapterSession(walletName: string, config: MobileWalletAdapterConfig, handleRequest: (request: MWARequest) => void, handleSessionEvent: (sessionEvent: MWASessionEvent) => void): void;
+//# sourceMappingURL=useMobileWalletAdapterSession.d.ts.map

package/lib/typescript/useMobileWalletAdapterSession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMobileWalletAdapterSession.d.ts","sourceRoot":"","sources":["../../src/useMobileWalletAdapterSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAI1D,OAAO,EAAE,eAAe,EAAuB,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAC;AA4B1D,MAAM,WAAW,yBAAyB;IACtC,+BAA+B,EAAE,OAAO,CAAC;IACzC,gCAAgC,EAAE,MAAM,CAAC;IACzC,4BAA4B,EAAE,MAAM,CAAC;IACrC,4BAA4B,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACxD,4BAA4B,EAAE,MAAM,CAAC;CACxC;AAED,wBAAgB,6BAA6B,CACzC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,yBAAyB,EACjC,aAAa,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,IAAI,EAC5C,kBAAkB,EAAE,CAAC,YAAY,EAAE,eAAe,KAAK,IAAI,QAqB9D"}

package/package.json

@@ -0,0 +1,69 @@
+{
+    "name": "@solana-mobile/mobile-wallet-adapter-walletlib",
+    "description": "A React Native wrapper of the Solana Mobile, Mobile Wallet Adapter Wallet Library. Wallet apps can use this to handle dapp requests for signing and sending.",
+    "version": "1.0.0",
+    "author": "Michael Sulistio <mike.sulistio@solanamobile.com>",
+    "repository": "https://github.com/solana-mobile/mobile-wallet-adapter",
+    "license": "Apache-2.0",
+    "type": "module",
+    "sideEffects": false,
+    "react-native": "src/index",
+    "main": "lib/commonjs/index",
+    "module": "lib/module/index",
+    "types": "lib/typescript/index.d.ts",
+    "files": [
+        "android",
+        "!android/build",
+        "lib",
+        "src",
+        "LICENSE"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "typecheck": "tsc --noEmit",
+        "lint": "eslint \"**/*.{js,ts,tsx}\"",
+        "prepack": "bob build",
+        "release": "release-it",
+        "example": "yarn --cwd example",
+        "bootstrap": "yarn example && yarn install && yarn example pods",
+        "clean": "shx rm -rf lib/*"
+    },
+    "devDependencies": {
+        "@release-it/conventional-changelog": "^5.0.0",
+        "@solana/web3.js": "^1.58.0",
+        "@types/react-native": "^0.69.3",
+        "react-native-builder-bob": "^0.20.4",
+        "release-it": "^15.0.0"
+    },
+    "peerDependencies": {
+        "react-native": ">0.69"
+    },
+    "release-it": {
+        "git": {
+          "commitMessage": "chore: release ${version}",
+          "tagName": "v${version}"
+        },
+        "npm": {
+          "publish": true
+        },
+        "github": {
+          "release": true
+        },
+        "plugins": {
+          "@release-it/conventional-changelog": {
+            "preset": "angular"
+          }
+        }
+      },
+    "react-native-builder-bob": {
+        "source": "src",
+        "output": "lib",
+        "targets": [
+          "commonjs",
+          "module",
+          "typescript"
+        ]
+      }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './mwaSessionEvents.js';
+export * from './resolve.js';
+export * from './useMobileWalletAdapterSession.js';

package/src/mwaSessionEvents.ts

@@ -0,0 +1,75 @@
+/**
+ * Mobile Wallet Adapter Session Events are notifications and events
+ * about the underlying session between the wallet and the dApp.
+ */
+export enum MWASessionEventType {
+    SessionStartEvent = 'SESSION_START',
+    SessionReadyEvent = 'SESSION_READY',
+    SessionTerminatedEvent = 'SESSION_TERMINATED',
+    SessionServingClientsEvent = 'SESSION_SERVING_CLIENTS',
+    SessionServingCompleteEvent = 'SESSION_SERVING_COMPLETE',
+    SessionCompleteEvent = 'SESSION_COMPLETE',
+    SessionErrorEvent = 'SESSION_ERROR',
+    SessionTeardownCompleteEvent = 'SESSION_TEARDOWN_COMPLETE',
+    LowPowerNoConnectionEvent = 'LOW_POWER_NO_CONNECTION',
+}
+export interface IMWASessionEvent {
+    __type: MWASessionEventType;
+    sessionId: string;
+}
+
+export type SessionStartEvent = Readonly<{
+    __type: MWASessionEventType.SessionStartEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionReadyEvent = Readonly<{
+    __type: MWASessionEventType.SessionReadyEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionTerminatedEvent = Readonly<{
+    __type: MWASessionEventType.SessionTerminatedEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionServingClientsEvent = Readonly<{
+    __type: MWASessionEventType.SessionServingClientsEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionServingCompleteEvent = Readonly<{
+    __type: MWASessionEventType.SessionServingCompleteEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionCompleteEvent = Readonly<{
+    __type: MWASessionEventType.SessionCompleteEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionErrorEvent = Readonly<{
+    __type: MWASessionEventType.SessionErrorEvent;
+}> &
+    IMWASessionEvent;
+
+export type SessionTeardownCompleteEvent = Readonly<{
+    __type: MWASessionEventType.SessionTeardownCompleteEvent;
+}> &
+    IMWASessionEvent;
+
+export type LowPowerNoConnectionEvent = Readonly<{
+    __type: MWASessionEventType.LowPowerNoConnectionEvent;
+}> &
+    IMWASessionEvent;
+
+export type MWASessionEvent =
+    | SessionStartEvent
+    | SessionReadyEvent
+    | SessionTerminatedEvent
+    | SessionServingClientsEvent
+    | SessionServingCompleteEvent
+    | SessionCompleteEvent
+    | SessionErrorEvent
+    | SessionTeardownCompleteEvent
+    | LowPowerNoConnectionEvent;

package/src/resolve.ts

@@ -0,0 +1,165 @@
+import { NativeModules, Platform } from 'react-native';
+
+const LINKING_ERROR =
+    `The package 'solana-mobile-wallet-adapter-walletlib' doesn't seem to be linked. Make sure: \n\n` +
+    '- You rebuilt the app after installing the package\n' +
+    '- If you are using Lerna workspaces\n' +
+    '  - You have added `@solana-mobile/mobile-wallet-adapter-walletlib` as an explicit dependency, and\n' +
+    '  - You have added `@solana-mobile/mobile-wallet-adapter-walletlib` to the `nohoist` section of your package.json\n' +
+    '- You are not using Expo managed workflow\n';
+
+const SolanaMobileWalletAdapterWalletLib =
+    Platform.OS === 'android' && NativeModules.SolanaMobileWalletAdapterWalletLib
+        ? NativeModules.SolanaMobileWalletAdapterWalletLib
+        : new Proxy(
+              {},
+              {
+                  get() {
+                      throw new Error(
+                          Platform.OS !== 'android'
+                              ? 'The package `solana-mobile-wallet-adapter-walletlib` is only compatible with React Native Android'
+                              : LINKING_ERROR,
+                      );
+                  },
+              },
+          );
+
+type AppIdentity = Readonly<{
+    identityUri?: string;
+    iconRelativeUri?: string;
+    identityName?: string;
+}>;
+
+/**
+ * Mobile Wallet Adapter Requests are remote requests coming from
+ * the dApp for authorization, signing, and sending services.
+ */
+
+export type MWARequest =
+    | SignMessagesRequest
+    | SignTransactionsRequest
+    | SignAndSendTransactionsRequest
+    | AuthorizeDappRequest;
+
+export enum MWARequestType {
+    AuthorizeDappRequest = 'AUTHORIZE_DAPP',
+    ReauthorizeDappRequest = 'REAUTHORIZE_DAPP',
+    DeauthorizeDappRequest = 'DEAUTHORIZE_DAPP',
+    SignMessagesRequest = 'SIGN_MESSAGES',
+    SignTransactionsRequest = 'SIGN_TRANSACTIONS',
+    SignAndSendTransactionsRequest = 'SIGN_AND_SEND_TRANSACTIONS',
+}
+interface IMWARequest {
+    __type: MWARequestType;
+    requestId: string;
+    sessionId: string;
+    cluster: string;
+    authorizationScope: Uint8Array;
+    appIdentity?: AppIdentity;
+}
+
+export type AuthorizeDappRequest = Readonly<{
+    __type: MWARequestType.AuthorizeDappRequest;
+}> &
+    IMWARequest;
+
+export type ReauthorizeDappRequest = Readonly<{
+    __type: MWARequestType.ReauthorizeDappRequest;
+}> &
+    IMWARequest;
+
+export type DeauthorizeDappRequest = Readonly<{
+    __type: MWARequestType.DeauthorizeDappRequest;
+}> &
+    IMWARequest;
+
+export type SignMessagesRequest = Readonly<{
+    __type: MWARequestType.SignMessagesRequest;
+    payloads: Uint8Array[];
+}> &
+    IMWARequest;
+
+export type SignTransactionsRequest = Readonly<{
+    __type: MWARequestType.SignTransactionsRequest;
+    payloads: Uint8Array[];
+}> &
+    IMWARequest;
+
+export type SignAndSendTransactionsRequest = Readonly<{
+    __type: MWARequestType.SignAndSendTransactionsRequest;
+    payloads: Uint8Array[];
+    minContextSlot?: number;
+}> &
+    IMWARequest;
+
+/**
+ * MWA Request Responses
+ */
+
+export type MWAResponse =
+    | AuthorizeDappResponse
+    | SignMessagesResponse
+    | SignTransactionsResponse
+    | SignAndSendTransactionsResponse;
+
+/* Failure Responses */
+export enum MWARequestFailReason {
+    UserDeclined = 'USER_DECLINED',
+    TooManyPayloads = 'TOO_MANY_PAYLOADS',
+    InvalidSignatures = 'INVALID_SIGNATURES',
+    AuthorizationNotValid = 'AUTHORIZATION_NOT_VALID',
+}
+
+export type UserDeclinedResponse = Readonly<{
+    failReason: MWARequestFailReason.UserDeclined;
+}>;
+
+export type TooManyPayloadsResponse = Readonly<{
+    failReason: MWARequestFailReason.TooManyPayloads;
+}>;
+
+export type AuthorizationNotValidResponse = Readonly<{
+    failReason: MWARequestFailReason.AuthorizationNotValid;
+}>;
+
+export type InvalidSignaturesResponse = Readonly<{
+    failReason: MWARequestFailReason.InvalidSignatures;
+    valid: boolean[];
+}>;
+
+/* Authorize Dapp */
+export type AuthorizeDappCompleteResponse = Readonly<{
+    publicKey: Uint8Array;
+    accountLabel?: string;
+    walletUriBase?: string;
+    authorizationScope?: Uint8Array;
+}>;
+export type AuthorizeDappResponse = AuthorizeDappCompleteResponse | UserDeclinedResponse;
+
+/* Sign Transactions/Messages */
+export type SignPayloadsCompleteResponse = Readonly<{ signedPayloads: Uint8Array[] }>;
+export type SignPayloadsFailResponse =
+    | UserDeclinedResponse
+    | TooManyPayloadsResponse
+    | AuthorizationNotValidResponse
+    | InvalidSignaturesResponse;
+
+export type SignTransactionsResponse = SignPayloadsCompleteResponse | SignPayloadsFailResponse;
+export type SignMessagesResponse = SignPayloadsCompleteResponse | SignPayloadsFailResponse;
+
+/* Sign and Send Transaction */
+export type SignAndSendTransactionsCompleteResponse = Readonly<{ signedTransactions: Uint8Array[] }>;
+export type SignAndSendTransactionsResponse =
+    | SignAndSendTransactionsCompleteResponse
+    | UserDeclinedResponse
+    | TooManyPayloadsResponse
+    | AuthorizationNotValidResponse
+    | InvalidSignaturesResponse;
+
+export function resolve(request: AuthorizeDappRequest, response: AuthorizeDappResponse): void;
+export function resolve(request: SignMessagesRequest, response: SignMessagesResponse): void;
+export function resolve(request: SignTransactionsRequest, response: SignTransactionsResponse): void;
+export function resolve(request: SignAndSendTransactionsRequest, response: SignAndSendTransactionsResponse): void;
+export function resolve(request: MWARequest, response: unknown): void {
+    SolanaMobileWalletAdapterWalletLib.resolve(JSON.stringify(request), JSON.stringify(response));
+}

package/src/useMobileWalletAdapterSession.ts

@@ -0,0 +1,83 @@
+import type { TransactionVersion } from '@solana/web3.js';
+import { useEffect } from 'react';
+import { Linking, NativeEventEmitter, NativeModules, Platform } from 'react-native';
+
+import { MWASessionEvent, MWASessionEventType } from './mwaSessionEvents.js';
+import { MWARequest, MWARequestType } from './resolve.js';
+
+const LINKING_ERROR =
+    `The package 'solana-mobile-wallet-adapter-walletlib' doesn't seem to be linked. Make sure: \n\n` +
+    '- You rebuilt the app after installing the package\n' +
+    '- If you are using Lerna workspaces\n' +
+    '  - You have added `@solana-mobile/mobile-wallet-adapter-walletlib` as an explicit dependency, and\n' +
+    '  - You have added `@solana-mobile/mobile-wallet-adapter-walletlib` to the `nohoist` section of your package.json\n' +
+    '- You are not using Expo managed workflow\n';
+
+const SolanaMobileWalletAdapterWalletLib =
+    Platform.OS === 'android' && NativeModules.SolanaMobileWalletAdapterWalletLib
+        ? NativeModules.SolanaMobileWalletAdapterWalletLib
+        : new Proxy(
+              {},
+              {
+                  get() {
+                      throw new Error(
+                          Platform.OS !== 'android'
+                              ? 'The package `solana-mobile-wallet-adapter-walletlib` is only compatible with React Native Android'
+                              : LINKING_ERROR,
+                      );
+                  },
+              },
+          );
+
+const MOBILE_WALLET_ADAPTER_EVENT_BRIDGE_NAME = 'MobileWalletAdapterServiceRequestBridge';
+
+export interface MobileWalletAdapterConfig {
+    supportsSignAndSendTransactions: boolean;
+    maxTransactionsPerSigningRequest: number;
+    maxMessagesPerSigningRequest: number;
+    supportedTransactionVersions: Array<TransactionVersion>;
+    noConnectionWarningTimeoutMs: number;
+}
+
+export function useMobileWalletAdapterSession(
+    walletName: string,
+    config: MobileWalletAdapterConfig,
+    handleRequest: (request: MWARequest) => void,
+    handleSessionEvent: (sessionEvent: MWASessionEvent) => void,
+) {
+    // Start native event listeners
+    useEffect(() => {
+        const mwaEventEmitter = new NativeEventEmitter();
+        const listener = mwaEventEmitter.addListener(MOBILE_WALLET_ADAPTER_EVENT_BRIDGE_NAME, (nativeEvent) => {
+            if (isMWARequest(nativeEvent)) {
+                handleRequest(nativeEvent as MWARequest);
+            } else if (isMWASessionEvent(nativeEvent)) {
+                handleSessionEvent(nativeEvent as MWASessionEvent);
+            } else {
+                console.warn('Unexpected native event type');
+            }
+        });
+
+        return () => {
+            listener.remove();
+        };
+    }, []);
+
+    initializeScenario(walletName, config);
+}
+
+async function initializeScenario(walletName: string, walletConfig: MobileWalletAdapterConfig) {
+    // Get initial URL
+    const initialUrl = await Linking.getInitialURL();
+
+    // Create Scenario and establish session with dapp
+    SolanaMobileWalletAdapterWalletLib.createScenario(walletName, initialUrl, JSON.stringify(walletConfig));
+}
+
+function isMWARequest(nativeEvent: any): boolean {
+    return Object.values(MWARequestType).includes(nativeEvent.__type);
+}
+
+function isMWASessionEvent(nativeEvent: any) {
+    return Object.values(MWASessionEventType).includes(nativeEvent.__type);
+}