A generic hook for fetching concrete features for wallet handles (#54)

Given a ‘handle’ to a wallet (either a `UiWallet` or a `UiWalletAccount`) and the name of a feature, this hook returns the feature object from the underlying Wallet Standard `Wallet`. In the event that the wallet or account does not support the feature, a `WalletStandardError` will be thrown. ```tsx function ConnectButton({ children, wallet }) { const connectFeature = useWalletFeature(wallet, 'standard:connect') as StandardConnectFeature; return <button onClick={() => connectFeature.connect()}>{children}</button>; } function Error({ error }) { let message; if (isWalletStandardError(error, WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED)) { const { featureName, walletName } = error.context; message = `The wallet '${walletName}' does not support the ${featureName} feature`; } else { message = 'Unknown error'; } return <div className="errorMessage">{message}</div>; } function App() { return ( <ErrorBoundary FallbackComponent={Error}> <ConnectButton>Connect</ConnectButton> </ErrorBoundary> ); } ```
anza-xyz · Jun 7, 2024 · fb5ba28 · fb5ba28
2 parents 183f464 + dd4b291
commit fb5ba28
Show file tree

Hide file tree

Showing 23 changed files with 465 additions and 8 deletions.
diff --git a/.changeset/swift-toys-begin.md b/.changeset/swift-toys-begin.md
@@ -0,0 +1,5 @@
+---
+'@wallet-standard/ui-features': patch
+---
+
+A function that you can use to materialize a wallet feature by name, given a `UiWallet` or `UiWalletAccount`
diff --git a/packages/core/errors/src/codes.ts b/packages/core/errors/src/codes.ts
@@ -29,6 +29,10 @@
 export const WALLET_STANDARD_ERROR__REGISTRY__WALLET_NOT_FOUND = 3834000 as const;
 export const WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND = 3834001 as const;
 
+// Feature-related errors.
+// Reserve error codes in the range [6160000-6160999].
+export const WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED = 6160002 as const;
+
 /**
  * A union of every Wallet Standard error code
  *
@@ -46,5 +50,6 @@ export const WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND = 3834001
  * https://stackoverflow.com/a/28818850
  */
 export type WalletStandardErrorCode =
+    | typeof WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED
     | typeof WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND
     | typeof WALLET_STANDARD_ERROR__REGISTRY__WALLET_NOT_FOUND;
diff --git a/packages/core/errors/src/context.ts b/packages/core/errors/src/context.ts
@@ -1,4 +1,8 @@
-import type { WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND, WalletStandardErrorCode } from './codes.js';
+import type {
+    WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND,
+    WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED,
+    WalletStandardErrorCode,
+} from './codes.js';
 
 type DefaultUnspecifiedErrorContextToUndefined<T> = {
     [P in WalletStandardErrorCode]: P extends keyof T ? T[P] : undefined;
@@ -12,6 +16,12 @@ type DefaultUnspecifiedErrorContextToUndefined<T> = {
  *   - Don't change or remove members of an error's context.
  */
 export type WalletStandardErrorContext = DefaultUnspecifiedErrorContextToUndefined<{
+    [WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED]: {
+        featureName: string;
+        supportedFeatures: string[];
+        supportedChains: string[];
+        walletName: string;
+    };
     [WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND]: {
         address: string;
         walletName: string;

diff --git a/packages/core/errors/src/messages.ts b/packages/core/errors/src/messages.ts
@@ -1,5 +1,6 @@
 import type { WalletStandardErrorCode } from './codes.js';
 import {
+    WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED,
     WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND,
     WALLET_STANDARD_ERROR__REGISTRY__WALLET_NOT_FOUND,
 } from './codes.js';
@@ -16,6 +17,8 @@ export const WalletStandardErrorMessages: Readonly<{
     // TypeScript will fail to build this project if add an error code without a message.
     [P in WalletStandardErrorCode]: string;
 }> = {
+    [WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED]:
+        "The wallet '$walletName' does not support the `$featureName` feature",
     [WALLET_STANDARD_ERROR__REGISTRY__WALLET_ACCOUNT_NOT_FOUND]:
         "No account with address $address could be found in the '$walletName' wallet",
     [WALLET_STANDARD_ERROR__REGISTRY__WALLET_NOT_FOUND]:

diff --git a/packages/react/core/package.json b/packages/react/core/package.json
@@ -37,6 +37,7 @@
     "dependencies": {
         "@wallet-standard/app": "workspace:^",
         "@wallet-standard/base": "workspace:^",
+        "@wallet-standard/errors": "workspace:^",
         "@wallet-standard/experimental-features": "workspace:^",
         "@wallet-standard/features": "workspace:^",
         "@wallet-standard/ui": "workspace:^",

diff --git a/packages/react/core/tsconfig.all.json b/packages/react/core/tsconfig.all.json
@@ -7,6 +7,9 @@
         {
             "path": "../../core/base/tsconfig.all.json"
         },
+        {
+            "path": "../../core/errors/tsconfig.all.json"
+        },
         {
             "path": "../../core/features/tsconfig.all.json"
         },

diff --git a/packages/ui/_/package.json b/packages/ui/_/package.json
@@ -31,7 +31,8 @@
     },
     "dependencies": {
         "@wallet-standard/ui-compare": "workspace:^",
-        "@wallet-standard/ui-core": "workspace:^"
+        "@wallet-standard/ui-core": "workspace:^",
+        "@wallet-standard/ui-features": "workspace:^"
     },
     "devDependencies": {
         "shx": "^0.3.4"

diff --git a/packages/ui/_/src/index.ts b/packages/ui/_/src/index.ts
@@ -1,2 +1,3 @@
 export * from '@wallet-standard/ui-compare';
 export * from '@wallet-standard/ui-core';
+export * from '@wallet-standard/ui-features';
diff --git a/packages/ui/_/tsconfig.all.json b/packages/ui/_/tsconfig.all.json
@@ -7,6 +7,9 @@
         {
             "path": "../compare/tsconfig.all.json"
         },
+        {
+            "path": "../features/tsconfig.all.json"
+        },
         {
             "path": "./tsconfig.cjs.json"
         },

diff --git a/packages/ui/features/.gitignore b/packages/ui/features/.gitignore
@@ -0,0 +1 @@
+lib
diff --git a/packages/ui/features/CHANGELOG.md b/packages/ui/features/CHANGELOG.md
@@ -0,0 +1 @@
+# @wallet-standard/ui-features
diff --git a/packages/ui/features/LICENSE b/packages/ui/features/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/ui/features/README.md b/packages/ui/features/README.md
@@ -0,0 +1,35 @@
+# `@wallet-standard/ui-features`
+
+This package includes functions useful for getting wallet and wallet accounts features.
+
+## Functions
+
+### `getWalletFeature(uiWalletHandle, featureName)`
+
+Given a &lsquo;handle&rsquo; to a wallet (either a `UiWallet` or a `UiWalletAccount`) and the name of a feature, this function returns the feature object from the underlying Wallet Standard `Wallet`. If the wallet does not support the feature, a `WalletStandardError` will be thrown.
+
+```tsx
+function ConnectButton({ children, wallet }) {
+    const connectFeature = getWalletFeature(wallet, 'standard:connect') as StandardConnectFeature;
+    return <button onClick={() => connectFeature.connect()}>{children}</button>;
+}
+
+function Error({ error }) {
+    let message;
+    if (isWalletStandardError(error, WALLET_STANDARD_ERROR__FEATURES__WALLET_FEATURE_UNIMPLEMENTED)) {
+        const { featureName, walletName } = error.context;
+        message = `The wallet '${walletName}' does not support the ${featureName} feature`;
+    } else {
+        message = 'Unknown error';
+    }
+    return <div className="errorMessage">{message}</div>;
+}
+
+function App() {
+    return (
+        <ErrorBoundary FallbackComponent={Error}>
+            <ConnectButton>Connect</ConnectButton>
+        </ErrorBoundary>
+    );
+}
+```
diff --git a/packages/ui/features/package.json b/packages/ui/features/package.json
@@ -0,0 +1,42 @@
+{
+    "name": "@wallet-standard/ui-features",
+    "version": "0.0.0",
+    "author": "Solana Maintainers <[email protected]>",
+    "repository": "https://github.com/wallet-standard/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",
+        "test": "jest -c ../../../node_modules/@wallet-standard/test-config/jest.config.ts --rootDir ."
+    },
+    "dependencies": {
+        "@wallet-standard/base": "workspace:*",
+        "@wallet-standard/errors": "workspace:*",
+        "@wallet-standard/ui-core": "workspace:*",
+        "@wallet-standard/ui-registry": "workspace:*"
+    },
+    "devDependencies": {
+        "shx": "^0.3.4"
+    }
+}