[LW-11739] feat: blockfrost asset provider experiment (#1482)

* feat: direct to blockfrost asset provider experiment

add new 'blockfrost-asset-provider' PostHog feature flag
that replaces cardano-services asset provider with a new
one that makes requests directly to Blockfrost.

Lace use the original cardano-services provider as a
fallback (if Blockfrost provider fails).

Lace will still (regardless of feature flags) use the original
cardano-services asset provider in dapp connector

* chore: replace imports from @lace/cardano/dist with main package export

Author: mkazlauskas

.github/actions/build/app/action.yml

@@ -2,6 +2,15 @@ name: buildapp
 description: Build app
 
 inputs:
+  BLOCKFROST_PROJECT_ID_MAINNET:
+    description: 'MainNet Project ID for Blockfrost API usage'
+    required: true
+  BLOCKFROST_PROJECT_ID_PREPROD:
+    description: 'PreProd Project ID for Blockfrost API usage'
+    required: true
+  BLOCKFROST_PROJECT_ID_PREVIEW:
+    description: 'Preview Project ID for Blockfrost API usage'
+    required: true
   DIR:
     description: 'app directory'
     required: true
@@ -42,6 +51,9 @@ runs:
       shell: bash
       working-directory: ${{ inputs.DIR }}
       env:
+        BLOCKFROST_PROJECT_ID_MAINNET: ${{ inputs.BLOCKFROST_PROJECT_ID_MAINNET }}
+        BLOCKFROST_PROJECT_ID_PREPROD: ${{ inputs.BLOCKFROST_PROJECT_ID_PREPROD }}
+        BLOCKFROST_PROJECT_ID_PREVIEW: ${{ inputs.BLOCKFROST_PROJECT_ID_PREVIEW }}
         LACE_EXTENSION_KEY: ${{ inputs.LACE_EXTENSION_KEY }}
         BUILD_DEV_PREVIEW: ${{ inputs.BUILD_DEV_PREVIEW }}
         POSTHOG_PRODUCTION_TOKEN: ${{ inputs.POSTHOG_PRODUCTION_TOKEN }}

.github/shared/build/action.yml

@@ -23,6 +23,18 @@ inputs:
     description: 'Banxa`s integration URL'
     required: false
     default: 'https://lacewallet.banxa-sandbox.com/'
+  BLOCKFROST_PROJECT_ID_MAINNET:
+    description: 'MainNet Project ID for Blockfrost API usage'
+    required: true
+  BLOCKFROST_PROJECT_ID_PREPROD:
+    description: 'PreProd Project ID for Blockfrost API usage'
+    required: true
+  BLOCKFROST_PROJECT_ID_PREVIEW:
+    description: 'Preview Project ID for Blockfrost API usage'
+    required: true
+  BLOCKFROST_PROJECT_ID_SANCHONET:
+    description: 'SanchoNet Project ID for Blockfrost API usage'
+    required: true
   CARDANO_SERVICES_URL_MAINNET:
     description: 'Url for mainnet env'
     required: false
@@ -107,6 +119,10 @@ runs:
         POSTHOG_PRODUCTION_TOKEN: ${{ inputs.POSTHOG_PRODUCTION_TOKEN }}
         PRODUCTION_MODE_TRACKING: ${{ inputs.PRODUCTION_MODE_TRACKING }}
         BANXA_LACE_URL: ${{ inputs.BANXA_LACE_URL }}
+        BLOCKFROST_PROJECT_ID_MAINNET: ${{ inputs.BLOCKFROST_PROJECT_ID_MAINNET }}
+        BLOCKFROST_PROJECT_ID_PREPROD: ${{ inputs.BLOCKFROST_PROJECT_ID_PREPROD }}
+        BLOCKFROST_PROJECT_ID_PREVIEW: ${{ inputs.BLOCKFROST_PROJECT_ID_PREVIEW }}
+        BLOCKFROST_PROJECT_ID_SANCHONET: ${{ inputs.BLOCKFROST_PROJECT_ID_SANCHONET }}
         CARDANO_SERVICES_URL_MAINNET: ${{ inputs.CARDANO_SERVICES_URL_MAINNET }}
         CARDANO_SERVICES_URL_PREPROD: ${{ inputs.CARDANO_SERVICES_URL_PREPROD }}
         CARDANO_SERVICES_URL_PREVIEW: ${{ inputs.CARDANO_SERVICES_URL_PREVIEW }}

.github/workflows/build-dev-preview.yml

@@ -22,6 +22,10 @@ jobs:
       - name: Build dev preview version of Lace
         uses: ./.github/shared/build
         with:
+          BLOCKFROST_PROJECT_ID_MAINNET: ${{ secrets.BLOCKFROST_PROJECT_ID_MAINNET }}
+          BLOCKFROST_PROJECT_ID_PREPROD: ${{ secrets.BLOCKFROST_PROJECT_ID_PREPROD }}
+          BLOCKFROST_PROJECT_ID_PREVIEW: ${{ secrets.BLOCKFROST_PROJECT_ID_PREVIEW }}
+          BLOCKFROST_PROJECT_ID_SANCHONET: ${{ secrets.BLOCKFROST_PROJECT_ID_SANCHONET }}
           BUILD_DEV_PREVIEW: 'true'
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           LACE_EXTENSION_KEY: ${{ secrets.DEV_PREVIEW_MANIFEST_PUBLIC_KEY  }}

.github/workflows/ci.yml

@@ -195,6 +195,9 @@ jobs:
       - name: Build Lace browser extension
         uses: ./.github/actions/build/app
         with:
+          BLOCKFROST_PROJECT_ID_MAINNET: ${{ secrets.BLOCKFROST_PROJECT_ID_MAINNET }}
+          BLOCKFROST_PROJECT_ID_PREPROD: ${{ secrets.BLOCKFROST_PROJECT_ID_PREPROD }}
+          BLOCKFROST_PROJECT_ID_PREVIEW: ${{ secrets.BLOCKFROST_PROJECT_ID_PREVIEW }}
           DIR: apps/browser-extension-wallet
           NAME: lace-browser-extension
           LACE_EXTENSION_KEY: ${{ secrets.MANIFEST_PUBLIC_KEY }}
@@ -215,6 +218,9 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           LACE_EXTENSION_KEY: ${{ secrets.MANIFEST_PUBLIC_KEY }}
+          BLOCKFROST_PROJECT_ID_MAINNET: ${{ secrets.BLOCKFROST_PROJECT_ID_MAINNET }}
+          BLOCKFROST_PROJECT_ID_PREPROD: ${{ secrets.BLOCKFROST_PROJECT_ID_PREPROD }}
+          BLOCKFROST_PROJECT_ID_PREVIEW: ${{ secrets.BLOCKFROST_PROJECT_ID_PREVIEW }}
 
       - name: Upload build artifact
         uses: actions/upload-artifact@v4

.github/workflows/e2e-tests-linux-split.yml

@@ -176,6 +176,9 @@ jobs:
           CARDANO_WS_SERVER_URL_MAINNET: 'wss://${{ env.CARDANO_MAINNET_URL }}'
           CARDANO_WS_SERVER_URL_PREPROD: 'wss://${{ env.CARDANO_PREPROD_URL }}'
           CARDANO_WS_SERVER_URL_PREVIEW: 'wss://${{ env.CARDANO_PREVIEW_URL }}'
+          BLOCKFROST_PROJECT_ID_MAINNET: ${{ secrets.BLOCKFROST_PROJECT_ID_MAINNET }}
+          BLOCKFROST_PROJECT_ID_PREPROD: ${{ secrets.BLOCKFROST_PROJECT_ID_PREPROD }}
+          BLOCKFROST_PROJECT_ID_PREVIEW: ${{ secrets.BLOCKFROST_PROJECT_ID_PREVIEW }}
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           LACE_EXTENSION_KEY: ${{ secrets.MANIFEST_PUBLIC_KEY }}
 
@@ -228,7 +231,7 @@ jobs:
     name: Process e2e test reports
     needs: [setup, tests]
     runs-on: ${{ needs.setup.outputs.runner }}
-#    when cancelling job always() will prevent step from being cancelled and we don't want process results in this case
+    # when cancelling job always() will prevent step from being cancelled and we don't want process results in this case
     if: ${{ success() || failure() }}
     steps:
       - name: Download all artifacts

apps/browser-extension-wallet/.env.defaults

@@ -66,13 +66,23 @@ CARDANO_SERVICES_URL_MAINNET=https://dev-mainnet.lw.iog.io
 CARDANO_SERVICES_URL_PREPROD=https://dev-preprod.lw.iog.io
 CARDANO_SERVICES_URL_PREVIEW=https://dev-preview.lw.iog.io
 CARDANO_SERVICES_URL_SANCHONET=https://dev-sanchonet.lw.iog.io
+BLOCKFROST_PROJECT_ID_MAINNET=mainnetprojectid
+BLOCKFROST_PROJECT_ID_PREPROD=preprodprojectid
+BLOCKFROST_PROJECT_ID_PREVIEW=previewprojectid
+BLOCKFROST_PROJECT_ID_SANCHONET=sanchonetprojectid
 
 # Cardano WS Services
 CARDANO_WS_SERVER_URL_MAINNET=wss://dev-mainnet.lw.iog.io
 CARDANO_WS_SERVER_URL_PREPROD=wss://dev-preprod.lw.iog.io
 CARDANO_WS_SERVER_URL_PREVIEW=wss://dev-preview.lw.iog.io
 CARDANO_WS_SERVER_URL_SANCHONET=wss://dev-sanchonet.lw.iog.io
 
+# Blockfrost
+BLOCKFROST_URL_MAINNET=https://cardano-mainnet.blockfrost.io
+BLOCKFROST_URL_PREPROD=https://cardano-preprod.blockfrost.io
+BLOCKFROST_URL_PREVIEW=https://cardano-preview.blockfrost.io
+BLOCKFROST_URL_SANCHONET=https://cardano-sanchonet.blockfrost.io
+
 # Explorer URLs
 CEXPLORER_URL_MAINNET=https://cexplorer.io
 CEXPLORER_URL_PREVIEW=https://preview.cexplorer.io

apps/browser-extension-wallet/.env.example

@@ -60,9 +60,9 @@ POSTHOG_PRODUCTION_TOKEN='production-token'
 POSTHOG_DEV_TOKEN='dev-token'
 
 # Cardano Services
-CARDANO_SERVICES_URL_MAINNET=https://backend.live-mainnet.eks.lw.iog.io
-CARDANO_SERVICES_URL_PREPROD=https://backend.live-preprod.eks.lw.iog.io
-CARDANO_SERVICES_URL_PREVIEW=https://backend.live-preview.eks.lw.iog.io
+CARDANO_SERVICES_URL_MAINNET=https://dev-mainnet.lw.iog.io
+CARDANO_SERVICES_URL_PREPROD=https://dev-preprod.lw.iog.io
+CARDANO_SERVICES_URL_PREVIEW=https://dev-preview.lw.iog.io
 CARDANO_SERVICES_URL_SANCHONET=https://dev-sanchonet.lw.iog.io
 
 # Cardano WS Services
@@ -71,6 +71,16 @@ CARDANO_WS_SERVER_URL_PREPROD=wss://dev-preprod.lw.iog.io
 CARDANO_WS_SERVER_URL_PREVIEW=wss://dev-preview.lw.iog.io
 CARDANO_WS_SERVER_URL_SANCHONET=wss://dev-sanchonet.lw.iog.io
 
+# Blockfrost
+BLOCKFROST_URL_MAINNET=https://cardano-mainnet.blockfrost.io
+BLOCKFROST_URL_PREPROD=https://cardano-preprod.blockfrost.io
+BLOCKFROST_URL_PREVIEW=https://cardano-preview.blockfrost.io
+BLOCKFROST_URL_SANCHONET=https://cardano-sanchonet.blockfrost.io
+BLOCKFROST_PROJECT_ID_MAINNET=mainnet...TODO
+BLOCKFROST_PROJECT_ID_PREPROD=preprod...TODO
+BLOCKFROST_PROJECT_ID_PREVIEW=preview...TODO
+BLOCKFROST_PROJECT_ID_SANCHONET=sanchonet...TODO
+
 # Explorer URLs
 CEXPLORER_URL_MAINNET=https://cexplorer.io
 CEXPLORER_URL_PREVIEW=https://preview.cexplorer.io

apps/browser-extension-wallet/manifest.json

@@ -19,7 +19,7 @@
   "permissions": ["webRequest", "storage", "tabs", "unlimitedStorage"],
   "host_permissions": ["<all_urls>"],
   "content_security_policy": {
-    "extension_pages": "default-src 'self' $LOCALHOST_DEFAULT_SRC; frame-src https://connect.trezor.io/ https://www.youtube-nocookie.com; script-src 'self' 'wasm-unsafe-eval' $LOCALHOST_SCRIPT_SRC; font-src 'self' https://use.typekit.net; object-src 'self'; connect-src $CARDANO_SERVICES_URLS $CARDANO_WS_SERVER_URLS https://coingecko.live-mainnet.eks.lw.iog.io https://muesliswap.live-mainnet.eks.lw.iog.io $LOCALHOST_CONNECT_SRC $POSTHOG_HOST https://use.typekit.net data:; style-src * 'unsafe-inline'; img-src * data:;"
+    "extension_pages": "default-src 'self' $LOCALHOST_DEFAULT_SRC; frame-src https://connect.trezor.io/ https://www.youtube-nocookie.com; script-src 'self' 'wasm-unsafe-eval' $LOCALHOST_SCRIPT_SRC; font-src 'self' https://use.typekit.net; object-src 'self'; connect-src $BLOCKFROST_URLS $CARDANO_SERVICES_URLS $CARDANO_WS_SERVER_URLS https://coingecko.live-mainnet.eks.lw.iog.io https://muesliswap.live-mainnet.eks.lw.iog.io $LOCALHOST_CONNECT_SRC $POSTHOG_HOST https://use.typekit.net data:; style-src * 'unsafe-inline'; img-src * data:;"
   },
   "content_scripts": [
     {

apps/browser-extension-wallet/package.json

@@ -67,6 +67,7 @@
     "bignumber.js": "9.0.1",
     "bip39": "^3.0.4",
     "blake2b-no-wasm": "2.1.4",
+    "bottleneck": "^2.19.5",
     "buffer": "6.0.3",
     "classnames": "2.3.1",
     "dayjs": "1.10.7",

apps/browser-extension-wallet/src/config.ts

@@ -1,9 +1,10 @@
 /* eslint-disable no-magic-numbers */
+import { Milliseconds } from '@cardano-sdk/core';
 import { Wallet } from '@lace/cardano';
 import { EnvironmentTypes } from '@stores';
 
-type CardanoServiceUrls = {
-  [key in Wallet.ChainName]: string;
+type ByNetwork<T> = {
+  [key in Wallet.ChainName]: T;
 };
 
 type CExplorerUrlPaths = {
@@ -18,7 +19,9 @@ export type Config = {
   MNEMONIC_LENGTH: number;
   WALLET_SYNC_TIMEOUT: number;
   WALLET_INTERVAL: number;
-  CARDANO_SERVICES_URLS: CardanoServiceUrls;
+  CARDANO_SERVICES_URLS: ByNetwork<string>;
+  BLOCKFROST_CONFIGS: ByNetwork<Wallet.BlockfrostClientConfig>;
+  BLOCKFROST_RATE_LIMIT_CONFIG: Wallet.RateLimiterConfig;
   ADA_PRICE_CHECK_INTERVAL: number;
   TOKEN_PRICE_CHECK_INTERVAL: number;
   AVAILABLE_CHAINS: Wallet.ChainName[];
@@ -33,7 +36,13 @@ const envChecks = (chosenChain: Wallet.ChainName): void => {
   if (
     !process.env.CARDANO_SERVICES_URL_MAINNET ||
     !process.env.CARDANO_SERVICES_URL_PREPROD ||
-    !process.env.CARDANO_SERVICES_URL_PREVIEW
+    !process.env.CARDANO_SERVICES_URL_PREVIEW ||
+    !process.env.BLOCKFROST_URL_MAINNET ||
+    !process.env.BLOCKFROST_URL_PREPROD ||
+    !process.env.BLOCKFROST_URL_PREVIEW ||
+    !process.env.BLOCKFROST_PROJECT_ID_MAINNET ||
+    !process.env.BLOCKFROST_PROJECT_ID_PREPROD ||
+    !process.env.BLOCKFROST_PROJECT_ID_PREVIEW
   ) {
     throw new Error('env vars not complete');
   }
@@ -55,6 +64,25 @@ const envChecks = (chosenChain: Wallet.ChainName): void => {
   }
 };
 
+const getBlockfrostConfigs = (): ByNetwork<Wallet.BlockfrostClientConfig> => ({
+  Mainnet: {
+    baseUrl: process.env.BLOCKFROST_URL_MAINNET,
+    projectId: process.env.BLOCKFROST_PROJECT_ID_MAINNET
+  },
+  Preprod: {
+    baseUrl: process.env.BLOCKFROST_URL_PREPROD,
+    projectId: process.env.BLOCKFROST_PROJECT_ID_PREPROD
+  },
+  Preview: {
+    baseUrl: process.env.BLOCKFROST_URL_PREVIEW,
+    projectId: process.env.BLOCKFROST_PROJECT_ID_PREVIEW
+  },
+  Sanchonet: {
+    baseUrl: process.env.BLOCKFROST_URL_SANCHONET,
+    projectId: process.env.BLOCKFROST_PROJECT_ID_SANCHONET
+  }
+});
+
 export const config = (): Config => {
   const chosenChain = (process.env.DEFAULT_CHAIN || 'Mainnet') as Wallet.ChainName;
   if (process.env.BUILD_DEV_PREVIEW !== 'true') envChecks(chosenChain);
@@ -76,6 +104,13 @@ export const config = (): Config => {
     TOKEN_PRICE_CHECK_INTERVAL: !Number.isNaN(Number(process.env.TOKEN_PRICE_POLLING_IN_SEC))
       ? Number(process.env.TOKEN_PRICE_POLLING_IN_SEC) * 1000
       : 300 * 1000,
+    BLOCKFROST_CONFIGS: getBlockfrostConfigs(),
+    BLOCKFROST_RATE_LIMIT_CONFIG: {
+      size: 500,
+      increaseAmount: 10,
+      // eslint-disable-next-line new-cap
+      increaseInterval: Milliseconds(1000)
+    },
     CARDANO_SERVICES_URLS: {
       Mainnet: process.env.CARDANO_SERVICES_URL_MAINNET,
       Preprod: process.env.CARDANO_SERVICES_URL_PREPROD,