diff --git a/packages/wallet-adapter/_/package.json b/packages/wallet-adapter/_/package.json index ae34b359..c71fcc7f 100644 --- a/packages/wallet-adapter/_/package.json +++ b/packages/wallet-adapter/_/package.json @@ -31,6 +31,7 @@ }, "dependencies": { "@solana/wallet-standard-wallet-adapter-base": "workspace:^", + "@solana/wallet-standard-wallet-adapter-compat": "workspace:^", "@solana/wallet-standard-wallet-adapter-react": "workspace:^" }, "devDependencies": { diff --git a/packages/wallet-adapter/_/src/index.ts b/packages/wallet-adapter/_/src/index.ts index adc45445..bba054a8 100644 --- a/packages/wallet-adapter/_/src/index.ts +++ b/packages/wallet-adapter/_/src/index.ts @@ -1,2 +1,3 @@ export * from '@solana/wallet-standard-wallet-adapter-base'; +export * from '@solana/wallet-standard-wallet-adapter-compat'; export * from '@solana/wallet-standard-wallet-adapter-react'; diff --git a/packages/wallet-adapter/_/tsconfig.all.json b/packages/wallet-adapter/_/tsconfig.all.json index 54a5e8c3..a81001b3 100644 --- a/packages/wallet-adapter/_/tsconfig.all.json +++ b/packages/wallet-adapter/_/tsconfig.all.json @@ -4,6 +4,9 @@ { "path": "../base/tsconfig.all.json" }, + { + "path": "../compat/tsconfig.all.json" + }, { "path": "../react/tsconfig.all.json" }, diff --git a/packages/wallet-adapter/compat/.gitignore b/packages/wallet-adapter/compat/.gitignore new file mode 100644 index 00000000..a65b4177 --- /dev/null +++ b/packages/wallet-adapter/compat/.gitignore @@ -0,0 +1 @@ +lib diff --git a/packages/wallet-adapter/compat/CHANGELOG.md b/packages/wallet-adapter/compat/CHANGELOG.md new file mode 100644 index 00000000..8cbe8b96 --- /dev/null +++ b/packages/wallet-adapter/compat/CHANGELOG.md @@ -0,0 +1 @@ +# @wallet-standard/compat-adapter diff --git a/packages/wallet-adapter/compat/LICENSE b/packages/wallet-adapter/compat/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/packages/wallet-adapter/compat/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/wallet-adapter/compat/README.md b/packages/wallet-adapter/compat/README.md new file mode 100644 index 00000000..51fd0294 --- /dev/null +++ b/packages/wallet-adapter/compat/README.md @@ -0,0 +1,6 @@ +# `@wallet-standard/compat-adapter` + +This package serves as a compatibility layer between [legacy wallet adapters](https://github.com/solana-labs/wallet-adapter) and the Wallet Standard. + +## Usage + diff --git a/packages/wallet-adapter/compat/package.json b/packages/wallet-adapter/compat/package.json new file mode 100644 index 00000000..d0267300 --- /dev/null +++ b/packages/wallet-adapter/compat/package.json @@ -0,0 +1,49 @@ +{ + "name": "@solana/wallet-standard-wallet-adapter-compat", + "version": "0.1.0", + "author": "Solana Maintainers ", + "repository": "https://github.com/solana-labs/wallet-standard", + "license": "Apache-2.0", + "publishConfig": { + "access": "public" + }, + "files": [ + "lib", + "src", + "LICENSE" + ], + "engines": { + "node": ">=16" + }, + "type": "module", + "sideEffects": false, + "main": "./lib/cjs/index.js", + "module": "./lib/esm/index.js", + "types": "./lib/types/index.d.ts", + "exports": { + "require": "./lib/cjs/index.js", + "import": "./lib/esm/index.js", + "types": "./lib/types/index.d.ts" + }, + "scripts": { + "clean": "shx mkdir -p lib && shx rm -rf lib", + "package": "shx mkdir -p lib/cjs && shx echo '{ \"type\": \"commonjs\" }' > lib/cjs/package.json" + }, + "peerDependencies": { + "@solana/web3.js": "^1.58.0", + "bs58": "^4.0.1" + }, + "dependencies": { + "@wallet-standard/base": "^1.0.1", + "@wallet-standard/features": "^1.0.3", + "@solana/wallet-adapter-base": "^0.9.23", + "@solana/wallet-standard-chains": "workspace:^", + "@solana/wallet-standard-features": "workspace:^" + }, + "devDependencies": { + "@solana/web3.js": "^1.58.0", + "@types/bs58": "^4.0.1", + "bs58": "^4.0.1", + "shx": "^0.3.4" + } +} diff --git a/packages/wallet-adapter/compat/src/adapter.ts b/packages/wallet-adapter/compat/src/adapter.ts new file mode 100644 index 00000000..698b320e --- /dev/null +++ b/packages/wallet-adapter/compat/src/adapter.ts @@ -0,0 +1,199 @@ +import type { IdentifierArray, Wallet, WalletAccount, WalletIcon, WalletVersion } from '@wallet-standard/base'; +import type { + StandardConnectFeature, + StandardConnectInput, + StandardDisconnectFeature, +} from '@wallet-standard/features'; +import { StandardConnect, StandardDisconnect } from '@wallet-standard/features'; +import type { Adapter, WalletName } from '@solana/wallet-adapter-base'; +import { SOLANA_CHAINS } from '@solana/wallet-standard-chains'; +import type { + SolanaSignAndSendTransactionFeature, + SolanaSignAndSendTransactionInput, + SolanaSignInFeature, + SolanaSignInInput, + SolanaSignMessageFeature, + SolanaSignMessageInput, + SolanaSignTransactionFeature, + SolanaSignTransactionInput, +} from '@solana/wallet-standard-features'; +import { + SolanaSignAndSendTransaction, + SolanaSignIn, + SolanaSignMessage, + SolanaSignTransaction, +} from '@solana/wallet-standard-features'; +import type { Commitment, SendOptions, TransactionSignature, Connection } from '@solana/web3.js'; +import { VersionedTransaction } from '@solana/web3.js'; +import base58 from 'bs58'; + +type RequiredSupportedFeatures = StandardConnectFeature & StandardDisconnectFeature; +type OptionalSupportedFeatures = Partial< + SolanaSignAndSendTransactionFeature & SolanaSignInFeature & SolanaSignMessageFeature & SolanaSignTransactionFeature +>; +type SupportedFeatures = RequiredSupportedFeatures & OptionalSupportedFeatures; + +type BlockhashFetcher = (config?: { + commitment?: Commitment; + minContextSlot?: number; +}) => Promise<{ blockhash: string }>; + +export interface ConnectionContext { + commitment?: Commitment; + getLatestBlockhash: BlockhashFetcher; + sendRawTransaction( + rawTransaction: Buffer | Uint8Array | Array, + options?: SendOptions + ): Promise; +} + +export class SolanaWalletAdapterWallet implements Wallet { + readonly #adapter: Adapter; + readonly #connection: ConnectionContext; + readonly #requiredFeatures: RequiredSupportedFeatures; + #optionalFeatures: OptionalSupportedFeatures = {}; + #accounts: WalletAccount[] = []; + + constructor(adapter: Adapter, connection: ConnectionContext) { + this.#adapter = adapter; + this.#connection = connection; + this.#requiredFeatures = { + [StandardConnect]: { + version: '1.0.0', + connect: async (input?: StandardConnectInput) => { + await this.#adapter.connect(); + this.memoizeAccountsAndFeatures(); + return { + accounts: this.accounts, + }; + }, + }, + [StandardDisconnect]: { + version: '1.0.0', + disconnect: async () => { + await this.#adapter.disconnect(); + this.memoizeAccountsAndFeatures(); + }, + }, + }; + } + + private memoizeAccountsAndFeatures() { + const publicKey = this.#adapter.publicKey; + if (publicKey) { + this.#accounts = [ + { + address: publicKey.toBase58(), + publicKey: publicKey.toBuffer(), + chains: this.chains, + features: Object.keys(this.features) as (keyof SupportedFeatures)[], + }, + ]; + } else { + this.#accounts = []; + } + + const walletAdapter = this.#adapter; + this.#optionalFeatures = { + [SolanaSignAndSendTransaction]: + 'sendTransaction' in walletAdapter + ? { + version: '1.0.0', + supportedTransactionVersions: [0, 'legacy'], + signAndSendTransaction: async (...inputs: readonly SolanaSignAndSendTransactionInput[]) => { + return Promise.all( + inputs.map(async (input) => { + const transaction = VersionedTransaction.deserialize(input.transaction); + + const signature = await walletAdapter.sendTransaction( + transaction, + this.#connection as Connection, + input.options + ); + return { signature: base58.decode(signature) }; + }) + ); + }, + } + : undefined, + [SolanaSignIn]: + 'signIn' in walletAdapter + ? { + version: '1.0.0', + signIn: async (...inputs: readonly SolanaSignInInput[]) => { + return await Promise.all(inputs.map(async (input) => walletAdapter.signIn(input))); + }, + } + : undefined, + [SolanaSignMessage]: + 'signMessage' in walletAdapter + ? { + version: '1.0.0', + signMessage: async (...inputs: readonly SolanaSignMessageInput[]) => { + return Promise.all( + inputs.map(async (input) => { + const signature = await walletAdapter.signMessage(input.message); + return { + signature, + signedMessage: input.message, + }; + }) + ); + }, + } + : undefined, + [SolanaSignTransaction]: + 'signAllTransactions' in walletAdapter + ? { + version: '1.0.0', + supportedTransactionVersions: [0, 'legacy'], + signTransaction: async (...inputs: readonly SolanaSignTransactionInput[]) => { + const transactions = inputs.map((input) => + VersionedTransaction.deserialize(input.transaction) + ); + const signedTransactions = await walletAdapter.signAllTransactions(transactions); + return signedTransactions.map((signedTransactions) => ({ + signedTransaction: signedTransactions.serialize(), + })); + }, + } + : undefined, + }; + } + + // MARK: Required getters for Wallet interface + + get version(): WalletVersion { + return '1.0.0'; + } + + get name(): WalletName { + return this.#adapter.name; + } + + get icon(): WalletIcon { + // In Adapter, icon is a string and not constraint to static base64 image. + // If icon is not a base64 image, throw an error. + if (!this.#adapter.icon.startsWith('data:image')) { + throw new Error( + 'Wallet icon must be a static base64 image. Please contact the author of the wallet adapter or subclass the adapter and override the icon.' + ); + } + return this.#adapter.icon as WalletIcon; + } + + get chains(): IdentifierArray { + return SOLANA_CHAINS; + } + + get features(): Readonly { + return { + ...this.#requiredFeatures, + ...this.#optionalFeatures, + }; + } + + get accounts(): readonly WalletAccount[] { + return this.#accounts; + } +} diff --git a/packages/wallet-adapter/compat/src/index.ts b/packages/wallet-adapter/compat/src/index.ts new file mode 100644 index 00000000..ddec7b57 --- /dev/null +++ b/packages/wallet-adapter/compat/src/index.ts @@ -0,0 +1 @@ +export * from './adapter.js'; diff --git a/packages/wallet-adapter/compat/tsconfig.all.json b/packages/wallet-adapter/compat/tsconfig.all.json new file mode 100644 index 00000000..915cab26 --- /dev/null +++ b/packages/wallet-adapter/compat/tsconfig.all.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../tsconfig.root.json", + "references": [ + { + "path": "../../core/chains/tsconfig.all.json" + }, + { + "path": "../../core/features/tsconfig.all.json" + }, + { + "path": "./tsconfig.cjs.json" + }, + { + "path": "./tsconfig.esm.json" + } + ] +} diff --git a/packages/wallet-adapter/compat/tsconfig.cjs.json b/packages/wallet-adapter/compat/tsconfig.cjs.json new file mode 100644 index 00000000..099b9aa7 --- /dev/null +++ b/packages/wallet-adapter/compat/tsconfig.cjs.json @@ -0,0 +1,7 @@ +{ + "extends": "../../../tsconfig.cjs.json", + "include": ["src"], + "compilerOptions": { + "outDir": "lib/cjs" + } +} diff --git a/packages/wallet-adapter/compat/tsconfig.esm.json b/packages/wallet-adapter/compat/tsconfig.esm.json new file mode 100644 index 00000000..4900d2fa --- /dev/null +++ b/packages/wallet-adapter/compat/tsconfig.esm.json @@ -0,0 +1,8 @@ +{ + "extends": "../../../tsconfig.esm.json", + "include": ["src"], + "compilerOptions": { + "outDir": "lib/esm", + "declarationDir": "lib/types" + } +} diff --git a/tsconfig.all.json b/tsconfig.all.json index 75fe70fa..6c077a59 100644 --- a/tsconfig.all.json +++ b/tsconfig.all.json @@ -22,6 +22,9 @@ { "path": "./packages/wallet-adapter/base/tsconfig.all.json" }, + { + "path": "./packages/wallet-adapter/compat/tsconfig.all.json" + }, { "path": "./packages/wallet-adapter/react/tsconfig.all.json" },