Web Monetization Tools

What are Web Monetization Tools?

Web Monetization Tools are marketing tools, that provide website owners with a set of utilities to display payment options as well as information that encourage visitors to use Web Monetization extension alongside payment solution for one-time payments, such as donations.

These tools enable users with an ILP (Interledger Protocol) wallet address to easily customize and generate components that can be embedded into the website by inserting a script into the sites html.

If you are curious about the Web Monetization Tools architecture , then follow this link.

New to Interledger?

Never heard of Interledger before, or you would like to learn more? Here are some good places to start:

• Interledger Explainer Video
• Interledger Website
• Payment pointers
• Web monetization

Contributing

Please read the contribution guidelines before submitting contributions. All contributions must adhere to our code of conduct.

Local Development Environment

Prerequisites

• Docker
• NVM

Environment Setup

# Install Node 20
nvm install lts/iron
nvm use lts/iron

# Install pnpm using Corepack
corepack enable

If you do not have corepack installed locally you can use npm or yarn to install pnpm:

npm install pnpm -g
# or
yarn install pnpm -g

For alternative methods of installing pnpm, you can refer to the official pnpm documentation.

To install dependencies, execute:

pnpm i

HTTPS (required)

The app needs to run with HTTPS, for this you need to generate a self-signed certificate and key. You can use OpenSSL for this.

Install OpenSSL (if you don't already have it):

• Windows: Download and install OpenSSL from here.
• Mac: Use brew install openssl.
• Linux: Install it via your package manager (e.g: sudo apt install openssl ).

Generate the Certificate: From the project root, run the following command in your terminal:

openssl req -x509 -newkey rsa:2048 -keyout ./certs/key.pem -out ./certs/cert.pem -days 365 -nodes

Note The script will prompt for Country, address, organization, etc. As a minimum requirement specify Country (2 letter code) and Organization for the rest you can add . (dot) to set them as empty value

Environment Variables

For the Web monetization tools to function localy, it is also necessary to configure the environment variables appropriately. You must duplicate the example environment file, .env.example, into your local environment file, .env.

Note The local environment file (.env) is NOT tracked in the version control system, and should NOT be included in any commits.

Navigate to the project's root directory and enter the following command:

cp ./docker/dev/.env.example ./docker/dev/.env

Using your preferred text editor, open the ./docker/dev/.env file and configure the necessary environment variables.

The set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY you need to:

• Sign in to the AWS Management Console.
• Navigate to IAM (Identity and Access Management).
• In the left sidebar, select Users, then click the desired user.
• Go to the Security credentials tab.
• Scroll down to Access keys and click Create access key.

To start the containers (in docker)

pnpm localenv:start

to stop them:

pnpm localenv:stop