-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7144 from HenrikJannsen/add-rest-api-module
Add rest api module
- Loading branch information
Showing
35 changed files
with
13,338 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Rest API node | ||
|
|
||
| Simple headless node with a Rest API to provide access to Bisq network data as well as Bisq DAO data. | ||
| It is used for Bisq 2 to request data about the DAO state as well as account age and account witness data for reputation use cases. | ||
|
|
||
|
|
||
| To run 'RestApiMain' you need to have Bitcoin node running and have 'blocknotify' in the `bitcoin.conf` set up. | ||
|
|
||
|
|
||
| ### Run Rest API node | ||
|
|
||
| Run the Gradle task: | ||
|
|
||
| ```sh | ||
| ./gradlew restapi:run | ||
| ``` | ||
|
|
||
| Or create a run scrip by: | ||
|
|
||
| ```sh | ||
| ./gradlew restapi:startBisqApp | ||
| ``` | ||
|
|
||
| And then run: | ||
|
|
||
| ```sh | ||
| ./bisq-restapi | ||
| ``` | ||
|
|
||
| ### Customize with program arguments | ||
|
|
||
| Example program arguments for running at localhost with Regtest: | ||
| ```sh | ||
| ./bisq-restapi \ | ||
| --baseCurrencyNetwork=BTC_REGTEST \ | ||
| --useDevPrivilegeKeys=true \ | ||
| --useLocalhostForP2P=true \ | ||
| --nodePort=3333 \ | ||
| --appName=bisq-BTC_REGTEST_restapi \ | ||
| --fullDaoNode=true \ | ||
| --rpcUser=[RPC USER] \ | ||
| --rpcPassword=[RPC PW] \ | ||
| --rpcPort=18443 \ | ||
| --rpcBlockNotificationPort=5123 | ||
| ``` | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| plugins { | ||
| id 'bisq.application' | ||
| id 'bisq.gradle.app_start_plugin.AppStartPlugin' | ||
| } | ||
|
|
||
| mainClassName = 'bisq.restapi.RestApiMain' | ||
|
|
||
| distTar.enabled = false | ||
|
|
||
| dependencies { | ||
| implementation project(':common') | ||
| implementation project(':p2p') | ||
| implementation project(':core') | ||
| annotationProcessor libs.lombok | ||
| compileOnly libs.lombok | ||
| implementation libs.slf4j.api | ||
| implementation(libs.google.guice) { | ||
| exclude(module: 'guava') | ||
| } | ||
|
|
||
| implementation libs.google.guava | ||
| implementation libs.google.guice | ||
|
|
||
| implementation libs.glassfish.jaxb | ||
| implementation libs.bundles.jersey.libs | ||
| implementation libs.swagger | ||
|
|
||
| implementation libs.logback.core | ||
| implementation libs.logback.classic | ||
| compileOnly libs.lombok | ||
| annotationProcessor libs.lombok | ||
| implementation libs.slf4j.api | ||
|
|
||
| testAnnotationProcessor libs.lombok | ||
| testCompileOnly libs.lombok | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| /* | ||
| * This file is part of Bisq. | ||
| * | ||
| * Bisq is free software: you can redistribute it and/or modify it | ||
| * under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or (at | ||
| * your option) any later version. | ||
| * | ||
| * Bisq is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public | ||
| * License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with Bisq. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package bisq.restapi; | ||
|
|
||
|
|
||
| import bisq.core.account.witness.AccountAgeWitnessService; | ||
| import bisq.core.app.TorSetup; | ||
| import bisq.core.app.misc.AppSetupWithP2PAndDAO; | ||
| import bisq.core.app.misc.ExecutableForAppWithP2p; | ||
| import bisq.core.app.misc.ModuleForAppWithP2p; | ||
| import bisq.core.dao.SignVerifyService; | ||
| import bisq.core.dao.governance.bond.reputation.BondedReputationRepository; | ||
| import bisq.core.dao.governance.bond.role.BondedRolesRepository; | ||
| import bisq.core.dao.state.DaoStateService; | ||
| import bisq.core.dao.state.DaoStateSnapshotService; | ||
| import bisq.core.user.Cookie; | ||
| import bisq.core.user.CookieKey; | ||
| import bisq.core.user.Preferences; | ||
| import bisq.core.user.User; | ||
|
|
||
| import bisq.network.p2p.P2PService; | ||
| import bisq.network.p2p.P2PServiceListener; | ||
| import bisq.network.p2p.peers.PeerManager; | ||
|
|
||
| import bisq.common.Timer; | ||
| import bisq.common.UserThread; | ||
| import bisq.common.app.AppModule; | ||
| import bisq.common.app.Version; | ||
| import bisq.common.config.BaseCurrencyNetwork; | ||
| import bisq.common.config.Config; | ||
| import bisq.common.handlers.ResultHandler; | ||
|
|
||
| import com.google.inject.Key; | ||
| import com.google.inject.name.Names; | ||
|
|
||
| import lombok.Getter; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| //todo not sure if the restart handling from seed nodes is required | ||
|
|
||
| @Slf4j | ||
| public class RestApi extends ExecutableForAppWithP2p { | ||
| private static final long CHECK_CONNECTION_LOSS_SEC = 30; | ||
|
|
||
| private Timer checkConnectionLossTime; | ||
| @Getter | ||
| private DaoStateService daoStateService; | ||
| @Getter | ||
| private BondedReputationRepository bondedReputationRepository; | ||
| @Getter | ||
| private AccountAgeWitnessService accountAgeWitnessService; | ||
| @Getter | ||
| private BondedRolesRepository bondedRolesRepository; | ||
| @Getter | ||
| private SignVerifyService signVerifyService; | ||
|
|
||
| public RestApi() { | ||
| super("Bisq Rest Api", "bisq_restapi", "bisq_restapi", Version.VERSION); | ||
| } | ||
|
|
||
| public Config getConfig() { | ||
| return config; | ||
| } | ||
|
|
||
| @Override | ||
| protected void doExecute() { | ||
| super.doExecute(); | ||
|
|
||
| checkMemory(config, this); | ||
| } | ||
|
|
||
| @Override | ||
| protected void launchApplication() { | ||
| UserThread.execute(() -> { | ||
| try { | ||
| onApplicationLaunched(); | ||
| } catch (Exception e) { | ||
| e.printStackTrace(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
|
|
||
| /////////////////////////////////////////////////////////////////////////////////////////// | ||
| // We continue with a series of synchronous execution tasks | ||
| /////////////////////////////////////////////////////////////////////////////////////////// | ||
|
|
||
| @Override | ||
| protected AppModule getModule() { | ||
| return new ModuleForAppWithP2p(config); | ||
| } | ||
|
|
||
| @Override | ||
| protected void applyInjector() { | ||
| super.applyInjector(); | ||
|
|
||
| injector.getInstance(DaoStateSnapshotService.class).setDaoRequiresRestartHandler(this::gracefulShutDown); | ||
| } | ||
|
|
||
| @Override | ||
| protected void startApplication() { | ||
| super.startApplication(); | ||
|
|
||
| Cookie cookie = injector.getInstance(User.class).getCookie(); | ||
| cookie.getAsOptionalBoolean(CookieKey.CLEAN_TOR_DIR_AT_RESTART).ifPresent(wasCleanTorDirSet -> { | ||
| if (wasCleanTorDirSet) { | ||
| injector.getInstance(TorSetup.class).cleanupTorFiles(() -> { | ||
| log.info("Tor directory reset"); | ||
| cookie.remove(CookieKey.CLEAN_TOR_DIR_AT_RESTART); | ||
| }, log::error); | ||
| } | ||
| }); | ||
|
|
||
| injector.getInstance(Preferences.class).setUseFullModeDaoMonitor(false); | ||
| injector.getInstance(AppSetupWithP2PAndDAO.class).start(); | ||
|
|
||
| daoStateService = injector.getInstance(DaoStateService.class); | ||
| accountAgeWitnessService = injector.getInstance(AccountAgeWitnessService.class); | ||
| bondedReputationRepository = injector.getInstance(BondedReputationRepository.class); | ||
| bondedRolesRepository = injector.getInstance(BondedRolesRepository.class); | ||
| signVerifyService = injector.getInstance(SignVerifyService.class); | ||
|
|
||
| injector.getInstance(P2PService.class).addP2PServiceListener(new P2PServiceListener() { | ||
| @Override | ||
| public void onDataReceived() { | ||
| // Do nothing | ||
| } | ||
|
|
||
| @Override | ||
| public void onNoSeedNodeAvailable() { | ||
| // Do nothing | ||
| } | ||
|
|
||
| @Override | ||
| public void onNoPeersAvailable() { | ||
| // Do nothing | ||
| } | ||
|
|
||
| @Override | ||
| public void onUpdatedDataReceived() { | ||
| // Do nothing | ||
| } | ||
|
|
||
| @Override | ||
| public void onTorNodeReady() { | ||
| // Do nothing | ||
| } | ||
|
|
||
| @Override | ||
| public void onHiddenServicePublished() { | ||
| boolean preventPeriodicShutdownAtSeedNode = injector.getInstance(Key.get(boolean.class, | ||
| Names.named(Config.PREVENT_PERIODIC_SHUTDOWN_AT_SEED_NODE))); | ||
| if (!preventPeriodicShutdownAtSeedNode) { | ||
| startShutDownInterval(RestApi.this); | ||
| } | ||
| UserThread.runAfter(() -> setupConnectionLossCheck(), 60); | ||
|
|
||
| accountAgeWitnessService.onAllServicesInitialized(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onSetupFailed(Throwable throwable) { | ||
| // Do nothing | ||
| } | ||
|
|
||
| @Override | ||
| public void onRequestCustomBridges() { | ||
| // Do nothing | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| private void setupConnectionLossCheck() { | ||
| // For dev testing (usually on BTC_REGTEST) we don't want to get the seed shut | ||
| // down as it is normal that the seed is the only actively running node. | ||
| if (Config.baseCurrencyNetwork() == BaseCurrencyNetwork.BTC_REGTEST) { | ||
| return; | ||
| } | ||
|
|
||
| if (checkConnectionLossTime != null) { | ||
| return; | ||
| } | ||
|
|
||
| checkConnectionLossTime = UserThread.runPeriodically(() -> { | ||
| if (injector.getInstance(PeerManager.class).getNumAllConnectionsLostEvents() > 1) { | ||
| // We set a flag to clear tor cache files at re-start. We cannot clear it now as Tor is used and | ||
| // that can cause problems. | ||
| injector.getInstance(User.class).getCookie().putAsBoolean(CookieKey.CLEAN_TOR_DIR_AT_RESTART, true); | ||
| shutDown(this); | ||
| } | ||
| }, CHECK_CONNECTION_LOSS_SEC); | ||
|
|
||
| } | ||
|
|
||
| public void gracefulShutDown() { | ||
| gracefulShutDown(() -> { | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public void gracefulShutDown(ResultHandler resultHandler) { | ||
| super.gracefulShutDown(resultHandler); | ||
| } | ||
| } |
Oops, something went wrong.