WalletScrutiny

This is the repository backing WalletScrutiny.com.

Pull Requests are welcome.

Nostr Events Specifications

We're using Nostr to decentralize the data of WalletScrutiny so this data can be used in other applications. If you want to integrate this information into your own application, you can use the following specifications: Verifications.

Installing Required Dependencies

1. Clone the repository: git clone https://gitlab.com/walletscrutiny/walletScrutinyCom; cd walletScrutinyCom
2. Install global dependencies: apt update; apt install nodejs npm ruby-dev ruby-bundler -y
3. Install more global dependencies: npm i --global npm@latest
4. Install npm stuff: npm install; npm install (twice because ... the error I got the first time is gone the second time)
5. Install bundler: gem install bundler:2.1.4
6. Install bundler stuff: bundler install

• Note: when executing gem install bundler:2.1.4 on a Debian/Ubuntu based system, you could encounter an error which sounds something like you need to execute it using sudo. This is not recommended. An alternative method is to configure RubyGems to install gems in your home directory and avoid using sudo for gem installations, follow these steps:

• Set the home path for gems in your .bashrc profile

$ nano ~/.bashrc

• Change the home and the path at the end of the file:

export GEM_HOME="$HOME/gems"
export PATH="$HOME/gems/bin:$PATH"

• Apply the changes with $ source ~/.bashrc

For local development

npm run dev

This is for you if you want to make changes to WalletScrutiny.com application (it's not needed to create a verification). It starts a server that you can reach at localhost:4000 and when you change a source file, it automatically compiles the project and you should see the changes when refreshing the browser.

A full Jekyll regeneration (every layout or include change) renders all ~4,400 wallet pages. npm run dev:fast adds _config.fast.yml, which renders only the wallets starting with "z" and is several times faster; wallet lists and counts are incomplete in that mode.

For production deployment

npm run build

This runs the pre-Jekyll steps (wallet data, webpack, redirect map) in parallel, then Jekyll, then scripts/postprocess-site.mjs, which minifies html, js and css and writes a .br next to every compressible file in one pass over _site/. The result can be found in the _site/ folder, and you can upload the content of this folder to your web server. npm run deploy:prod builds once and runs the unit and E2E tests against that build (PLAYWRIGHT_SKIP_BUILD=1) before uploading it. npm run deploy:beta runs only the unit tests before uploading, then the E2E tests against the same build, so beta gets the new site first and the E2E results after.

The E2E tests do not talk to the live relays. test/e2e/relay-fixture.mjs answers the page's relay WebSockets from test/e2e/fixtures/relay-events.json (real signed events, so nostr-tools, signature checks and rendering all run unchanged). npm run test:e2e:live runs the same suite against the real relays, and npm run record:e2e-relay refreshes the fixture from them. Refresh it when a test needs an event the fixture lacks, and add that event's id to KEEP_IDS in scripts/record-e2e-relay.mjs if it is a large verification.

Old URLs (redirect_from in a page's front matter) are not stub pages but one generated file, redirects.map (scripts/generate-redirect-map.mjs, run by the build before Jekyll), that nginx loads as a map (see external/configs/webserver_nginx/redirects-maps.conf). Reload nginx after each deploy so new entries go live.

Verifying the reproducibility of a wallet

Since the introduction of Nostr in WalletScrutiny, we added a new feature so each user can verify the reproducibility of a wallet and share the result with the community. A user can also register a new asset so that other users can verify the reproducibility of the asset.

See more details at https://walletscrutiny.com/verifications/

The WalletScrutiny Automated Build Server

The WABS is a service that runs on the build server and is responsible for launching automatic verifications when a new version of a wallet is released.

See more details at external/build_server/README.md.