chore: set get-starknet Snap's version through env variable (#435)

* chore: fix get-starknet snap version through env variable * chore: add SNAP_VERSION env set in webpack config * chore: pr comments handled * chore: fix lint * chore: updated workflow to use SNAP_VERSION for get-starknet
Consensys · Nov 25, 2024 · 08640d3 · 08640d3
1 parent fe2b8a5
commit 08640d3
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -111,7 +111,7 @@ jobs:
 
           echo "Building Get Starknet with GET_STARKNET_PUBLIC_PATH=$GET_STARKNET_PUBLIC_PATH" 
 
-          GET_STARKNET_PUBLIC_PATH=$GET_STARKNET_PUBLIC_PATH yarn workspace @consensys/get-starknet build
+          SNAP_VERSION="${VERSION}" GET_STARKNET_PUBLIC_PATH=$GET_STARKNET_PUBLIC_PATH yarn workspace @consensys/get-starknet build
         env:
           SNAP_ENV: ${{ needs.prepare-deployment.outputs.ENV }}
           VERSION: ${{ needs.prepare-deployment.outputs.VERSION }}

diff --git a/packages/get-starknet/src/wallet.ts b/packages/get-starknet/src/wallet.ts
@@ -58,14 +58,26 @@ export class MetaMaskSnapWallet implements StarknetWindowObject {
   // eslint-disable-next-line @typescript-eslint/naming-convention, no-restricted-globals
   static readonly snapId = process.env.SNAP_ID ?? 'npm:@consensys/starknet-snap';
 
-  constructor(metamaskProvider: MetaMaskProvider, snapVersion = '*') {
+  // eslint-disable-next-line @typescript-eslint/naming-convention, no-restricted-globals
+  static readonly snapVersion = process.env.SNAP_VERSION ?? '*';
+
+  /**
+   * Initializes a new instance of the MetaMaskSnapWallet class.
+   *
+   * The Snap version is now enforced globally via a static `snapVersion` property,
+   * this ensures consistent versioning across all instances and removes the need for consumers to specify it.
+   *
+   * @param metamaskProvider - The MetaMask Wallet Provider.
+   * @param _snapVersion - The `_snapVersion` parameter remains to maintain compatibility with existing usage.
+   */
+  constructor(metamaskProvider: MetaMaskProvider, _snapVersion = '*') {
     this.id = 'metamask';
     this.name = 'Metamask';
     this.version = 'v2.0.0';
     this.icon = WalletIconMetaData;
     this.lock = new Mutex();
     this.metamaskProvider = metamaskProvider;
-    this.snap = new MetaMaskSnap(MetaMaskSnapWallet.snapId, snapVersion, this.metamaskProvider);
+    this.snap = new MetaMaskSnap(MetaMaskSnapWallet.snapId, MetaMaskSnapWallet.snapVersion, this.metamaskProvider);
     this.isConnected = false;
 
     this.#rpcHandlers = new Map<string, IStarknetWalletRpc>([

diff --git a/packages/get-starknet/webpack.config.build.js b/packages/get-starknet/webpack.config.build.js
@@ -23,6 +23,7 @@ module.exports = (env) =>
     plugins: [
       new webpack.DefinePlugin({
         'process.env.SNAP_ID': JSON.stringify(process.env.SNAP_ID || 'npm:@consensys/starknet-snap'),
+        'process.env.SNAP_VERSION': JSON.stringify(process.env.SNAP_VERSION || '*'),
       }),
       new ModuleFederationPlugin({
         name: 'MetaMaskStarknetSnapWallet',