Merge #3668

3668: [ADP-2272] remove cli options related to blockfrost mode r=paolino a=paolino - [x] remove launch mode for blockfrost backend - [x] remove launch specs for blockfrost backend - [x] remove documentation related to blockfrost use ### Issue Number ADP-2272 Co-authored-by: paolo veronelli <[email protected]>
cardano-foundation · Dec 20, 2022 · 8d2fd71 · 8d2fd71
2 parents 2c64a7d + 9d7ed84
commit 8d2fd71
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 235 deletions.
diff --git a/docs/user-guide/cli.md b/docs/user-guide/cli.md
@@ -109,8 +109,7 @@ Serve API that listens for commands/actions. Before launching user should start
 :::{.cli}
 ```
 Usage: cardano-wallet serve [--listen-address HOST] 
- (--node-socket FILE [--sync-tolerance DURATION] | 
- --light --blockfrost-token-file FILE) 
+ (--node-socket FILE [--sync-tolerance DURATION]) 
  [--random-port | --port INT] 
  [--tls-ca-cert FILE --tls-sv-cert FILE
  --tls-sv-key FILE] 
@@ -136,10 +135,6 @@ Available options:
  time duration within which we consider being synced
  with the network. Expressed in seconds with a
  trailing 's'. (default: 300s)
- --light Enable light mode
- --blockfrost-token-file FILE
- FILE contains an authentication token for BlockFrost
- Cardano API (https://blockfrost.io).
  --random-port serve wallet API on any available port (conflicts
  with --port)
  --port INT port used for serving the wallet API. (default: 8090)

diff --git a/docs/user-guide/common-use-cases/how-to-start-wallet-server.md b/docs/user-guide/common-use-cases/how-to-start-wallet-server.md
@@ -65,41 +65,3 @@ $ curl -X GET http://localhost:8090/v2/network/information | jq .sync_progress
  "status": "ready"
 }
 ```
