@solana-mobile/mobile-wallet-adapter-protocol 0.0.1-alpha.0

package/lib/types/index.browser.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Properties that wallets may present to users when an app
+ * asks for authorization to execute privileged methods (see
+ * {@link PrivilegedMethods}).
+ */
+type AppIdentity = Readonly<{
+    uri?: string;
+    icon?: string;
+    name?: string;
+}>;
+/**
+ * An ephemeral elliptic-curve keypair on the P-256 curve.
+ * This public key is used to create the association token.
+ * The private key is used during session establishment.
+ */
+type AssociationKeypair = CryptoKeyPair;
+/**
+ * The context returned from a wallet after having authorized a given
+ * account for use with a given application. You can cache this and
+ * use it later to invoke privileged methods.
+ */
+type AuthorizationResult = Readonly<{
+    authToken: string;
+    publicKey: string;
+    walletUriBase: string;
+}>;
+type AuthToken = string;
+type Base58EncodedSignature = string;
+type Base64EncodedMessage = string;
+type Base64EncodedSignedMessage = string;
+type Base64EncodedSignedTransaction = string;
+type Base64EncodedTransaction = string;
+interface MobileWallet {
+    (method: "authorize", params: {
+        identity: AppIdentity;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+        pub_key: string;
+        wallet_uri_base: string;
+    }>>;
+    (method: "clone_authorization", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+    }>>;
+    (method: "deauthorize", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<Record<string, never>>>;
+    (method: "reauthorize", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+    }>>;
+    (method: "sign_message", params: {
+        auth_token: AuthToken;
+        payloads: Base64EncodedMessage[];
+    }): Promise<Readonly<{
+        signed_payloads: Base64EncodedSignedMessage[];
+    }>>;
+    (method: "sign_transaction", params: {
+        auth_token: AuthToken;
+        payloads: Base64EncodedTransaction[];
+    }): Promise<Readonly<{
+        signed_payloads: Base64EncodedSignedTransaction[];
+    }>>;
+    (method: "sign_and_send_transaction", params: {
+        auth_token: AuthToken;
+        commitment: "confirmed" | "finalized" | "processed";
+        payloads: Base64EncodedTransaction[];
+    }): Promise<Readonly<{
+        signatures: Base58EncodedSignature[];
+    }>>;
+}
+type Config = Readonly<{
+    baseUri?: string;
+}>;
+declare function withLocalWallet<TReturn>(callback: (wallet: MobileWallet) => TReturn, config?: Config): Promise<TReturn>;
+declare class SolanaMobileWalletAdapterSecureContextRequiredError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterForbiddenWalletBaseURLError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterWalletNotInstalledError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterProtocolSessionEstablishmentError extends Error {
+    constructor(port: number);
+}
+declare class SolanaMobileWalletAdapterProtocolAssociationPortOutOfRangeError extends Error {
+    constructor(port: number);
+}
+declare class SolanaMobileWalletAdapterProtocolSessionClosedError extends Error {
+    constructor(code: number, reason: string);
+}
+declare class SolanaMobileWalletAdapterProtocolReauthorizeError extends Error {
+    constructor();
+}
+type JSONRPCErrorCode = number;
+// Typescript `enums` thwart tree-shaking. See https://bargsten.org/jsts/enums/
+declare const SolanaMobileWalletAdapterProtocolError: {
+    readonly ERROR_REAUTHORIZE: -1;
+    readonly ERROR_AUTHORIZATION_FAILED: -2;
+    readonly ERROR_INVALID_PAYLOAD: -3;
+    readonly ERROR_NOT_SIGNED: -4;
+    readonly ERROR_NOT_COMMITTED: -5;
+    readonly ERROR_ATTEST_ORIGIN_ANDROID: -100;
+};
+type SolanaMobileWalletAdapterProtocolErrorEnum = (typeof SolanaMobileWalletAdapterProtocolError)[keyof typeof SolanaMobileWalletAdapterProtocolError];
+type ErrorDataTypeMap = {
+    [SolanaMobileWalletAdapterProtocolError.ERROR_ATTEST_ORIGIN_ANDROID]: {
+        attest_origin_uri: string;
+        challenge: string;
+        context: string;
+    };
+};
+declare class SolanaMobileWalletAdapterProtocolJsonRpcError<TErrorCode extends keyof ErrorDataTypeMap> extends Error {
+    data: ErrorDataTypeMap[TErrorCode] extends Record<string, unknown> ? ErrorDataTypeMap[TErrorCode] : undefined;
+    code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode;
+    jsonRpcMessageId: number;
+    constructor(...args: ErrorDataTypeMap[TErrorCode] extends Record<string, unknown> ? [
+        jsonRpcMessageId: number,
+        code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode,
+        message: string,
+        data: ErrorDataTypeMap[TErrorCode]
+    ] : [
+        jsonRpcMessageId: number,
+        code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode,
+        message: string
+    ]);
+}
+export { withLocalWallet, SolanaMobileWalletAdapterSecureContextRequiredError, SolanaMobileWalletAdapterForbiddenWalletBaseURLError, SolanaMobileWalletAdapterWalletNotInstalledError, SolanaMobileWalletAdapterProtocolSessionEstablishmentError, SolanaMobileWalletAdapterProtocolAssociationPortOutOfRangeError, SolanaMobileWalletAdapterProtocolSessionClosedError, SolanaMobileWalletAdapterProtocolReauthorizeError, SolanaMobileWalletAdapterProtocolError, SolanaMobileWalletAdapterProtocolJsonRpcError, AppIdentity, AssociationKeypair, AuthorizationResult, AuthToken, MobileWallet };
+//# sourceMappingURL=index.browser.d.ts.map

package/lib/types/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../../src/index.ts","../../src/createHelloReq.ts","../../src/errors.ts","../../src/generateAssociationKeypair.ts","../../src/generateECDHKeypair.ts","../../src/parseHelloRsp.ts","../../src/jsonRpcMessage.ts","../../src/associationPort.ts","../../src/arrayBufferToBase64String.ts","../../src/getStringWithURLUnsafeBase64CharactersReplaced.ts","../../src/getAssociateAndroidIntentURL.ts","../../src/startSession.ts","../../src/types.ts","../../src/withLocalWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,2jBAA8B,CAA0B"}

package/lib/types/index.d.mts

@@ -0,0 +1,133 @@
+/**
+ * Properties that wallets may present to users when an app
+ * asks for authorization to execute privileged methods (see
+ * {@link PrivilegedMethods}).
+ */
+type AppIdentity = Readonly<{
+    uri?: string;
+    icon?: string;
+    name?: string;
+}>;
+/**
+ * An ephemeral elliptic-curve keypair on the P-256 curve.
+ * This public key is used to create the association token.
+ * The private key is used during session establishment.
+ */
+type AssociationKeypair = CryptoKeyPair;
+/**
+ * The context returned from a wallet after having authorized a given
+ * account for use with a given application. You can cache this and
+ * use it later to invoke privileged methods.
+ */
+type AuthorizationResult = Readonly<{
+    authToken: string;
+    publicKey: string;
+    walletUriBase: string;
+}>;
+type AuthToken = string;
+type Base58EncodedSignature = string;
+type Base64EncodedMessage = string;
+type Base64EncodedSignedMessage = string;
+type Base64EncodedSignedTransaction = string;
+type Base64EncodedTransaction = string;
+interface MobileWallet {
+    (method: "authorize", params: {
+        identity: AppIdentity;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+        pub_key: string;
+        wallet_uri_base: string;
+    }>>;
+    (method: "clone_authorization", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+    }>>;
+    (method: "deauthorize", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<Record<string, never>>>;
+    (method: "reauthorize", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+    }>>;
+    (method: "sign_message", params: {
+        auth_token: AuthToken;
+        payloads: Base64EncodedMessage[];
+    }): Promise<Readonly<{
+        signed_payloads: Base64EncodedSignedMessage[];
+    }>>;
+    (method: "sign_transaction", params: {
+        auth_token: AuthToken;
+        payloads: Base64EncodedTransaction[];
+    }): Promise<Readonly<{
+        signed_payloads: Base64EncodedSignedTransaction[];
+    }>>;
+    (method: "sign_and_send_transaction", params: {
+        auth_token: AuthToken;
+        commitment: "confirmed" | "finalized" | "processed";
+        payloads: Base64EncodedTransaction[];
+    }): Promise<Readonly<{
+        signatures: Base58EncodedSignature[];
+    }>>;
+}
+type Config = Readonly<{
+    baseUri?: string;
+}>;
+declare function withLocalWallet<TReturn>(callback: (wallet: MobileWallet) => TReturn, config?: Config): Promise<TReturn>;
+declare class SolanaMobileWalletAdapterSecureContextRequiredError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterForbiddenWalletBaseURLError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterWalletNotInstalledError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterProtocolSessionEstablishmentError extends Error {
+    constructor(port: number);
+}
+declare class SolanaMobileWalletAdapterProtocolAssociationPortOutOfRangeError extends Error {
+    constructor(port: number);
+}
+declare class SolanaMobileWalletAdapterProtocolSessionClosedError extends Error {
+    constructor(code: number, reason: string);
+}
+declare class SolanaMobileWalletAdapterProtocolReauthorizeError extends Error {
+    constructor();
+}
+type JSONRPCErrorCode = number;
+// Typescript `enums` thwart tree-shaking. See https://bargsten.org/jsts/enums/
+declare const SolanaMobileWalletAdapterProtocolError: {
+    readonly ERROR_REAUTHORIZE: -1;
+    readonly ERROR_AUTHORIZATION_FAILED: -2;
+    readonly ERROR_INVALID_PAYLOAD: -3;
+    readonly ERROR_NOT_SIGNED: -4;
+    readonly ERROR_NOT_COMMITTED: -5;
+    readonly ERROR_ATTEST_ORIGIN_ANDROID: -100;
+};
+type SolanaMobileWalletAdapterProtocolErrorEnum = (typeof SolanaMobileWalletAdapterProtocolError)[keyof typeof SolanaMobileWalletAdapterProtocolError];
+type ErrorDataTypeMap = {
+    [SolanaMobileWalletAdapterProtocolError.ERROR_ATTEST_ORIGIN_ANDROID]: {
+        attest_origin_uri: string;
+        challenge: string;
+        context: string;
+    };
+};
+declare class SolanaMobileWalletAdapterProtocolJsonRpcError<TErrorCode extends keyof ErrorDataTypeMap> extends Error {
+    data: ErrorDataTypeMap[TErrorCode] extends Record<string, unknown> ? ErrorDataTypeMap[TErrorCode] : undefined;
+    code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode;
+    jsonRpcMessageId: number;
+    constructor(...args: ErrorDataTypeMap[TErrorCode] extends Record<string, unknown> ? [
+        jsonRpcMessageId: number,
+        code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode,
+        message: string,
+        data: ErrorDataTypeMap[TErrorCode]
+    ] : [
+        jsonRpcMessageId: number,
+        code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode,
+        message: string
+    ]);
+}
+export { withLocalWallet, SolanaMobileWalletAdapterSecureContextRequiredError, SolanaMobileWalletAdapterForbiddenWalletBaseURLError, SolanaMobileWalletAdapterWalletNotInstalledError, SolanaMobileWalletAdapterProtocolSessionEstablishmentError, SolanaMobileWalletAdapterProtocolAssociationPortOutOfRangeError, SolanaMobileWalletAdapterProtocolSessionClosedError, SolanaMobileWalletAdapterProtocolReauthorizeError, SolanaMobileWalletAdapterProtocolError, SolanaMobileWalletAdapterProtocolJsonRpcError, AppIdentity, AssociationKeypair, AuthorizationResult, AuthToken, MobileWallet };
+//# sourceMappingURL=index.d.mts.map

package/lib/types/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/index.ts","../../src/createHelloReq.ts","../../src/errors.ts","../../src/generateAssociationKeypair.ts","../../src/generateECDHKeypair.ts","../../src/parseHelloRsp.ts","../../src/jsonRpcMessage.ts","../../src/associationPort.ts","../../src/arrayBufferToBase64String.ts","../../src/getStringWithURLUnsafeBase64CharactersReplaced.ts","../../src/getAssociateAndroidIntentURL.ts","../../src/startSession.ts","../../src/types.ts","../../src/withLocalWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,2jBAA8B,CAA0B"}

package/lib/types/index.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Properties that wallets may present to users when an app
+ * asks for authorization to execute privileged methods (see
+ * {@link PrivilegedMethods}).
+ */
+type AppIdentity = Readonly<{
+    uri?: string;
+    icon?: string;
+    name?: string;
+}>;
+/**
+ * An ephemeral elliptic-curve keypair on the P-256 curve.
+ * This public key is used to create the association token.
+ * The private key is used during session establishment.
+ */
+type AssociationKeypair = CryptoKeyPair;
+/**
+ * The context returned from a wallet after having authorized a given
+ * account for use with a given application. You can cache this and
+ * use it later to invoke privileged methods.
+ */
+type AuthorizationResult = Readonly<{
+    authToken: string;
+    publicKey: string;
+    walletUriBase: string;
+}>;
+type AuthToken = string;
+type Base58EncodedSignature = string;
+type Base64EncodedMessage = string;
+type Base64EncodedSignedMessage = string;
+type Base64EncodedSignedTransaction = string;
+type Base64EncodedTransaction = string;
+interface MobileWallet {
+    (method: "authorize", params: {
+        identity: AppIdentity;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+        pub_key: string;
+        wallet_uri_base: string;
+    }>>;
+    (method: "clone_authorization", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+    }>>;
+    (method: "deauthorize", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<Record<string, never>>>;
+    (method: "reauthorize", params: {
+        auth_token: AuthToken;
+    }): Promise<Readonly<{
+        auth_token: AuthToken;
+    }>>;
+    (method: "sign_message", params: {
+        auth_token: AuthToken;
+        payloads: Base64EncodedMessage[];
+    }): Promise<Readonly<{
+        signed_payloads: Base64EncodedSignedMessage[];
+    }>>;
+    (method: "sign_transaction", params: {
+        auth_token: AuthToken;
+        payloads: Base64EncodedTransaction[];
+    }): Promise<Readonly<{
+        signed_payloads: Base64EncodedSignedTransaction[];
+    }>>;
+    (method: "sign_and_send_transaction", params: {
+        auth_token: AuthToken;
+        commitment: "confirmed" | "finalized" | "processed";
+        payloads: Base64EncodedTransaction[];
+    }): Promise<Readonly<{
+        signatures: Base58EncodedSignature[];
+    }>>;
+}
+type Config = Readonly<{
+    baseUri?: string;
+}>;
+declare function withLocalWallet<TReturn>(callback: (wallet: MobileWallet) => TReturn, config?: Config): Promise<TReturn>;
+declare class SolanaMobileWalletAdapterSecureContextRequiredError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterForbiddenWalletBaseURLError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterWalletNotInstalledError extends Error {
+    constructor();
+}
+declare class SolanaMobileWalletAdapterProtocolSessionEstablishmentError extends Error {
+    constructor(port: number);
+}
+declare class SolanaMobileWalletAdapterProtocolAssociationPortOutOfRangeError extends Error {
+    constructor(port: number);
+}
+declare class SolanaMobileWalletAdapterProtocolSessionClosedError extends Error {
+    constructor(code: number, reason: string);
+}
+declare class SolanaMobileWalletAdapterProtocolReauthorizeError extends Error {
+    constructor();
+}
+type JSONRPCErrorCode = number;
+// Typescript `enums` thwart tree-shaking. See https://bargsten.org/jsts/enums/
+declare const SolanaMobileWalletAdapterProtocolError: {
+    readonly ERROR_REAUTHORIZE: -1;
+    readonly ERROR_AUTHORIZATION_FAILED: -2;
+    readonly ERROR_INVALID_PAYLOAD: -3;
+    readonly ERROR_NOT_SIGNED: -4;
+    readonly ERROR_NOT_COMMITTED: -5;
+    readonly ERROR_ATTEST_ORIGIN_ANDROID: -100;
+};
+type SolanaMobileWalletAdapterProtocolErrorEnum = (typeof SolanaMobileWalletAdapterProtocolError)[keyof typeof SolanaMobileWalletAdapterProtocolError];
+type ErrorDataTypeMap = {
+    [SolanaMobileWalletAdapterProtocolError.ERROR_ATTEST_ORIGIN_ANDROID]: {
+        attest_origin_uri: string;
+        challenge: string;
+        context: string;
+    };
+};
+declare class SolanaMobileWalletAdapterProtocolJsonRpcError<TErrorCode extends keyof ErrorDataTypeMap> extends Error {
+    data: ErrorDataTypeMap[TErrorCode] extends Record<string, unknown> ? ErrorDataTypeMap[TErrorCode] : undefined;
+    code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode;
+    jsonRpcMessageId: number;
+    constructor(...args: ErrorDataTypeMap[TErrorCode] extends Record<string, unknown> ? [
+        jsonRpcMessageId: number,
+        code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode,
+        message: string,
+        data: ErrorDataTypeMap[TErrorCode]
+    ] : [
+        jsonRpcMessageId: number,
+        code: SolanaMobileWalletAdapterProtocolErrorEnum | JSONRPCErrorCode,
+        message: string
+    ]);
+}
+export { withLocalWallet, SolanaMobileWalletAdapterSecureContextRequiredError, SolanaMobileWalletAdapterForbiddenWalletBaseURLError, SolanaMobileWalletAdapterWalletNotInstalledError, SolanaMobileWalletAdapterProtocolSessionEstablishmentError, SolanaMobileWalletAdapterProtocolAssociationPortOutOfRangeError, SolanaMobileWalletAdapterProtocolSessionClosedError, SolanaMobileWalletAdapterProtocolReauthorizeError, SolanaMobileWalletAdapterProtocolError, SolanaMobileWalletAdapterProtocolJsonRpcError, AppIdentity, AssociationKeypair, AuthorizationResult, AuthToken, MobileWallet };
+//# sourceMappingURL=index.d.ts.map

package/lib/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts","../../src/createHelloReq.ts","../../src/errors.ts","../../src/generateAssociationKeypair.ts","../../src/generateECDHKeypair.ts","../../src/parseHelloRsp.ts","../../src/jsonRpcMessage.ts","../../src/associationPort.ts","../../src/arrayBufferToBase64String.ts","../../src/getStringWithURLUnsafeBase64CharactersReplaced.ts","../../src/getAssociateAndroidIntentURL.ts","../../src/startSession.ts","../../src/types.ts","../../src/withLocalWallet.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,2jBAA8B,CAA0B"}

package/package.json

@@ -0,0 +1,38 @@
+{
+    "name": "@solana-mobile/mobile-wallet-adapter-protocol",
+    "description": "An implementation of the Solana Mobile Mobile Wallet Adapter protocol. Use this to open a session with a mobile wallet app, and to issue API calls to it.",
+    "version": "0.0.1-alpha.0",
+    "author": "Steven Luscher <steven.luscher@solanamobile.com>",
+    "repository": "https://github.com/solana-mobile/mobile-wallet-adapter",
+    "license": "Apache-2.0",
+    "type": "module",
+    "sideEffects": false,
+    "main": "lib/cjs/index.js",
+    "module": "lib/esm/index.mjs",
+    "types": "lib/types/index.d.ts",
+    "browser": {
+        "./lib/cjs/index.js": "./lib/cjs/index.browser.js",
+        "./lib/esm/index.mjs": "./lib/esm/index.browser.mjs"
+    },
+    "exports": {
+        "import": "./lib/esm/index.mjs",
+        "require": "./lib/cjs/index.js"
+    },
+    "files": [
+        "lib",
+        "LICENSE"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "clean": "shx rm -rf lib/*",
+        "build": "yarn clean && rollup --config ../../rollup.config.ts --configPlugin rollup-plugin-ts",
+        "build:watch": "yarn clean && rollup --config ../../rollup.config.ts --configPlugin rollup-plugin-ts --watch",
+        "postbuild": "echo '{\"type\":\"commonjs\"}' | npx json > lib/cjs/package.json && echo '{\"type\":\"module\"} ' | npx json > lib/esm/package.json",
+        "prepublishOnly": "agadoo"
+    },
+    "devDependencies": {
+        "agadoo": "^2.0.0"
+    }
+}