├── .github └── workflows │ └── build-push-ui.yml ├── README.md ├── docker-compose.dev.yml ├── postgres └── Dockerfile ├── signer ├── Dockerfile └── web3signer-entrypoint.sh └── ui ├── .dockerignore ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── images ├── README.md ├── delete.png ├── delete_complete.png ├── import.png ├── import_duplicate.png ├── import_error.png ├── list.png └── list_selection.png ├── package-lock.json ├── package.json ├── public ├── assets │ └── dappnode_logo.png ├── index.html ├── manifest.json └── robots.txt ├── src ├── App.test.tsx ├── App.tsx ├── ImportScreen.tsx ├── Styles │ ├── Typographies.tsx │ ├── buttonsBoxStyles.ts │ ├── dialogStyles.ts │ ├── fileDropStyles.ts │ └── listStyles.ts ├── Themes │ └── globalThemes.ts ├── apis │ ├── beaconchaApi │ │ ├── buildValidatorSummaryURL.ts │ │ ├── index.ts │ │ └── types.ts │ ├── standardApi │ │ └── index.ts │ └── web3signerApi │ │ ├── index.ts │ │ └── types.ts ├── components │ ├── ButtonsBox │ │ └── ButtonsBox.tsx │ ├── ClientsBox │ │ └── ClientsBox.tsx │ ├── Dialogs │ │ ├── DeletionWarning.tsx │ │ ├── ImportDialog.tsx │ │ └── KeystoresDeleteDialog.tsx │ ├── FileCards │ │ ├── FileCardList.css │ │ └── FileCardList.tsx │ ├── FileDrop │ │ └── FileDrop.tsx │ ├── KeystoreList │ │ ├── KeystoreColumns.tsx │ │ └── KeystoreList.tsx │ ├── TopBar │ │ ├── ToolBar.tsx │ │ └── TopBar.tsx │ ├── ValidatorList │ │ └── ValidatorList.tsx │ └── WaitBox │ │ └── WaitBox.tsx ├── env.ts ├── index.css ├── index.tsx ├── logic │ ├── ImportScreen │ │ └── PasswordManager.ts │ └── Utils │ │ ├── beaconchaUtils.ts │ │ ├── dataUtils.ts │ │ └── getParams.ts ├── params.ts ├── react-app-env.d.ts ├── reportWebVitals.ts ├── setupTests.ts ├── tests │ └── beaconchaApi │ │ ├── networkTestMap.ts │ │ ├── testBuildSummaryURL.ts │ │ └── testFetchValidatorIndex.ts └── types.ts ├── tsconfig.json └── yarn.lock /.github/workflows/build-push-ui.yml: -------------------------------------------------------------------------------- 1 | name: Build and push services images to GHCR 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | version: 7 | description: "KeyManagerUI version" 8 | required: true 9 | 10 | jobs: 11 | push-to-ghcr: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v3 16 | 17 | - name: Login to GHCR 18 | uses: docker/login-action@v2 19 | with: 20 | registry: ghcr.io 21 | username: ${{ github.repository_owner }} 22 | password: ${{ secrets.GITHUB_TOKEN }} 23 | 24 | - name: Build and push KeyManager UI 25 | uses: docker/build-push-action@v3 26 | with: 27 | context: "./ui" 28 | file: ./ui/Dockerfile 29 | push: true 30 | tags: ghcr.io/${{ github.repository_owner }}/keymanager-ui:${{ github.event.inputs.version }} 31 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Eth2 keymanager UI 2 | 3 | ### Develop 4 | 5 | 1. Run a standalone frontend with a real signer and db with 6 | 7 | ``` 8 | docker-compose build && docker-compose up 9 | ``` 10 | 11 | 2. Run only the keymanager frontend while connected to the DAppNode and using the dappnode package web3signer of any network 12 | 13 | ``` 14 | cd ui 15 | yarn 16 | yarn start 17 | ``` 18 | 19 | go to `http://localhost:3000/` 20 | 21 | By default, the selected network is mainnet, but you can change it through the URL params, as well as other params: 22 | 23 | - network 24 | - signerUrl 25 | - signerAuthToken 26 | - consensusClient 27 | - executionClient 28 | 29 | You can change the signerUrl or the network by adding URL params: 30 | `http://localhost:3000/?network=&signerUrl=&signerAuthToken=...` 31 | 32 | If you are connected to a DAppNode (example for prater): 33 | `http://localhost:3000/?signerUrl=http://web3signer.web3signer-prater.dappnode:9000&network=prater` 34 | 35 | ### Using the UI image 36 | 37 | The image corresponding to this UI has already been built and pushed to GitHub Container Registry (https://github.com/dappnode/eth2-keymanager-frontend/pkgs/container/keymanager-ui) 38 | 39 | In order to run a container for the UI, there are 5 env variables to be set (only 2 mandatory): 40 | 41 | - NETWORK= prater | gnosis | mainnet 42 | - WEB3SIGNER_API_URL 43 | - [ WEB3SIGNER_AUTH_TOKEN ] 44 | - [ CONSENSUS_CLIENT ] 45 | - [ EXECUTION_CLIENT ] 46 | 47 | However, you can override this values with the URL params mentioned above. 48 | 49 | For example, if you are connected to a DAppNode and you want to run the KeyManager for prater, you can run the UI by having this 3 files: 50 | 51 | .env: 52 | 53 | ``` 54 | NETWORK=prater 55 | WEB3SIGNER_API_URL=http://web3signer.web3signer-prater.dappnode:9000/ 56 | CONSENSUS_CLIENT=$_DAPPNODE_GLOBAL_CONSENSUS_CLIENT_PRATER 57 | EXECUTION_CLIENT=$_DAPPNODE_GLOBAL_EXECUTION_CLIENT_PRATER 58 | ``` 59 | 60 | Dockerfile: 61 | 62 | ``` 63 | FROM ghcr.io/dappnode/keymanager-ui:0.1.1 as build 64 | 65 | FROM nginx:1.21.6-alpine 66 | 67 | # Static build 68 | COPY --from=build /app/build /usr/share/nginx/html/ 69 | 70 | # Default port exposure 71 | EXPOSE 80 72 | 73 | # Copy .env file and shell script to container 74 | WORKDIR /usr/share/nginx/html 75 | COPY ./env.sh . 76 | COPY .env . 77 | 78 | # Add bash 79 | RUN apk add --no-cache bash 80 | 81 | # Make our shell script executable 82 | RUN chmod +x env.sh 83 | 84 | # Start Nginx server 85 | CMD ["/bin/bash", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""] 86 | ``` 87 | 88 | env.sh: 89 | 90 | ``` 91 | #!/bin/bash 92 | 93 | # Recreate config file 94 | rm -rf ./env-config.js 95 | touch ./env-config.js 96 | 97 | # Add assignment 98 | echo "window.env = {" >> ./env-config.js 99 | 100 | # Read each line in .env file 101 | # Each line represents key=value pairs 102 | while read -r line || [[ -n "$line" ]]; 103 | do 104 | # Split env variables by character `=` 105 | if printf '%s\n' "$line" | grep -q -e '='; then 106 | varname=$(printf '%s\n' "$line" | sed -e 's/=.*//') 107 | varvalue=$(printf '%s\n' "$line" | sed -e 's/^[^=]*=//') 108 | fi 109 | 110 | #If varvalue starts with $, then it is a reference to another env variable. Set varvalue to the value of that env variable 111 | if [[ $varvalue == \$* ]]; then 112 | varvalue="${varvalue:1}" 113 | varvalue=${!varvalue} 114 | fi 115 | 116 | # Read value of current variable if exists as Environment variable 117 | value=$(printf '%s\n' "${!varname}") 118 | # Otherwise use value from .env file 119 | [[ -z $value ]] && value=${varvalue} 120 | 121 | # Append configuration property to JS file 122 | echo " $varname: \"$value\"," >> ./env-config.js 123 | done < .env 124 | 125 | echo "}" >> ./env-config.js 126 | ``` 127 | 128 | As it is possible to add the params through the URL, you can create an image for it with just 1 file: 129 | 130 | Dockerfile: 131 | 132 | ``` 133 | FROM ghcr.io/dappnode/keymanager-ui:0.1.1 as build 134 | 135 | FROM nginx:1.21.6-alpine 136 | COPY --from=build /app/build/ /usr/share/nginx/html/ 137 | EXPOSE 80 138 | ``` 139 | -------------------------------------------------------------------------------- /docker-compose.dev.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | services: 3 | web3signer: 4 | build: 5 | context: signer 6 | environment: 7 | NETWORK: "prater" 8 | PGPASSWORD: "password" 9 | POSTGRES_PASSWORD: "password" 10 | POSTGRES_USER: "postgres" 11 | POSTGRES_DB: "web3signer" 12 | security_opt: 13 | - "seccomp:unconfined" 14 | depends_on: 15 | - postgres 16 | networks: 17 | keymanager_frontend: 18 | aliases: 19 | - web3signer.web3signer-prater.dappnode 20 | postgres: 21 | build: 22 | context: postgres 23 | environment: 24 | NETWORK: "prater" 25 | PGPASSWORD: "password" 26 | POSTGRES_PASSWORD: "password" 27 | POSTGRES_USER: "postgres" 28 | POSTGRES_DB: "web3signer" 29 | networks: 30 | keymanager_frontend: 31 | aliases: 32 | - postgres.web3signer-prater.dappnode 33 | ui: 34 | build: 35 | context: ui 36 | networks: 37 | keymanager_frontend: 38 | aliases: 39 | - ui.web3signer-prater.dappnode 40 | 41 | networks: 42 | keymanager_frontend: 43 | name: keymanager_frontend 44 | -------------------------------------------------------------------------------- /postgres/Dockerfile: -------------------------------------------------------------------------------- 1 | ARG WEB3SIGNER_VERSION 2 | 3 | ############## 4 | # MIGRATIONS # 5 | ############## 6 | FROM debian:bullseye-slim as postgres-migrations 7 | WORKDIR /usr/src/app 8 | RUN apt update && apt install -y wget 9 | # Get migrations from consensys web3signer repo 10 | # path is /usr/src/app/web3signer-21.10.0/slashing-protection/src/main/resources/migrations/postgresql 11 | RUN wget -q https://github.com/ConsenSys/web3signer/archive/refs/tags/22.8.1.tar.gz && \ 12 | tar -xvf 22.8.1.tar.gz 13 | 14 | ############ 15 | # POSTGRES # 16 | ############ 17 | FROM postgres:14.1-bullseye 18 | RUN apt update && apt install -y rename 19 | 20 | COPY --from=postgres-migrations /usr/src/app/web3signer-22.8.1/slashing-protection/src/main/resources/migrations/postgresql/* /docker-entrypoint-initdb.d/ 21 | # Rename scripts to be executed in alfabetical order 22 | RUN rename 's/(\d+)(?=.*\.)/sprintf("%03d",$1)/eg' /docker-entrypoint-initdb.d/* 23 | 24 | CMD ["postgres"] -------------------------------------------------------------------------------- /signer/Dockerfile: -------------------------------------------------------------------------------- 1 | 2 | 3 | FROM consensys/web3signer:22.8.1 4 | 5 | USER root 6 | 7 | COPY web3signer-entrypoint.sh /usr/local/bin/web3signer-entrypoint.sh 8 | 9 | ENTRYPOINT ["web3signer-entrypoint.sh"] 10 | 11 | EXPOSE 9000 -------------------------------------------------------------------------------- /signer/web3signer-entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | KEYSTORES_DIR=/opt/web3signer/keyfiles 4 | 5 | mkdir -p "${KEYSTORES_DIR}" 6 | # Wait for db 7 | sleep 5 8 | 9 | /opt/web3signer/bin/web3signer \ 10 | --key-store-path=${KEYSTORES_DIR} \ 11 | --http-listen-port=9000 \ 12 | --http-listen-host=0.0.0.0 \ 13 | --http-host-allowlist=* \ 14 | --http-cors-origins=* \ 15 | --metrics-enabled=true \ 16 | --metrics-host 0.0.0.0 \ 17 | --metrics-port 9091 \ 18 | --metrics-host-allowlist=* \ 19 | --idle-connection-timeout-seconds=90 \ 20 | eth2 \ 21 | --network=${NETWORK} \ 22 | --slashing-protection-db-url=jdbc:postgresql://postgres.web3signer-${NETWORK}.dappnode:5432/web3signer \ 23 | --slashing-protection-db-username=postgres \ 24 | --slashing-protection-db-password=password \ 25 | --key-manager-api-enabled=true 26 | -------------------------------------------------------------------------------- /ui/.dockerignore: -------------------------------------------------------------------------------- 1 | README.md 2 | LICENSE 3 | node_modules 4 | build 5 | .gitignore -------------------------------------------------------------------------------- /ui/.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | 11 | # production 12 | /build 13 | 14 | # misc 15 | .DS_Store 16 | .env.local 17 | .env.development.local 18 | .env.test.local 19 | .env.production.local 20 | 21 | npm-debug.log* 22 | yarn-debug.log* 23 | yarn-error.log* 24 | -------------------------------------------------------------------------------- /ui/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:16-alpine as build 2 | 3 | WORKDIR /app 4 | 5 | COPY package.json yarn.lock ./ 6 | 7 | RUN yarn install 8 | COPY . . 9 | #ENV REACT_APP_NETWORK=prater REACT_APP_WEB3SIGNER_API_URL=http://web3signer.web3signer-prater.dappnode:9000/ 10 | RUN yarn build 11 | #RUN npx react-inject-env set 12 | 13 | #FROM nginx:1.21.6-alpine 14 | #COPY --from=build /app/build/ /usr/share/nginx/html/ 15 | #EXPOSE 80 -------------------------------------------------------------------------------- /ui/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /ui/README.md: -------------------------------------------------------------------------------- 1 | # ETH2 Key Manager Frontend 2 | 3 | This is a simple react app to manage your ETH2 validator keystores. It allows to: 4 | 5 | - view your current active keys being used for signing 6 | - import new keystores and existing slashing protection data 7 | - remove active keys and download the associated slashing protection data 8 | 9 | ![Demo](images/list.png?raw=true "List of active keys") 10 | 11 | [See more screenshots](images) 12 | 13 | ## Prerequisites 14 | 15 | Install `yarn` on your system. See installation instructions [here](https://classic.yarnpkg.com/lang/en/docs/install/). 16 | 17 | Once `yarn` is installed, from the project directory, run: 18 | 19 | `yarn install` 20 | 21 | ## Running 22 | 23 | Requires a running signer instance like a ETH2 validator client or a [web3signer](https://github.com/ConsenSys/web3signer) instance. 24 | 25 | With the signer running at a given URL, in the project directory, run: 26 | 27 | `yarn start` 28 | 29 | Then open [http://localhost:3000?baseUrl=&authToken=&network=](http://localhost:3000) to view it in the browser. 30 | 31 | - `baseUrl` - The url of the signer to send API requests to 32 | - `authToken` - Optional auth token to pass in API requests 33 | - `host` - Optional host header to be used in web3signer requests 34 | - `network` - Optional network, possible values are: prater, mainnet and gnosis 35 | 36 | ## Developing 37 | 38 | 1. Install the dependencies: `yarn` 39 | 2. Build with `yarn run build` 40 | 3. Run the website with `yarn start` 41 | 4. Go to http://localhost:3000 42 | -------------------------------------------------------------------------------- /ui/images/README.md: -------------------------------------------------------------------------------- 1 | # ETH2 Key Manager Frontend - Screenshots 2 | 3 | ## List of active keys 4 | 5 | ![Demo](list.png?raw=true "List of active keys") 6 | 7 | ## Import flow 8 | 9 | ![Demo](import.png?raw=true) 10 | 11 | ![Demo](import_error.png?raw=true "import error") 12 | 13 | ![Demo](import_duplicate.png?raw=true "import duplicate") 14 | 15 | ## Delete flow 16 | 17 | ![Demo](list_selection.png?raw=true) 18 | 19 | ![Demo](delete.png?raw=true "delete") 20 | 21 | ![Demo](delete_complete.png?raw=true "delete complete") 22 | -------------------------------------------------------------------------------- /ui/images/delete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/delete.png -------------------------------------------------------------------------------- /ui/images/delete_complete.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/delete_complete.png -------------------------------------------------------------------------------- /ui/images/import.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/import.png -------------------------------------------------------------------------------- /ui/images/import_duplicate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/import_duplicate.png -------------------------------------------------------------------------------- /ui/images/import_error.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/import_error.png -------------------------------------------------------------------------------- /ui/images/list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/list.png -------------------------------------------------------------------------------- /ui/images/list_selection.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/images/list_selection.png -------------------------------------------------------------------------------- /ui/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "eth2-keymanager-frontend", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "@babel/core": "^7.0.0", 7 | "@emotion/react": "^11.7.0", 8 | "@emotion/styled": "^11.6.0", 9 | "@mui/icons-material": "^5.2.4", 10 | "@mui/material": "^5.2.3", 11 | "@mui/system": "^5.4.1", 12 | "@mui/x-data-grid": "^5.1.0", 13 | "@testing-library/dom": "^8.19.0", 14 | "@testing-library/jest-dom": "^5.11.4", 15 | "@testing-library/react": "^11.1.0", 16 | "@testing-library/user-event": "^12.1.10", 17 | "@types/jest": "^26.0.15", 18 | "@types/node": "^12.0.0", 19 | "@types/react": "^17.0.0", 20 | "@types/react-dom": "^17.0.0", 21 | "history": "5", 22 | "react": "^17.0.2", 23 | "react-dom": "^17.0.2", 24 | "react-dropzone": "^11.4.2", 25 | "react-router-dom": "6", 26 | "react-scripts": "4.0.3", 27 | "typescript": "^4.1.2", 28 | "web-vitals": "^1.0.1" 29 | }, 30 | "scripts": { 31 | "start": "react-scripts start", 32 | "build": "react-scripts build", 33 | "eject": "react-scripts eject", 34 | "test": "env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha -r ts-node/register 'src/tests/*/*.ts'" 35 | }, 36 | "eslintConfig": { 37 | "extends": [ 38 | "react-app", 39 | "react-app/jest" 40 | ] 41 | }, 42 | "browserslist": { 43 | "production": [ 44 | ">0.2%", 45 | "not dead", 46 | "not op_mini all" 47 | ], 48 | "development": [ 49 | "last 1 chrome version", 50 | "last 1 firefox version", 51 | "last 1 safari version" 52 | ] 53 | }, 54 | "devDependencies": { 55 | "@types/chai": "^4.3.3", 56 | "@types/mocha": "^9.1.1", 57 | "chai": "^4.3.6", 58 | "mocha": "^10.0.0", 59 | "ts-node": "^10.9.1" 60 | } 61 | } 62 | -------------------------------------------------------------------------------- /ui/public/assets/dappnode_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dappnode/eth2-keymanager-frontend/4e025eb62b2c72aba545e3e44b48106690408b9c/ui/public/assets/dappnode_logo.png -------------------------------------------------------------------------------- /ui/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 12 | 13 | 17 | 18 | 27 | Key Manager UI 28 | 29 | 30 | 31 | 32 |
33 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /ui/public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /ui/public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /ui/src/App.test.tsx: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import { render, screen } from "@testing-library/react"; 3 | import App from "./App"; 4 | 5 | test("renders learn react link", () => { 6 | render(); 7 | const linkElement = screen.getByText(/learn react/i); 8 | expect(linkElement).toBeInTheDocument(); 9 | }); 10 | -------------------------------------------------------------------------------- /ui/src/App.tsx: -------------------------------------------------------------------------------- 1 | //External components 2 | import { ThemeProvider } from "@mui/material/styles"; 3 | import { Container, Alert } from "@mui/material"; 4 | 5 | //Internal components 6 | import TopBar from "./components/TopBar/TopBar"; 7 | import ImportScreen from "./ImportScreen"; 8 | import ValidatorList from "./components/ValidatorList/ValidatorList"; 9 | import ClientsBox from "./components/ClientsBox/ClientsBox"; 10 | 11 | //Themes 12 | import { darkTheme } from "./Themes/globalThemes"; 13 | 14 | //Logic 15 | import { getParams } from "./logic/Utils/getParams"; 16 | import { Web3SignerApi } from "./apis/web3signerApi"; 17 | import { Web3SignerStatus } from "./types"; 18 | 19 | //Other libraries 20 | import { BrowserRouter, Route, Routes } from "react-router-dom"; 21 | import React, { useEffect } from "react"; 22 | 23 | function App() { 24 | const [currentNetwork, setCurrentNetwork] = React.useState(""); 25 | const [web3signerApi, setWeb3signerApi] = 26 | React.useState(null); 27 | const [signerStatus, setSignerStatus] = 28 | React.useState("LOADING"); 29 | 30 | const { 31 | network, 32 | signerAuthToken, 33 | signerUrl, 34 | consensusClient, 35 | executionClient, 36 | } = getParams(); 37 | 38 | useEffect(() => { 39 | setCurrentNetwork(network); 40 | if (signerUrl) { 41 | setWeb3signerApi( 42 | new Web3SignerApi({ 43 | baseUrl: signerUrl, 44 | authToken: signerAuthToken, 45 | }) 46 | ); 47 | } else { 48 | setSignerStatus("ERROR"); 49 | } 50 | // eslint-disable-next-line react-hooks/exhaustive-deps 51 | }, []); 52 | 53 | const showSignerStatus = async () => { 54 | if (web3signerApi) { 55 | const status = (await web3signerApi.getStatus())?.status; 56 | setSignerStatus(status || "ERROR"); 57 | } 58 | }; 59 | 60 | useEffect(() => { 61 | showSignerStatus(); 62 | // eslint-disable-next-line react-hooks/exhaustive-deps 63 | }, [web3signerApi]); 64 | 65 | return ( 66 | 67 | 68 | 69 | {web3signerApi && signerStatus === "UP" && currentNetwork ? ( 70 | 71 | 72 | 76 | 80 | {consensusClient && executionClient && ( 81 | 89 | )} 90 | 91 | } 92 | /> 93 | } 96 | /> 97 | 98 | 99 | ) : ( 100 | <> 101 | {signerStatus === "ERROR" ? ( 102 | 103 | Web3Signer API is not available. Check URL or global variables. 104 | Is the Web3Signer API running? 105 | 106 | ) : ( 107 | signerStatus === "DOWN" && ( 108 | 109 | Web3Signer is down. 110 | 111 | ) 112 | )} 113 | {!currentNetwork && ( 114 | 115 | Network has not been properly set. Check URL or global 116 | variables. 117 | 118 | )} 119 | 120 | )} 121 | 122 | 123 | ); 124 | } 125 | 126 | export default App; 127 | -------------------------------------------------------------------------------- /ui/src/ImportScreen.tsx: -------------------------------------------------------------------------------- 1 | //Internal components 2 | import FileDrop from "./components/FileDrop/FileDrop"; 3 | import { SecondaryInfoTypography } from "./Styles/Typographies"; 4 | 5 | //External components 6 | import { 7 | Box, 8 | Button, 9 | Card, 10 | Switch, 11 | TextField, 12 | Typography, 13 | FormGroup, 14 | FormControlLabel, 15 | } from "@mui/material"; 16 | 17 | //React 18 | import { Link } from "react-router-dom"; 19 | import { DropEvent } from "react-dropzone"; 20 | import { useState } from "react"; 21 | 22 | //Icons 23 | import BackupIcon from "@mui/icons-material/Backup"; 24 | 25 | //Logic 26 | import { setUniquePassword } from "./logic/ImportScreen/PasswordManager"; 27 | import { extractPubkey } from "./logic/Utils/dataUtils"; 28 | import { ImportStatus, KeystoreInfo } from "./types"; 29 | import { Web3SignerApi } from "./apis/web3signerApi"; 30 | import { Web3signerPostResponse } from "./apis/web3signerApi/types"; 31 | import FileCardList from "./components/FileCards/FileCardList"; 32 | import ImportDialog from "./components/Dialogs/ImportDialog"; 33 | import { 34 | importButtonBoxStyle, 35 | mainImportBoxStyle, 36 | slashingProtectionBoxStyle, 37 | } from "./Styles/dialogStyles"; 38 | 39 | export default function ImportScreen({ 40 | web3signerApi, 41 | }: { 42 | web3signerApi: Web3SignerApi; 43 | }) { 44 | const [keystoresPostResponse, setKeystoresPostResponse] = 45 | useState(); 46 | const [openDialog, setOpenDialog] = useState(false); 47 | const [acceptedFiles, setAcceptedFiles] = useState([]); 48 | const [passwords, setPasswords] = useState([]); 49 | const [importStatus, setImportStatus] = useState(ImportStatus.NotImported); 50 | 51 | const keystoreFilesCallback = async (files: File[], event: DropEvent) => { 52 | const keystoresToAdd: KeystoreInfo[] = []; 53 | const passwordsToAdd: string[] = []; 54 | for (var file of files) { 55 | const pubkey = await extractPubkey(file); 56 | if (pubkey) { 57 | if (acceptedFiles.some((e) => e.pubkey === pubkey) === false) { 58 | keystoresToAdd.push({ file: file, pubkey: pubkey }); 59 | passwordsToAdd.push(""); 60 | } 61 | } 62 | } 63 | setAcceptedFiles([...acceptedFiles].concat(keystoresToAdd)); 64 | setPasswords([...passwords].concat(passwordsToAdd)); 65 | }; 66 | 67 | const [slashingFile, setSlashingFile] = useState(); 68 | const slashingFilesCallback = (files: File[], event: DropEvent) => { 69 | setSlashingFile(files[0]); 70 | }; 71 | 72 | //USE SAME PASSWORD SWITCH 73 | const [useSamePassword, setUseSamePassword] = useState(false); //Same password for all keystores 74 | const handleUseSamePasswordSwitch = ( 75 | event: React.ChangeEvent, 76 | checked: boolean 77 | ) => { 78 | setUseSamePassword(checked); 79 | const emptyPasswords = Array.from(passwords); 80 | emptyPasswords.fill(""); 81 | setPasswords(emptyPasswords); 82 | }; 83 | 84 | // SLASHING PROTECTION SWITCH 85 | const [slashingProtectionIncluded, setSlashingProtectionIncluded] = 86 | useState(true); 87 | const onSlashingChecked = ( 88 | event: React.ChangeEvent, 89 | checked: boolean 90 | ) => { 91 | setSlashingProtectionIncluded(checked); 92 | }; 93 | 94 | const handleClickOpenDialog = () => { 95 | setOpenDialog(true); 96 | }; 97 | 98 | return ( 99 |
100 | 101 | 107 | 113 | Import Validator Keystore(s) 114 | 115 | Upload any keystore JSON file(s). 116 | 117 | 123 | 124 | 125 | 130 | 131 | {acceptedFiles.length > 0 && ( 132 | <> 133 | 134 | } 136 | label="Use same password for every file" 137 | /> 138 | 139 | {useSamePassword && ( 140 | 145 | setUniquePassword(event, passwords, setPasswords) 146 | } 147 | sx={{ marginTop: 2, width: "60%" }} 148 | /> 149 | )} 150 | 151 | )} 152 | 153 | {FileCardList( 154 | acceptedFiles, 155 | setAcceptedFiles, 156 | passwords, 157 | setPasswords, 158 | useSamePassword 159 | )} 160 | 161 | 162 | 163 | Import slashing protection data? (recommended) 164 | 165 | 166 | 167 | {slashingProtectionIncluded ? ( 168 |
169 | 170 | Upload your slashing protection file to protect your 171 | keystore(s). 172 | 173 | 174 | 178 | 179 | {slashingFile ? ( 180 | 190 | 191 | ✅ {slashingFile.name} 192 |
193 | 194 | 195 | ) : null} 196 |
197 | ) : null} 198 | 199 | 200 | 201 | 228 | 229 | 237 | 238 | 239 | 240 | 247 |
248 | ); 249 | } 250 | -------------------------------------------------------------------------------- /ui/src/Styles/Typographies.tsx: -------------------------------------------------------------------------------- 1 | import { SxProps } from "@mui/material"; 2 | import Typography from "@mui/material/Typography"; 3 | 4 | export function HeaderTypography({ 5 | text, 6 | sx, 7 | }: { 8 | text: string; 9 | sx?: SxProps; 10 | }): JSX.Element { 11 | return ( 12 | 13 | {text} 14 | 15 | ); 16 | } 17 | 18 | export function SecondaryInfoTypography({ 19 | text, 20 | sx, 21 | }: { 22 | text: string; 23 | sx?: SxProps; 24 | }): JSX.Element { 25 | return ( 26 | 27 | {text} 28 | 29 | ); 30 | } 31 | -------------------------------------------------------------------------------- /ui/src/Styles/buttonsBoxStyles.ts: -------------------------------------------------------------------------------- 1 | export const buttonsBoxStyle = { 2 | marginTop: 4, 3 | display: "flex", 4 | flexDirection: "row-reverse", 5 | alignContent: "end", 6 | alignItems: "end", 7 | width: "100%", 8 | }; 9 | -------------------------------------------------------------------------------- /ui/src/Styles/dialogStyles.ts: -------------------------------------------------------------------------------- 1 | export const waitDialogBoxStyle = { 2 | margin: 8, 3 | display: "flex", 4 | flexDirection: "column", 5 | alignItems: "center", 6 | }; 7 | 8 | export const importDialogBoxStyle = { 9 | marginTop: 2, 10 | display: "flex", 11 | flexDirection: "column", 12 | alignItems: "left", 13 | }; 14 | 15 | export const mainImportBoxStyle = { 16 | margin: 8, 17 | display: "flex", 18 | flexDirection: "column", 19 | alignItems: "left", 20 | }; 21 | 22 | export const slashingProtectionBoxStyle = { 23 | marginTop: 8, 24 | marginBottom: 2, 25 | display: "flex", 26 | flexDirection: "row", 27 | alignItems: "left", 28 | }; 29 | 30 | export const importButtonBoxStyle = { 31 | marginTop: 4, 32 | display: "flex", 33 | flexDirection: "row-reverse", 34 | alignContent: "end", 35 | alignItems: "end", 36 | width: "100%", 37 | }; 38 | -------------------------------------------------------------------------------- /ui/src/Styles/fileDropStyles.ts: -------------------------------------------------------------------------------- 1 | export const baseStyle = { 2 | flex: 1, 3 | display: "flex", 4 | flexDirection: "column" as "column", 5 | alignItems: "center", 6 | padding: "20px", 7 | borderWidth: 2, 8 | borderRadius: 3, 9 | borderColor: "#424242", 10 | borderStyle: "dashed", 11 | backgroundColor: "#121212", 12 | color: "#f0f0f0", 13 | outline: "none", 14 | transition: "border .24s ease-in-out", 15 | width: "60%", 16 | }; 17 | 18 | export const activeStyle = { 19 | borderColor: "#2196f3", 20 | }; 21 | 22 | export const acceptStyle = { 23 | borderColor: "#00e676", 24 | }; 25 | 26 | export const rejectStyle = { 27 | borderColor: "#ff1744", 28 | }; 29 | -------------------------------------------------------------------------------- /ui/src/Styles/listStyles.ts: -------------------------------------------------------------------------------- 1 | export const boxStyle = { 2 | marginTop: 4, 3 | marginBottom: 4, 4 | display: "flex", 5 | flexDirection: "column", 6 | alignItems: "left", 7 | borderRadius: "16px", 8 | }; 9 | -------------------------------------------------------------------------------- /ui/src/Themes/globalThemes.ts: -------------------------------------------------------------------------------- 1 | import { createTheme } from "@mui/material/styles"; 2 | 3 | export const darkTheme = createTheme({ 4 | palette: { 5 | mode: "dark", 6 | primary: { 7 | main: "#4872b5", 8 | }, 9 | background: { 10 | default: "#0a0a0a", 11 | paper: "#121212", 12 | }, 13 | }, 14 | }); 15 | -------------------------------------------------------------------------------- /ui/src/apis/beaconchaApi/buildValidatorSummaryURL.ts: -------------------------------------------------------------------------------- 1 | import { BeaconchaGetResponse } from "./types"; 2 | import { beaconchaApiParamsMap } from "../../params"; 3 | 4 | export default function buildValidatorSummaryURL({ 5 | allValidatorsInfo, 6 | network, 7 | }: { 8 | allValidatorsInfo: BeaconchaGetResponse[]; 9 | network: string; 10 | }): string { 11 | if (!beaconchaApiParamsMap.has(network)) { 12 | throw new Error(`Invalid network: ${network}`); 13 | } 14 | 15 | const baseUrl = beaconchaApiParamsMap.get(network)?.baseUrl; 16 | if (!baseUrl) return ""; 17 | 18 | let summaryValidatorURL = baseUrl + "/dashboard?validators="; 19 | 20 | allValidatorsInfo.forEach((validatorChunk) => { 21 | const chunkIndexes = validatorChunk.data.map( 22 | (validator) => validator.validatorindex 23 | ); 24 | summaryValidatorURL += chunkIndexes.join(","); 25 | }); 26 | 27 | return summaryValidatorURL; 28 | } 29 | -------------------------------------------------------------------------------- /ui/src/apis/beaconchaApi/index.ts: -------------------------------------------------------------------------------- 1 | import { BeaconchaGetResponse } from "./types"; 2 | import { Web3signerGetResponse } from "../web3signerApi/types"; 3 | import { StandardApi } from "../standardApi"; 4 | import { maxValidatorsPerRequest } from "../../params"; 5 | 6 | export class BeaconchaApi extends StandardApi { 7 | /* 8 | * Fetch info for every validator PK 9 | */ 10 | public async fetchAllValidatorsInfo({ 11 | keystoresGet, 12 | }: { 13 | keystoresGet: Web3signerGetResponse; 14 | }): Promise { 15 | const validatorsInfo = new Array(); 16 | 17 | let allValidatorPKs = keystoresGet.data.map( 18 | (keystoreData) => keystoreData.validating_pubkey 19 | ); 20 | 21 | const chunkSize = maxValidatorsPerRequest; 22 | 23 | for (let i = 0; i < allValidatorPKs.length; i += chunkSize) { 24 | const chunk = allValidatorPKs.slice(i, i + chunkSize); 25 | const chunkResponse = await this.fetchValidatorsInfo(chunk); 26 | validatorsInfo.push(chunkResponse); 27 | } 28 | 29 | //validatorInfo.data is an array only if there are multiple validators 30 | // (Beaconcha.in response works like this) 31 | validatorsInfo.forEach((validatorChunk) => { 32 | //Check if validatorChunk.data is an array 33 | if (!Array.isArray(validatorChunk.data)) { 34 | validatorChunk.data = [validatorChunk.data]; 35 | } 36 | }); 37 | 38 | return validatorsInfo; 39 | } 40 | 41 | /** 42 | * Get validator indexes for a list of public keys 43 | * https://beaconcha.in/api/v1/docs/index.html#/Validator/get_api_v1_validator__indexOrPubkey_ 44 | */ 45 | public async fetchValidatorsInfo( 46 | pubkeys: string[] 47 | ): Promise { 48 | const fullUrl = `${this.baseUrl}${ 49 | this.keymanagerEndpoint 50 | }validator/${pubkeys.join(",")}`; 51 | 52 | try { 53 | return (await this.request("GET", fullUrl)) as BeaconchaGetResponse; 54 | } catch (e) { 55 | return { 56 | status: "error", 57 | data: [], 58 | error: { 59 | message: e.message, 60 | }, 61 | }; 62 | } 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /ui/src/apis/beaconchaApi/types.ts: -------------------------------------------------------------------------------- 1 | export interface BeaconchaGetResponse { 2 | status: string; 3 | data: { 4 | activationeligibilityepoch?: number; 5 | activationepoch?: number; 6 | balance?: number; 7 | effectivebalance?: number; 8 | exitepoch?: number; 9 | lastattestationslot?: number; 10 | name?: string; 11 | pubkey?: string; 12 | slashed?: boolean; 13 | status?: string; 14 | validatorindex?: number; 15 | withdrawableepoch?: number; 16 | withdrawalcredentials?: string; 17 | }[]; 18 | error?: { message: string }; 19 | } 20 | -------------------------------------------------------------------------------- /ui/src/apis/standardApi/index.ts: -------------------------------------------------------------------------------- 1 | import { ApiParams } from "../../types"; 2 | 3 | export class StandardApi { 4 | baseUrl: string; 5 | authToken?: string; 6 | host?: string; 7 | keymanagerEndpoint?: string; 8 | 9 | constructor(apiParams: ApiParams) { 10 | this.authToken = apiParams.authToken; 11 | this.host = apiParams.host; 12 | this.baseUrl = apiParams.baseUrl; 13 | this.keymanagerEndpoint = apiParams.apiPath; 14 | } 15 | 16 | protected async request( 17 | method: string, 18 | url: string, 19 | body?: any 20 | ): Promise { 21 | const headers = { 22 | "Content-Type": "application/json", 23 | Accept: "application/json", 24 | Authorization: "", 25 | Host: "", 26 | }; 27 | 28 | if (this.authToken) { 29 | headers.Authorization = `Bearer ${this.authToken}`; 30 | } 31 | 32 | if (this.host) { 33 | headers.Host = this.host; 34 | } 35 | 36 | const response = await fetch(url, { 37 | method, 38 | headers, 39 | body: body ? body : undefined, 40 | }); 41 | if (response.ok) return await response.json(); 42 | throw new Error(response.statusText); 43 | } 44 | 45 | protected async readText(files: File[]): Promise { 46 | var data: string[] = []; 47 | for (var file of files) { 48 | const text = await file.text(); 49 | data.push(text); 50 | } 51 | return data; 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /ui/src/apis/web3signerApi/index.ts: -------------------------------------------------------------------------------- 1 | import { StandardApi } from "../standardApi"; 2 | import { 3 | Web3signerDeleteResponse, 4 | Web3signerGetResponse, 5 | Web3signerPostResponse, 6 | Web3signerPostRequest, 7 | Web3signerDeleteRequest, 8 | Web3signerHealthcheckResponse, 9 | } from "./types"; 10 | 11 | /** 12 | * Key Manager API standard 13 | * https://ethereum.github.io/keymanager-APIs/ 14 | */ 15 | export class Web3SignerApi extends StandardApi { 16 | /** 17 | * Local Key Manager endpoint 18 | * https://ethereum.github.io/keymanager-APIs/#/Local%20Key%20Manager/ 19 | */ 20 | keymanagerEndpoint = "/eth/v1/keystores"; 21 | 22 | /** 23 | * Server Healthcheck endpoint 24 | * https://consensys.github.io/web3signer/web3signer-eth2.html#tag/Server-Health-Status 25 | */ 26 | serverStatusEndpoint = "/healthcheck"; 27 | 28 | /** 29 | * Import remote keys for the validator client to request duties for. 30 | * https://ethereum.github.io/keymanager-APIs/#/Local%20Key%20Manager/ListKeys 31 | */ 32 | public async importKeystores( 33 | postRequest: Web3signerPostRequest 34 | ): Promise { 35 | try { 36 | var data; 37 | if (postRequest.slashingProtection) { 38 | data = { 39 | keystores: await this.readText(postRequest.keystores), 40 | passwords: postRequest.passwords, 41 | slashing_protection: await postRequest.slashingProtection?.text(), 42 | }; 43 | } else { 44 | data = { 45 | keystores: await this.readText(postRequest.keystores), 46 | passwords: postRequest.passwords, 47 | }; 48 | } 49 | return (await this.request( 50 | "POST", 51 | this.baseUrl + this.keymanagerEndpoint, 52 | JSON.stringify(data) 53 | )) as Web3signerPostResponse; 54 | } catch (e) { 55 | return { 56 | data: [], 57 | error: { 58 | message: e.message, 59 | }, 60 | }; 61 | } 62 | } 63 | 64 | /** 65 | * Must delete all keys from request.pubkeys that are known to the validator client and exist in its persistent storage. 66 | * https://ethereum.github.io/keymanager-APIs/#/Local%20Key%20Manager/ImportKeystores 67 | */ 68 | public async deleteKeystores( 69 | deleteRequest: Web3signerDeleteRequest 70 | ): Promise { 71 | try { 72 | const data = JSON.stringify({ 73 | pubkeys: deleteRequest.pubkeys, 74 | }); 75 | return (await this.request( 76 | "DELETE", 77 | this.baseUrl + this.keymanagerEndpoint, 78 | data 79 | )) as Web3signerDeleteResponse; 80 | } catch (e) { 81 | return { 82 | data: [], 83 | error: { 84 | message: e.message, 85 | }, 86 | }; 87 | } 88 | } 89 | 90 | /** 91 | * List all remote validating pubkeys known to this validator client binary 92 | * https://ethereum.github.io/keymanager-APIs/#/Remote%20Key%20Manager/ListRemoteKeys 93 | */ 94 | public async getKeystores(): Promise { 95 | try { 96 | return (await this.request( 97 | "GET", 98 | this.baseUrl + this.keymanagerEndpoint 99 | )) as Web3signerGetResponse; 100 | } catch (e) { 101 | return { 102 | data: [], 103 | error: { 104 | message: e.message, 105 | }, 106 | }; 107 | } 108 | } 109 | 110 | /** 111 | * Checks the Web3Signer server status. Confirms if Web3Signer is connected and running. 112 | * https://consensys.github.io/web3signer/web3signer-eth2.html#tag/Reload-Signer-Keys/operation/UPCHECK 113 | */ 114 | public async getStatus(): Promise { 115 | try { 116 | return (await this.request( 117 | "GET", 118 | this.baseUrl + this.serverStatusEndpoint 119 | )) as Web3signerHealthcheckResponse; 120 | } catch (e) { 121 | return { 122 | status: "UNKNOWN", 123 | checks: [], 124 | outcome: e.message, 125 | }; 126 | } 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /ui/src/apis/web3signerApi/types.ts: -------------------------------------------------------------------------------- 1 | import { Web3SignerStatus } from "../../types"; 2 | 3 | export interface Web3signerGetResponse { 4 | data: { 5 | validating_pubkey: string; 6 | derivation_path: string; 7 | readonly: boolean; 8 | }[]; 9 | error?: { message: string }; 10 | } 11 | 12 | export interface Web3signerPostRequest { 13 | keystores: File[]; 14 | passwords: string[]; 15 | slashingProtection: File | undefined; 16 | } 17 | 18 | export interface Web3signerPostResponse { 19 | data: { 20 | status: string; 21 | message: string; 22 | }[]; 23 | error?: { message: string }; 24 | } 25 | 26 | export interface Web3signerDeleteRequest { 27 | pubkeys: string[]; 28 | } 29 | 30 | export interface Web3signerDeleteResponse { 31 | data: { 32 | status: string; 33 | message: string; 34 | }[]; 35 | slashing_protection?: string; 36 | error?: { message: string }; 37 | } 38 | 39 | export interface Web3signerHealthcheckResponse { 40 | status: Web3SignerStatus; 41 | checks: { 42 | id: string; 43 | status: string; 44 | }[]; 45 | outcome: string; 46 | } 47 | -------------------------------------------------------------------------------- /ui/src/components/ButtonsBox/ButtonsBox.tsx: -------------------------------------------------------------------------------- 1 | import { Box, Button, CircularProgress } from "@mui/material"; 2 | import { Link } from "react-router-dom"; 3 | import { buttonsBoxStyle } from "../../Styles/buttonsBoxStyles"; 4 | //Icons 5 | import BackupIcon from "@mui/icons-material/Backup"; 6 | import DeleteForeverIcon from "@mui/icons-material/DeleteForever"; 7 | import { BeaconchaUrlBuildingStatus } from "../../types"; 8 | 9 | export default function ButtonsBox({ 10 | areRowsSelected, 11 | isTableEmpty, 12 | setOpen, 13 | validatorSummaryURL, 14 | summaryUrlBuildingStatus, 15 | loadSummaryUrl, 16 | }: { 17 | areRowsSelected: boolean; 18 | isTableEmpty: boolean; 19 | setOpen(open: boolean): void; 20 | validatorSummaryURL: string; 21 | summaryUrlBuildingStatus: BeaconchaUrlBuildingStatus; 22 | loadSummaryUrl(): void; 23 | }): JSX.Element { 24 | return ( 25 | 26 | 27 | 35 | 36 | 47 | 48 | {summaryUrlBuildingStatus === BeaconchaUrlBuildingStatus.NotStarted ? ( 49 | !isTableEmpty && ( 50 | 58 | ) 59 | ) : summaryUrlBuildingStatus === BeaconchaUrlBuildingStatus.NoIndexes ? ( 60 | <> 61 | ) : summaryUrlBuildingStatus === BeaconchaUrlBuildingStatus.Success ? ( 62 | 71 | ) : ( 72 | <> 73 | 82 | 83 | )} 84 | 85 | ); 86 | } 87 | -------------------------------------------------------------------------------- /ui/src/components/ClientsBox/ClientsBox.tsx: -------------------------------------------------------------------------------- 1 | import { Box, Card } from "@mui/material"; 2 | import ElectricalServicesIcon from "@mui/icons-material/ElectricalServices"; 3 | 4 | export default function ClientsBox({ 5 | consensusClient, 6 | executionClient, 7 | }: { 8 | consensusClient: string; 9 | executionClient: string; 10 | }): JSX.Element { 11 | return ( 12 |
19 | 20 | {consensusClient} 21 | 22 | 29 | 30 | {executionClient} 31 | 32 |
33 | ); 34 | } 35 | -------------------------------------------------------------------------------- /ui/src/components/Dialogs/DeletionWarning.tsx: -------------------------------------------------------------------------------- 1 | import { GridSelectionModel } from "@mui/x-data-grid"; 2 | import { Web3signerGetResponse } from "../../apis/web3signerApi/types"; 3 | import { shortenPubkey } from "../../logic/Utils/dataUtils"; 4 | 5 | export default function DeletionWarning({ 6 | selectedRows, 7 | rows, 8 | }: { 9 | selectedRows: GridSelectionModel; 10 | rows: Web3signerGetResponse["data"]; 11 | }): JSX.Element { 12 | return ( 13 | <> 14 | Are you sure you want to delete these keystores? 15 |
    16 | {selectedRows.map((row, i) => ( 17 |
  • 18 | {shortenPubkey(rows[parseInt(row.toString())].validating_pubkey)} 19 |
    • 20 | ))} 21 |
22 | After deletion, these keystores won't be used for signing anymore and your 23 | slashing protection data will be downloaded.
24 |
25 | 26 | Keep the slashing protection data for when you want to import these 27 | keystores to a new validator. 28 | 29 | 30 | ); 31 | } 32 | -------------------------------------------------------------------------------- /ui/src/components/Dialogs/ImportDialog.tsx: -------------------------------------------------------------------------------- 1 | import { 2 | Dialog, 3 | DialogTitle, 4 | DialogContent, 5 | Box, 6 | Typography, 7 | Button, 8 | DialogActions, 9 | } from "@mui/material"; 10 | import { Link } from "react-router-dom"; 11 | 12 | import { Web3signerPostResponse } from "../../apis/web3signerApi/types"; 13 | import { getEmoji, shortenPubkey } from "../../logic/Utils/dataUtils"; 14 | import { importDialogBoxStyle } from "../../Styles/dialogStyles"; 15 | import { KeystoreInfo } from "../../types"; 16 | import WaitBox from "../WaitBox/WaitBox"; 17 | 18 | export default function ImportDialog({ 19 | open, 20 | setOpen, 21 | keystoresPostResponse, 22 | importStatus, 23 | acceptedFiles, 24 | }: { 25 | open: boolean; 26 | setOpen: (open: boolean) => void; 27 | keystoresPostResponse: Web3signerPostResponse | undefined; 28 | importStatus: string; 29 | acceptedFiles: KeystoreInfo[]; 30 | }): JSX.Element { 31 | const handleClose = () => { 32 | setOpen(false); 33 | }; 34 | 35 | return ( 36 | { 41 | if (!reason) { 42 | handleClose(); 43 | } 44 | }} 45 | aria-labelledby="alert-dialog-title" 46 | aria-describedby="alert-dialog-description" 47 | > 48 | 49 | {importStatus} 50 | 51 | 52 | 53 | {keystoresPostResponse ? ( 54 | keystoresPostResponse.error ? ( 55 | `Error: ${keystoresPostResponse.error.message}` 56 | ) : ( 57 |
58 | {keystoresPostResponse.data.map((result, index) => ( 59 |
60 | 61 | {shortenPubkey(acceptedFiles[index]?.pubkey)} 62 | 63 | 64 | Status: {result.status} {getEmoji(result.status)} 65 | 66 | {result.message ? ( 67 | 68 | Message: {result.message} 69 | 70 | ) : null} 71 |
72 | ))} 73 |
74 | ) 75 | ) : ( 76 | 77 | )} 78 | 79 | 80 | {keystoresPostResponse ? ( 81 | 82 | 83 | 90 | 91 | 92 | ) : null} 93 | 94 | ); 95 | } 96 | -------------------------------------------------------------------------------- /ui/src/components/Dialogs/KeystoresDeleteDialog.tsx: -------------------------------------------------------------------------------- 1 | import { useState } from "react"; 2 | import { 3 | Dialog, 4 | DialogTitle, 5 | DialogContent, 6 | Box, 7 | Typography, 8 | Button, 9 | DialogContentText, 10 | DialogActions, 11 | Alert, 12 | } from "@mui/material"; 13 | import { GridSelectionModel } from "@mui/x-data-grid"; 14 | import { shortenPubkey, getEmoji } from "../../logic/Utils/dataUtils"; 15 | import { Web3SignerApi } from "../../apis/web3signerApi"; 16 | import { 17 | Web3signerDeleteResponse, 18 | Web3signerGetResponse, 19 | } from "../../apis/web3signerApi/types"; 20 | import { importDialogBoxStyle } from "../../Styles/dialogStyles"; 21 | import WaitBox from "../WaitBox/WaitBox"; 22 | import DeletionWarning from "./DeletionWarning"; 23 | 24 | export default function KeystoresDeleteDialog({ 25 | web3signerApi, 26 | rows, 27 | selectedRows, 28 | setSelectedRows, 29 | open, 30 | setOpen, 31 | }: { 32 | web3signerApi: Web3SignerApi; 33 | rows: Web3signerGetResponse["data"]; 34 | selectedRows: GridSelectionModel; 35 | setSelectedRows: (selectedRows: GridSelectionModel) => void; 36 | open: boolean; 37 | setOpen: (open: boolean) => void; 38 | }) { 39 | const [keystoresDelete, setKeystoresDelete] = 40 | useState(); 41 | const [requestInFlight, setRequestInFlight] = useState(false); 42 | 43 | async function deleteSelectedKeystores() { 44 | setKeystoresDelete(undefined); 45 | setRequestInFlight(true); 46 | const keystoresDelete = await web3signerApi.deleteKeystores({ 47 | pubkeys: selectedRows.map( 48 | (row) => rows[parseInt(row.toString())].validating_pubkey 49 | ), 50 | }); 51 | setRequestInFlight(false); 52 | setKeystoresDelete(keystoresDelete); 53 | setSelectedRows([]); 54 | } 55 | const handleClose = () => { 56 | setOpen(false); 57 | }; 58 | return ( 59 | { 64 | if (!reason) { 65 | handleClose(); 66 | } 67 | }} 68 | aria-labelledby="alert-dialog-title" 69 | aria-describedby="alert-dialog-description" 70 | > 71 | 72 | {keystoresDelete ? "Done" : "Delete Keystores?"} 73 | 74 | 75 | 76 | {keystoresDelete?.error ? ( 77 | `Error: ${keystoresDelete.error.message}` 78 | ) : keystoresDelete?.data ? ( 79 |
80 | {keystoresDelete.data.map((result, index) => ( 81 |
82 | 83 | {shortenPubkey(rows[index]?.validating_pubkey)} 84 | 85 | 86 | Status: {result.status} {getEmoji(result.status)} 87 | 88 | {result.message ? ( 89 | 90 | Message: {result.message} 91 | 92 | ) : null} 93 |
94 | ))} 95 | {keystoresDelete.slashing_protection ? ( 96 |
97 | 102 | It is strongly recommended to stop the validator and watch 103 | at least 3 missed attestations in the explorer before 104 | uploading the keys to another machine. 105 | 106 | 107 | 117 |
118 | ) : null} 119 |
120 | ) : ( 121 |
122 | {requestInFlight ? ( 123 | 124 | ) : ( 125 | 129 | 130 | 131 | )} 132 |
133 | )} 134 | 135 | 136 | 137 | {!keystoresDelete && !requestInFlight ? ( 138 | 145 | ) : null} 146 | 153 | 154 | 155 | ); 156 | } 157 | -------------------------------------------------------------------------------- /ui/src/components/FileCards/FileCardList.css: -------------------------------------------------------------------------------- 1 | button { 2 | background: none; 3 | border: none; 4 | cursor: pointer; 5 | } 6 | -------------------------------------------------------------------------------- /ui/src/components/FileCards/FileCardList.tsx: -------------------------------------------------------------------------------- 1 | //External components 2 | import { Card, Box, Typography, TextField } from "@mui/material"; 3 | 4 | //Internal components 5 | import { KeystoreInfo } from "../../types"; 6 | 7 | //Logic 8 | import CloseIcon from "@mui/icons-material/Close"; 9 | import { passwordEntered } from "../../logic/ImportScreen/PasswordManager"; 10 | import { shortenPubkey } from "../../logic/Utils/dataUtils"; 11 | 12 | //Style 13 | import "./FileCardList.css"; 14 | 15 | const removeFileFromList = ( 16 | fileInfo: KeystoreInfo, 17 | fileInfos: KeystoreInfo[], 18 | setAcceptedFiles: (passwords: KeystoreInfo[]) => void, 19 | passwords: string[], 20 | setPasswords: (passwords: string[]) => void 21 | ) => { 22 | var indexToRemove = fileInfos.indexOf(fileInfo); 23 | setAcceptedFiles(fileInfos.filter((f, index) => index !== indexToRemove)); 24 | setPasswords(passwords.filter((f, index) => index !== indexToRemove)); 25 | }; 26 | 27 | export default function FileCardList( 28 | fileInfos: KeystoreInfo[], 29 | setAcceptedFiles: (passwords: KeystoreInfo[]) => void, 30 | passwords: string[], 31 | setPasswords: (passwords: string[]) => void, 32 | useSamePassword: boolean 33 | ): JSX.Element[] { 34 | return Array.from(fileInfos).map((fileInfo, index) => ( 35 | 40 | 47 | 48 | ✅ {fileInfo.file.name} - {shortenPubkey(fileInfo.pubkey)} 49 | 50 | 63 | 64 | {!useSamePassword && ( 65 | 70 | passwordEntered(event, index, passwords, setPasswords) 71 | } 72 | sx={{ marginTop: 2, width: "60%" }} 73 | /> 74 | )} 75 | 76 | )); 77 | } 78 | -------------------------------------------------------------------------------- /ui/src/components/FileDrop/FileDrop.tsx: -------------------------------------------------------------------------------- 1 | import { DropEvent, useDropzone } from "react-dropzone"; 2 | import { useMemo } from "react"; 3 | import { 4 | baseStyle, 5 | acceptStyle, 6 | activeStyle, 7 | rejectStyle, 8 | } from "../../Styles/fileDropStyles"; 9 | 10 | interface Props { 11 | callback: (files: T[], event: DropEvent) => void; 12 | } 13 | 14 | export default function FileDrop({ callback }: Props) { 15 | const { 16 | getRootProps, 17 | getInputProps, 18 | isDragActive, 19 | isDragAccept, 20 | isDragReject, 21 | } = useDropzone({ onDropAccepted: callback, accept: "application/json" }); 22 | 23 | const style = useMemo( 24 | () => ({ 25 | ...baseStyle, 26 | ...(isDragActive ? activeStyle : {}), 27 | ...(isDragAccept ? acceptStyle : {}), 28 | ...(isDragReject ? rejectStyle : {}), 29 | }), 30 | [isDragActive, isDragReject, isDragAccept] 31 | ); 32 | 33 | const dropzone = ( 34 |
35 |
36 | 37 | {isDragActive ? ( 38 |

Drop the file here ...

39 | ) : ( 40 |

Drop JSON file here, or click to select file

41 | )} 42 |
43 |
44 | ); 45 | 46 | return dropzone; 47 | } 48 | -------------------------------------------------------------------------------- /ui/src/components/KeystoreList/KeystoreColumns.tsx: -------------------------------------------------------------------------------- 1 | //External components 2 | import { GridColDef } from "@mui/x-data-grid"; 3 | import LinkIcon from "@mui/icons-material/Link"; 4 | 5 | export default function KeystoreColumns(): GridColDef[] { 6 | return [ 7 | { 8 | field: "validating_pubkey", 9 | headerName: "Validating Public Key", 10 | description: "Validating Public Key", 11 | disableColumnMenu: true, 12 | flex: 1, 13 | headerClassName: "tableHeader", 14 | }, 15 | { 16 | field: "beaconcha_url", 17 | headerName: "URL", 18 | description: "Beaconcha URL to track the status of this validator", 19 | disableReorder: true, 20 | disableColumnMenu: true, 21 | disableExport: true, 22 | sortable: false, 23 | align: "center", 24 | headerAlign: "center", 25 | renderCell: (rowData) => ( 26 | 32 | 33 | 34 | ), 35 | headerClassName: "tableHeader", 36 | }, 37 | ]; 38 | } 39 | -------------------------------------------------------------------------------- /ui/src/components/KeystoreList/KeystoreList.tsx: -------------------------------------------------------------------------------- 1 | import { 2 | DataGrid, 3 | GridCallbackDetails, 4 | GridSelectionModel, 5 | GridToolbar, 6 | } from "@mui/x-data-grid"; 7 | import { useState } from "react"; 8 | import { Web3signerGetResponse } from "../../apis/web3signerApi/types"; 9 | import { beaconchaApiParamsMap } from "../../params"; 10 | import KeystoreColumns from "./KeystoreColumns"; 11 | 12 | export default function KeystoreList({ 13 | rows, 14 | setSelectedRows, 15 | network, 16 | }: { 17 | rows: Web3signerGetResponse["data"]; 18 | setSelectedRows: (arg0: GridSelectionModel) => void; 19 | network: string; 20 | }) { 21 | const selection = ( 22 | selectionModel: GridSelectionModel, 23 | details: GridCallbackDetails 24 | ) => { 25 | setSelectedRows(selectionModel); 26 | }; 27 | 28 | const [pageSize, setPageSize] = useState(10); 29 | const pageSizeChange = (pageSize: number, details: GridCallbackDetails) => { 30 | setPageSize(pageSize); 31 | }; 32 | 33 | const beaconchaBaseUrl = beaconchaApiParamsMap.get(network)?.baseUrl; 34 | 35 | const customRows = rows.map((row, index) => ({ 36 | // only show first 12 chars from pubkey 37 | validating_pubkey: row.validating_pubkey, 38 | beaconcha_url: beaconchaBaseUrl 39 | ? beaconchaBaseUrl + "/validator/" + row.validating_pubkey 40 | : "", 41 | id: index, 42 | })); 43 | 44 | return ( 45 |
46 | { 49 | if (params.field === "validating_pubkey") { 50 | navigator.clipboard.writeText(params.value); 51 | } 52 | }} 53 | columns={KeystoreColumns()} 54 | pageSize={pageSize} 55 | rowsPerPageOptions={[10, 20, 50, 100]} 56 | onPageSizeChange={pageSizeChange} 57 | checkboxSelection 58 | disableSelectionOnClick={true} 59 | onSelectionModelChange={selection} 60 | components={{ Toolbar: GridToolbar }} 61 | sx={{ borderRadius: 3 }} 62 | /> 63 |
64 | ); 65 | } 66 | -------------------------------------------------------------------------------- /ui/src/components/TopBar/ToolBar.tsx: -------------------------------------------------------------------------------- 1 | import Toolbar from "@mui/material/Toolbar"; 2 | import { HeaderTypography } from "../../Styles/Typographies"; 3 | import { CheckCircle, Cancel, QuestionMark } from "@mui/icons-material"; 4 | import { Box, Card, CircularProgress, Tooltip } from "@mui/material"; 5 | 6 | export default function ToolBar({ 7 | network, 8 | signerStatus, 9 | }: { 10 | network?: string; 11 | signerStatus: string; 12 | }): JSX.Element { 13 | return ( 14 | 15 |
23 | logo 24 | 28 | 29 | 40 | {network} 41 | 42 | 43 |
44 |
45 | 53 | 62 | {signerStatus === "UP" ? ( 63 | 64 | 65 | 66 | ) : signerStatus === "DOWN" ? ( 67 | 68 | 69 | 70 | ) : signerStatus === "LOADING" ? ( 71 | 72 | 73 | 74 | ) : ( 75 | 76 | 77 | 78 | )} 79 | 80 |
81 | 82 | ); 83 | } 84 | -------------------------------------------------------------------------------- /ui/src/components/TopBar/TopBar.tsx: -------------------------------------------------------------------------------- 1 | //External components 2 | import { AppBar } from "@mui/material"; 3 | 4 | //Internal components 5 | import ToolBar from "./ToolBar"; 6 | 7 | export default function TopBar({ 8 | network, 9 | signerStatus, 10 | }: { 11 | network?: string; 12 | signerStatus: string; 13 | }): JSX.Element { 14 | return ( 15 | 16 | 17 | 18 | ); 19 | } 20 | -------------------------------------------------------------------------------- /ui/src/components/ValidatorList/ValidatorList.tsx: -------------------------------------------------------------------------------- 1 | //Internal components 2 | import KeystoreList from "../KeystoreList/KeystoreList"; 3 | import KeystoresDeleteDialog from "../Dialogs/KeystoresDeleteDialog"; 4 | import ButtonsBox from "../ButtonsBox/ButtonsBox"; 5 | 6 | //External components 7 | import { Alert, Box, Card, CircularProgress } from "@mui/material"; 8 | import { GridSelectionModel } from "@mui/x-data-grid"; 9 | 10 | //Logic 11 | import { Web3SignerApi } from "../../apis/web3signerApi"; 12 | import { Web3signerGetResponse } from "../../apis/web3signerApi/types"; 13 | import { useEffect, useState } from "react"; 14 | import { BeaconchaApi } from "../../apis/beaconchaApi"; 15 | import buildValidatorSummaryURL from "../../apis/beaconchaApi/buildValidatorSummaryURL"; 16 | import { beaconchaApiParamsMap } from "../../params"; 17 | import { BeaconchaUrlBuildingStatus } from "../../types"; 18 | 19 | //Styles 20 | import { boxStyle } from "../../Styles/listStyles"; 21 | import { HeaderTypography } from "../../Styles/Typographies"; 22 | import { hasIndexes } from "../../logic/Utils/beaconchaUtils"; 23 | 24 | export default function ValidatorList({ 25 | web3signerApi, 26 | network, 27 | }: { 28 | web3signerApi: Web3SignerApi; 29 | network: string; 30 | }) { 31 | const [selectedRows, setSelectedRows] = useState([]); 32 | const [open, setOpen] = useState(false); 33 | const [loading, setLoading] = useState(false); 34 | const [validatorSummaryURL, setValidatorSummaryURL] = useState(""); 35 | const [summaryUrlBuildingStatus, setSummaryUrlBuildingStatus] = useState( 36 | BeaconchaUrlBuildingStatus.NotStarted 37 | ); 38 | const [keystoresGet, setKeystoresGet] = useState(); 39 | 40 | async function getKeystores() { 41 | setLoading(true); 42 | const keystoresGet = await web3signerApi.getKeystores(); 43 | setKeystoresGet(keystoresGet); 44 | setLoading(false); 45 | } 46 | 47 | async function getValidatorSummaryURL(beaconchaApi: BeaconchaApi) { 48 | if (!keystoresGet) { 49 | setValidatorSummaryURL(""); 50 | setSummaryUrlBuildingStatus(BeaconchaUrlBuildingStatus.Error); 51 | return; 52 | } 53 | 54 | setSummaryUrlBuildingStatus(BeaconchaUrlBuildingStatus.InProgress); 55 | 56 | const allValidatorsInfo = await beaconchaApi.fetchAllValidatorsInfo({ 57 | keystoresGet: keystoresGet, 58 | }); 59 | 60 | try { 61 | const validatorSummaryURL = buildValidatorSummaryURL({ 62 | allValidatorsInfo, 63 | network, 64 | }); 65 | 66 | if (hasIndexes(validatorSummaryURL)) { 67 | setValidatorSummaryURL(""); 68 | setSummaryUrlBuildingStatus(BeaconchaUrlBuildingStatus.NoIndexes); 69 | } else { 70 | setValidatorSummaryURL(validatorSummaryURL); 71 | setSummaryUrlBuildingStatus(BeaconchaUrlBuildingStatus.Success); 72 | } 73 | } catch (e) { 74 | setSummaryUrlBuildingStatus(BeaconchaUrlBuildingStatus.Error); 75 | setValidatorSummaryURL(""); 76 | console.log(e); 77 | } 78 | } 79 | 80 | useEffect(() => { 81 | if (!open) { 82 | getKeystores(); 83 | } 84 | // eslint-disable-next-line react-hooks/exhaustive-deps 85 | }, [open]); 86 | 87 | useEffect(() => { 88 | setSummaryUrlBuildingStatus(BeaconchaUrlBuildingStatus.NotStarted); 89 | setValidatorSummaryURL(""); 90 | // eslint-disable-next-line react-hooks/exhaustive-deps 91 | }, [keystoresGet]); 92 | 93 | async function loadSummaryUrl() { 94 | if (keystoresGet && beaconchaApiParamsMap.has(network)) { 95 | const beaconchaParams = beaconchaApiParamsMap.get(network); 96 | 97 | if (beaconchaParams) { 98 | const beaconchaApi = new BeaconchaApi(beaconchaParams); 99 | getValidatorSummaryURL(beaconchaApi); 100 | } 101 | } 102 | } 103 | 104 | return ( 105 |
106 | 107 | 108 | 112 | 113 | {loading ? ( 114 | 119 | ) : keystoresGet?.error ? ( 120 | 121 | {keystoresGet.error?.message} 122 | 123 | ) : keystoresGet?.data ? ( 124 | <> 125 | 130 | 138 | {summaryUrlBuildingStatus === 139 | BeaconchaUrlBuildingStatus.Error && ( 140 | 145 | There was an error loading the dashboard. The number of API 146 | calls allowed by the explorer might have been exceeded or the 147 | network might be invalid. Please wait for a minute and refresh 148 | the page. 149 | 150 | )} 151 | 152 | {summaryUrlBuildingStatus === 153 | BeaconchaUrlBuildingStatus.NoIndexes && ( 154 | 159 | There was an error loading the dashboard. The explorer may not 160 | be able to show a dashboard for all your validators or some of 161 | them might not have been indexed yet. Have you done a deposit? 162 | 163 | )} 164 | 165 | {open && ( 166 | 174 | )} 175 | 176 | ) : ( 177 | 178 | There are no keystores to display. 179 | 180 | )} 181 | 182 | 183 |
184 | ); 185 | } 186 | -------------------------------------------------------------------------------- /ui/src/components/WaitBox/WaitBox.tsx: -------------------------------------------------------------------------------- 1 | import { Box, CircularProgress, DialogContentText } from "@mui/material"; 2 | import { waitDialogBoxStyle } from "../../Styles/dialogStyles"; 3 | 4 | export default function WaitBox() { 5 | return ( 6 | 7 | 12 | 13 | Please wait 14 | 15 | 16 | ); 17 | } 18 | -------------------------------------------------------------------------------- /ui/src/env.ts: -------------------------------------------------------------------------------- 1 | declare global { 2 | interface Window { 3 | env: any; 4 | } 5 | } 6 | 7 | // change with your own variables 8 | type EnvType = { 9 | NODE_ENV: string; 10 | }; 11 | 12 | export const env: EnvType = { ...process.env, ...window.env }; 13 | -------------------------------------------------------------------------------- /ui/src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | background-color: #0a0a0a; 4 | color: white; 5 | font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", 6 | "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", 7 | sans-serif; 8 | -webkit-font-smoothing: antialiased; 9 | -moz-osx-font-smoothing: grayscale; 10 | } 11 | 12 | code { 13 | font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", 14 | monospace; 15 | } 16 | -------------------------------------------------------------------------------- /ui/src/index.tsx: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import ReactDOM from "react-dom"; 3 | import "./index.css"; 4 | import App from "./App"; 5 | 6 | ReactDOM.render( 7 | 8 | 9 | , 10 | document.getElementById("root") 11 | ); 12 | -------------------------------------------------------------------------------- /ui/src/logic/ImportScreen/PasswordManager.ts: -------------------------------------------------------------------------------- 1 | export const passwordEntered = ( 2 | event: React.ChangeEvent, 3 | index: number, 4 | passwords: string[], 5 | setPasswords: (passwords: string[]) => void 6 | ) => { 7 | const pass = event.target.value; 8 | const newList = Array.from(passwords); 9 | newList[index] = pass; 10 | setPasswords(newList); 11 | }; 12 | 13 | export const setUniquePassword = ( 14 | event: React.ChangeEvent, 15 | passwords: string[], 16 | setPasswords: (passwords: string[]) => void 17 | ) => { 18 | const pass = event.target.value; 19 | const newList = Array.from(passwords); 20 | newList.fill(pass); 21 | setPasswords(newList); 22 | }; 23 | -------------------------------------------------------------------------------- /ui/src/logic/Utils/beaconchaUtils.ts: -------------------------------------------------------------------------------- 1 | export function hasIndexes(beaconchaUrl: string): boolean { 2 | return !beaconchaUrl.split("=")[1]; 3 | } 4 | -------------------------------------------------------------------------------- /ui/src/logic/Utils/dataUtils.ts: -------------------------------------------------------------------------------- 1 | export const extractPubkey = async (file: File): Promise => { 2 | const text = await file.text(); 3 | const json = JSON.parse(text); 4 | return json.pubkey; 5 | }; 6 | 7 | export const shortenPubkey = (key: string | undefined): string => { 8 | if (!key) return ""; 9 | var prefix = ""; 10 | var end = 4; 11 | if (!key.startsWith("0x")) { 12 | prefix = `0x`; 13 | } else { 14 | end = 6; 15 | } 16 | return `${prefix}${key.substring(0, end)}...${key.substring( 17 | key.length - 4, 18 | key.length 19 | )}`; 20 | }; 21 | 22 | export function getEmoji(status: string) { 23 | switch (status) { 24 | case "error": 25 | return "❌"; 26 | case "imported": 27 | return "✅"; 28 | case "deleted": 29 | return "✅"; 30 | default: 31 | return "⚠️"; 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /ui/src/logic/Utils/getParams.ts: -------------------------------------------------------------------------------- 1 | import { AppParams, beaconchaApiParamsMap } from "../../params"; 2 | 3 | export function getParams(): AppParams { 4 | const search = new URLSearchParams(window.location.search); 5 | 6 | let currentNetwork = search.get("network") || window.env.NETWORK || "mainnet"; 7 | 8 | if (!beaconchaApiParamsMap.has(currentNetwork)) currentNetwork = ""; 9 | 10 | return { 11 | network: currentNetwork, 12 | signerUrl: search.get("signerUrl") || window.env?.WEB3SIGNER_API_URL || "", 13 | signerAuthToken: 14 | search.get("authToken") || window.env?.WEB3SIGNER_AUTH_TOKEN || "", 15 | consensusClient: 16 | search.get("consensusClient") || window.env?.CONSENSUS_CLIENT || "", 17 | executionClient: 18 | search.get("executionClient") || window.env?.EXECUTION_CLIENT || "", 19 | }; 20 | } 21 | -------------------------------------------------------------------------------- /ui/src/params.ts: -------------------------------------------------------------------------------- 1 | import { ApiParams } from "./types"; 2 | 3 | export const beaconchaApiParamsMap = new Map([ 4 | ["mainnet", { baseUrl: "https://beaconcha.in", apiPath: "/api/v1/" }], 5 | ["prater", { baseUrl: "https://prater.beaconcha.in", apiPath: "/api/v1/" }], 6 | [ 7 | "gnosis", 8 | { baseUrl: "https://beacon.gnosischain.com", apiPath: "/api/v1/" }, 9 | ], 10 | ]); 11 | 12 | export const maxValidatorsPerRequest = 100; //For beaconcha.in --> TODO: is it the same for Gnosis? 13 | 14 | export interface AppParams { 15 | network: string; 16 | signerUrl: string; 17 | signerAuthToken?: string; 18 | consensusClient?: string; 19 | executionClient?: string; 20 | } 21 | -------------------------------------------------------------------------------- /ui/src/react-app-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /ui/src/reportWebVitals.ts: -------------------------------------------------------------------------------- 1 | import { ReportHandler } from "web-vitals"; 2 | 3 | const reportWebVitals = (onPerfEntry?: ReportHandler) => { 4 | if (onPerfEntry && onPerfEntry instanceof Function) { 5 | import("web-vitals").then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => { 6 | getCLS(onPerfEntry); 7 | getFID(onPerfEntry); 8 | getFCP(onPerfEntry); 9 | getLCP(onPerfEntry); 10 | getTTFB(onPerfEntry); 11 | }); 12 | } 13 | }; 14 | 15 | export default reportWebVitals; 16 | -------------------------------------------------------------------------------- /ui/src/setupTests.ts: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import "@testing-library/jest-dom"; 6 | -------------------------------------------------------------------------------- /ui/src/tests/beaconchaApi/networkTestMap.ts: -------------------------------------------------------------------------------- 1 | export const networkTestMap = new Map< 2 | string, 3 | { pubkeys: string[]; indexes: number[] } 4 | >([ 5 | [ 6 | "mainnet", 7 | { 8 | pubkeys: [ 9 | "0x80000001677f23a227dfed6f61b132d114be83b8ad0aa5f3c5d1d77e6ee0bf5f73b0af750cc34e8f2dae73c21dc36f4a", 10 | "0x800006d4b1026b6149168b342e6883d48ede9539202cc414448b1b796394440a5401e8d6620e65d7c77654bf1db199b1", 11 | ], 12 | indexes: [8499, 347967], 13 | }, 14 | ], 15 | [ 16 | "prater", 17 | { 18 | pubkeys: [ 19 | "0x8000091c2ae64ee414a54c1cc1fc67dec663408bc636cb86756e0200e41a75c8f86603f104f02c856983d2783116be13", 20 | "0x80003a1c67216514e4ab257738e59ef38063edf43bc4a2ef9d38633bdde117384401684c6cf81aa04cf18890e75ab52c", 21 | ], 22 | indexes: [55293, 351819], 23 | }, 24 | ], 25 | [ 26 | "gnosis", 27 | { 28 | pubkeys: [ 29 | "0x8000385f61788781c3514322c14bf4ef51bfee5ed743872ac9ea37a3a11e1e3496f4f5e252ef33fdb5bf3684c13ed210", 30 | "0x8000e5f66ffb58ef1f8bf8994172da85c77142cc7be24a63d53e572f5ba1149466c5aa0e6a383b2cddf83467cf8e688a", 31 | ], 32 | indexes: [57102, 81200], 33 | }, 34 | ], 35 | ]); 36 | -------------------------------------------------------------------------------- /ui/src/tests/beaconchaApi/testBuildSummaryURL.ts: -------------------------------------------------------------------------------- 1 | import buildValidatorSummaryURL from "../../apis/beaconchaApi/buildValidatorSummaryURL"; 2 | import { expect } from "chai"; 3 | import { BeaconchaGetResponse } from "../../apis/beaconchaApi/types"; 4 | 5 | describe("Test the building of a unique URL for all the validators", () => { 6 | it("should return a valid URL", () => { 7 | let allValidatorsInfo: BeaconchaGetResponse[] = [ 8 | { 9 | status: "ok", 10 | data: [], 11 | }, 12 | { 13 | status: "ok", 14 | data: [], 15 | }, 16 | ]; 17 | 18 | for (let i = 1; i <= 100; i++) { 19 | allValidatorsInfo[0].data.push({ validatorindex: 1 }); 20 | } 21 | 22 | for (let i = 1; i <= 3; i++) { 23 | allValidatorsInfo[0].data.push({ validatorindex: i + 100 }); 24 | } 25 | 26 | const network = "mainnet"; 27 | const summaryValidatorURL = buildValidatorSummaryURL({ 28 | allValidatorsInfo, 29 | network, 30 | }); 31 | expect(summaryValidatorURL).to.equal( 32 | "https://beaconcha.in/dashboard?validators=" + 33 | "1,".repeat(100) + 34 | "101,102,103" 35 | ); 36 | }); 37 | }); 38 | -------------------------------------------------------------------------------- /ui/src/tests/beaconchaApi/testFetchValidatorIndex.ts: -------------------------------------------------------------------------------- 1 | import { BeaconchaApi } from "../../apis/beaconchaApi"; 2 | import { expect } from "chai"; 3 | import { beaconchaApiParamsMap } from "../../params"; 4 | import { Web3signerGetResponse } from "../../apis/web3signerApi/types"; 5 | import { networkTestMap } from "./networkTestMap"; 6 | require("isomorphic-fetch"); 7 | 8 | describe("Test for fetching validator indexes in every available network", () => { 9 | it("should return data corresponding to every validator PK", async () => { 10 | const networks = ["mainnet", "prater", "gnosis"]; 11 | 12 | for (const network of networks) { 13 | console.log("NETWORK: ", network); 14 | 15 | const keystoresGet = { 16 | status: "ok", 17 | data: [ 18 | { 19 | validating_pubkey: networkTestMap.get(network)!.pubkeys[0], 20 | derivation_path: "", 21 | readonly: false, 22 | }, 23 | { 24 | validating_pubkey: networkTestMap.get(network)!.pubkeys[1], 25 | derivation_path: "", 26 | readonly: false, 27 | }, 28 | ], 29 | } as Web3signerGetResponse; 30 | 31 | const beaconchaApi = new BeaconchaApi( 32 | beaconchaApiParamsMap.get(network)! 33 | ); 34 | 35 | const allValidatorsInfo = await beaconchaApi.fetchAllValidatorsInfo({ 36 | keystoresGet, 37 | }); 38 | 39 | expect(allValidatorsInfo[0].data[0].validatorindex).to.equal( 40 | networkTestMap.get(network)!.indexes[0] 41 | ); 42 | expect(allValidatorsInfo[0].data[1].validatorindex).to.equal( 43 | networkTestMap.get(network)!.indexes[1] 44 | ); 45 | } 46 | }); 47 | }); 48 | -------------------------------------------------------------------------------- /ui/src/types.ts: -------------------------------------------------------------------------------- 1 | export enum ImportStatus { 2 | Imported = "Imported", 3 | NotImported = "Not imported", 4 | Importing = "Importing...", 5 | } 6 | 7 | export enum BeaconchaUrlBuildingStatus { 8 | NotStarted, 9 | Success, 10 | Error, 11 | InProgress, 12 | NoIndexes, 13 | } 14 | 15 | export type Web3SignerStatus = "UP" | "DOWN" | "UNKNOWN" | "LOADING" | "ERROR"; 16 | 17 | export type KeystoreInfo = { 18 | file: File; 19 | pubkey: string; 20 | }; 21 | 22 | export interface ApiParams { 23 | baseUrl: string; 24 | apiPath?: string; 25 | authToken?: string; 26 | host?: string; 27 | } 28 | -------------------------------------------------------------------------------- /ui/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es5", 4 | "lib": ["dom", "dom.iterable", "esnext"], 5 | "allowJs": true, 6 | "skipLibCheck": true, 7 | "esModuleInterop": true, 8 | "allowSyntheticDefaultImports": true, 9 | "strict": true, 10 | "forceConsistentCasingInFileNames": true, 11 | "noFallthroughCasesInSwitch": true, 12 | "module": "esnext", 13 | "moduleResolution": "node", 14 | "resolveJsonModule": true, 15 | "isolatedModules": true, 16 | "noEmit": true, 17 | "jsx": "react-jsx", 18 | "useUnknownInCatchVariables": false 19 | }, 20 | "include": ["src"], 21 | "exclude": ["./tests/", "./node_modules/", "./dist/"] 22 | } 23 | --------------------------------------------------------------------------------