-
-## Light mode
-
-> :warning: This mode is currently **under development**. Please note that some parts may not work.
-
-You can start your cardano-wallet server also in **light mode**. As opposed to full-node mode, in light-mode your wallet is not connected to a locally running instance of `cardano-node`. Instead it relays on external source of blockchain data. This significantly improves synchronization speed of the wallet and also removes the need to spend time synchronizing the node itself. The downside is that external source of data is obviously less trusted than the local one provided by your own `cardano-node` instance.
-
-> :information_source: Cardano-wallet currently supports only one external data provider - [Blockfrost](https://blockfrost.io/). Before using the light mode one needs to generate API key on Blockfrost page and save it into the file on the filesystem.
-
-#### Pre-requisites
-- Install cardano-wallet from [cardano wallet release page](https:/input-output-hk/cardano-wallet/releases).
-- Download up-to-date configuration files from [Cardano configurations](https://hydra.iohk.io/job/Cardano/iohk-nix/cardano-deployment/latest/download/1).
-
-#### Start `cardano-wallet` in light mode
-
-Let's suppose we have our API keys generated and saved in files as follows:
- - `blockfrost-testnet.key` - API key for `testnet`
- - `blockfrost-mainnet.key` - API key for `mainnet`
-
-Now we can start cardano-wallet server for testnet or mainnet:
-##### Testnet
-```
-$ cardano-wallet serve \
- --port 8091 \
- --light \
- --blockfrost-token-file blockfrost-testnet.key \
- --testnet byron-genesis.json \
- --database ./wallet-testnet-db-light \
-```
-##### Mainnet
-```
-$ cardano-wallet serve \
- --port 8092 \
- --light \
- --blockfrost-token-file blockfrost-mainnet.key \
- --mainnet \
- --database ./wallet-db-light \
-```
diff --git a/lib/wallet/api/http/Cardano/Wallet/Launch.hs b/lib/wallet/api/http/Cardano/Wallet/Launch.hs
@@ -102,7 +102,6 @@ import UnliftIO.Temporary
  ( withTempDirectory )
 
 import qualified Cardano.Wallet.Byron.Compatibility as Byron
-import qualified Cardano.Wallet.Launch.Blockfrost as Blockfrost
 import qualified Cardano.Wallet.Primitive.Types.ProtocolMagic as W
 import qualified Data.ByteString.Lazy.Char8 as BL8
 import qualified Data.Text as T
@@ -397,17 +396,11 @@ instance HasSeverityAnnotation TempDirLog where
  Mode
 -------------------------------------------------------------------------------}
 
-data Mode
- = Normal CardanoNodeConn SyncTolerance
- | Light Blockfrost.TokenFile
+data Mode = Normal CardanoNodeConn SyncTolerance
  deriving (Show)
 
 modeOption :: Parser Mode
-modeOption = normalMode <|> lightMode
+modeOption = normalMode
  where
  normalMode =
  Normal <$> nodeSocketOption <*> syncToleranceOption
- lightMode =
- flag' () (long "light" <> help "Enable light mode") *>
- fmap Light Blockfrost.tokenFileOption
-
diff --git a/lib/wallet/api/http/Cardano/Wallet/Launch/Blockfrost.hs b/lib/wallet/api/http/Cardano/Wallet/Launch/Blockfrost.hs
diff --git a/lib/wallet/cardano-wallet.cabal b/lib/wallet/cardano-wallet.cabal
@@ -479,7 +479,6 @@ library cardano-wallet-api-http
  Cardano.Wallet.Api.Types.SchemaMetadata
  Cardano.Wallet.Api.Types.Transaction
  Cardano.Wallet.Launch
- Cardano.Wallet.Launch.Blockfrost
  Cardano.Wallet.Launch.Cluster
  Cardano.Wallet.Shelley
  Cardano.Wallet.Tracers
@@ -867,7 +866,6 @@ test-suite unit
  Cardano.Wallet.RegistrySpec
  Cardano.Wallet.Shelley.Compatibility.LedgerSpec
  Cardano.Wallet.Shelley.CompatibilitySpec
- Cardano.Wallet.Shelley.Launch.BlockfrostSpec
  Cardano.Wallet.Shelley.LaunchSpec
  Cardano.Wallet.Shelley.MinimumUTxOSpec
  Cardano.Wallet.Shelley.Network.BlockfrostSpec

diff --git a/lib/wallet/exe/cardano-wallet.hs b/lib/wallet/exe/cardano-wallet.hs
@@ -78,7 +78,7 @@ import Cardano.Wallet.Api.Client
 import Cardano.Wallet.Api.Http.Shelley.Server
  ( HostPreference, Listen (..), TlsConfiguration )
 import Cardano.Wallet.Launch
- ( Mode (Light, Normal)
+ ( Mode (Normal)
  , NetworkConfiguration (..)
  , modeOption
  , networkConfigurationOption
@@ -143,10 +143,9 @@ import System.Environment
 import System.Exit
  ( ExitCode (..), exitWith )
 import UnliftIO.Exception
- ( catch, withException )
+ ( withException )
 
 import qualified Cardano.BM.Backend.EKGView as EKG
-import qualified Cardano.Wallet.Launch.Blockfrost as Blockfrost
 import qualified Cardano.Wallet.Version as V
 import qualified Data.Text as T
 import qualified System.Info as I
@@ -235,17 +234,6 @@ cmdServe = command "serve" $ info (helper <*> helper' <*> cmd) $
  blockchainSource <- case mode of
  Normal conn syncTolerance ->
  pure $ NodeSource conn vData syncTolerance
- Light token -> BlockfrostSource <$> Blockfrost.readToken token
- `catch` \case
- Blockfrost.BadTokenFile f -> do
- logError tr $ MsgBlockfrostTokenFileError f
- exitWith $ ExitFailure 1
- Blockfrost.EmptyToken f -> do
- logError tr $ MsgBlockfrostTokenError f
- exitWith $ ExitFailure 1
- Blockfrost.InvalidToken f -> do
- logError tr $ MsgBlockfrostTokenError f
- exitWith $ ExitFailure 1
 
  exitWith =<< serveWallet
  blockchainSource
@@ -285,8 +273,6 @@ data MainLog
  | MsgSigInt
  | MsgShutdownHandler ShutdownHandlerLog
  | MsgFailedToParseGenesis Text
- | MsgBlockfrostTokenFileError FilePath
- | MsgBlockfrostTokenError FilePath
  deriving (Show)
 
 instance ToText MainLog where
@@ -318,17 +304,6 @@ instance ToText MainLog where
  , "parameters."
  , "Here's (perhaps) some helpful hint:", hint
  ]
- MsgBlockfrostTokenFileError tokenFile -> T.unwords
- [ "File"
- , "'" <> T.pack tokenFile <> "'"
- , "specified in the --blockfrost-token-file can't be read."
- ]
- MsgBlockfrostTokenError tokenFile -> T.unwords
- [ "File"
- , "'" <> T.pack tokenFile <> "'"
- , "specified in the --blockfrost-token-file\
- \ argument doesn't contain a valid Blockfrost API token."
- ]
 
 withTracers
  :: LoggingOptions TracerSeverities

diff --git a/lib/wallet/test/unit/Cardano/Wallet/Shelley/Launch/BlockfrostSpec.hs b/lib/wallet/test/unit/Cardano/Wallet/Shelley/Launch/BlockfrostSpec.hs