diff --git a/public/img/docs/extension/onboarding-1.png b/public/img/docs/extension/onboarding-1.png index 8b1b35df..dd1bc598 100644 Binary files a/public/img/docs/extension/onboarding-1.png and b/public/img/docs/extension/onboarding-1.png differ diff --git a/public/img/docs/gatehub/advanced-interledger-settings.png b/public/img/docs/gatehub/advanced-interledger-settings.png index 485d9171..9310f981 100644 Binary files a/public/img/docs/gatehub/advanced-interledger-settings.png and b/public/img/docs/gatehub/advanced-interledger-settings.png differ diff --git a/src/content/docs/developers/about-receiving.mdx b/src/content/docs/developers/about-receiving.mdx index c56b9cbb..34960321 100644 --- a/src/content/docs/developers/about-receiving.mdx +++ b/src/content/docs/developers/about-receiving.mdx @@ -9,7 +9,7 @@ Receiving Web Monetization payments requires you to have an account with a compa Your digital wallet provider will supply you with the financial account you’ll use to receive payments. Withdrawing your funds typically requires you to link a card or bank account to your wallet. -Since wallet providers are financial entities, they are regulated within the countries they operate. One regulation, known as KYC (Know Your Customer), requires financial entities to collect your personal information and verify your identity before allowing you to open an account. +Since wallet providers are financial entities, they're regulated within the countries they operate. One regulation, known as Know Your Customer (KYC)), requires financial entities to collect your personal information and verify your identity before allowing you to open an account. ## Web Monetization-compatible digital wallets @@ -17,7 +17,7 @@ You must have an account with a compatible [digital wallet provider](/wallets) t - Is available in your region - Supports your preferred currency -- Allows you to withdraw your funds if you choose to transact in fiat +- Allows you to withdraw your funds if you so choose Your wallet provider will assign your wallet a unique identifier called a _wallet address_ or a _payment pointer_. You’ll need this identifier to web monetize your content. @@ -28,7 +28,7 @@ Your wallet provider will assign your wallet a unique identifier called a _walle ## Web monetized content -Once you have your payment pointer or wallet address, you're ready to add the Web Monetization `` element to each page of your site you want to monetize. Visit the [get started](/developers/get-started) page for more information. +Once you have your wallet address, you're ready to add the Web Monetization `` element to each page of your site you want to monetize. Visit the [get started](/developers/get-started) page for more information. When you include the `` element on a page, you're telling your website visitors' browsers that you can accept Web Monetization payments. Visitors using the [Web Monetization extension](/supporters/get-started) in their browsers can then choose to send you payments in the amount and frequency of their choosing. @@ -42,15 +42,15 @@ If you're already familiar with Web Monetization, you may have heard about how i In general, a micropayment is a very small payment. Each wallet provider is responsible for a few things: -- Deciding whether to support receiving and/or sending micropayments +- Deciding whether to support receiving and sending micropayments - Defining what a micropayment is in the context of their business - Determining the minimum amount for a micropayment -Let's say your wallet provider allows you to receive micropayments. Your provider defines a micropayment as any payment under $0.05 USD. This means you could, for example, receive a payment of one US cent--as long as the sender's wallet provider allows them to send that amount. +Let's say your wallet provider allows you to receive micropayments. Your provider defines a micropayment as any payment under $0.05 USD. This means you could, for example, receive a payment of one US cent--as long as the sender's wallet provider allows them to send that amount. -Your wallet provider may also have business rules set up such that micropayments accumulate on your account but aren't deposited until you reach a minimum (e.g., $1.00 USD). +Your wallet provider may also have business rules set up such that micropayments accumulate on your account but aren't deposited until you reach a threshold amount. -Web Monetization can even support payments of a fraction of a cent (e.g., $0.00001); however, sending and receiving fractional amounts must be supported by the respective wallet providers. +Web Monetization can even support payments of a fraction of a cent, but sending and receiving fractional amounts must be supported by the respective wallet providers. ### A deeper dive into payments @@ -69,7 +69,7 @@ The examples below are simplified representations of the Open Payments API calls ::: -1. The Web Monetization agent locates your [monetization link](/developers/link-element) and extracts your payment URL (the `href` value). +1. The Web Monetization agent locates your [monetization link](/developers/link-element) and extracts your wallet address (the `href` value). ```html @@ -118,7 +118,7 @@ The examples below are simplified representations of the Open Payments API calls } ``` :::note - The `client` in the request above is your visitor's wallet address/payment pointer. This URL is only used by the agent and the wallets, and is not available to the website. + The `client` in the request above is your visitor's wallet address. This URL is only used by the agent and the wallets, and isn't available to the website. ::: 5. The response to the agent contains an access token that the agent needs to make its next request. diff --git a/src/content/docs/developers/activity-streams.mdx b/src/content/docs/developers/activity-streams.mdx index ceaece72..e0535d81 100644 --- a/src/content/docs/developers/activity-streams.mdx +++ b/src/content/docs/developers/activity-streams.mdx @@ -4,7 +4,7 @@ title: Activity Streams JSON-LD import { LinkOut } from '@interledger/docs-design-system' -Social web community servers and apps can expose the wallet address or payment pointer of a user or post to a Web Monetization client, such as the Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension) or embedded SDK. +Social web community servers and apps can expose the wallet address or payment pointer of a user or post to a Web Monetization client, such as Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension) or embedded SDK. The `monetization` property from the Web Monetization namespace (`https://webmonetization.org/ns.jsonld`) applies to an Activity Streams 2.0 `Object`. diff --git a/src/content/docs/developers/csp.mdx b/src/content/docs/developers/csp.mdx index f8edc995..d600c146 100644 --- a/src/content/docs/developers/csp.mdx +++ b/src/content/docs/developers/csp.mdx @@ -9,7 +9,7 @@ import data from '/src/data/browser-compat-data/csp-monetization-src.json' A Content Security Policy (CSP) is an extra layer of security that allows you to control the resources a user agent, such as a web browser, is allowed to load for a given page. CSPs use directives to describe the policies for a certain resource type. -The `monetization-src` fetch directive allows you to define the payment pointer and wallet address URLs that a browser can load. If an attempt is made to load an undefined URL, a network error will occur and the URL will not load. +The `monetization-src` fetch directive allows you to define the payment pointer and wallet address URLs that a browser can load. If an attempt is made to load an undefined URL, a network error will occur and the URL won't load. diff --git a/src/content/docs/developers/events.mdx b/src/content/docs/developers/events.mdx index c65a3361..90726c36 100644 --- a/src/content/docs/developers/events.mdx +++ b/src/content/docs/developers/events.mdx @@ -56,7 +56,7 @@ By adding an event listener to the relevant monetization `` element (or on The `amountSent` property returns the `value` and `currency` of the sent payment. - `value` - The amount. A valid decimal monetary value containing the amount that was sent. -- `currency` - The currency code. A well-formed 3-letter ISO4217 code that represents the currency that was sent, such as USD or GBP. +- `currency` - The currency code. A well-formed 3-letter ISO4217 code that represents the currency that was sent, such as USD (for US dollar) or GBP (for Great Britain Pound). ```js title="Example" "value": "1.23" @@ -64,7 +64,7 @@ The `amountSent` property returns the `value` and `currency` of the sent payment ``` :::note[Received amount] -The `amountSent` is not necessarily the amount received. For example, if your payment account is set up to receive GBP, but your site visitor's account sends in USD, then exchange rates and currency conversion fees could affect the amount you receive. +The `amountSent` isn't necessarily the amount received. For example, if your payment account is set up to receive GBP (Great Britain Pound), but your site visitor's account sends in USD (US dollar), then exchange rates and currency conversion fees could affect the amount you receive. ::: #### Examples using `amountSent` diff --git a/src/content/docs/developers/get-started.mdx b/src/content/docs/developers/get-started.mdx index d7371415..c464f90f 100644 --- a/src/content/docs/developers/get-started.mdx +++ b/src/content/docs/developers/get-started.mdx @@ -10,29 +10,27 @@ import Wallet from '/src/partials/wallet-prereq.mdx' -## Step 1 - Get your payment URL +## Step 1 - Get your wallet address -### Payment pointer - -If you have a payment pointer that starts with `$`, visit paymentpointers.org. Enter your payment pointer into the _Payment Pointer_ field. Take note of the URL that automatically generates in the adjacent field. This is your payment URL. You'll need it in the next step. +Get your wallet address from your wallet provider. ```http title="Example" -$wallet.example.com/alice +https://wallet.example.com/alice ``` -### Wallet address - -If you have a wallet address that starts with `https://`, then you have your payment URL. Proceed to the next step. +Some wallet providers will issue a *payment pointer* instead of a wallet address. Payment pointers begin with `$` instead of `https://`. ```http title="Example" -https://wallet.example.com/alice +$wallet.example.com/alice ``` +If you have a payment pointer, visit paymentpointers.org. Enter it into the _Payment Pointer_ field and take note of the URL that automatically generates. This is your wallet address. + ## Step 2 - Web monetize your page -1. Create your Web Monetization link tag using the format below. Add your payment URL as the `href` value. +1. Create your Web Monetization link tag using the format below. Add your wallet address as the `href` value. ```http diff --git a/src/content/docs/developers/interfaces.mdx b/src/content/docs/developers/interfaces.mdx index 44bb352b..ded4c161 100644 --- a/src/content/docs/developers/interfaces.mdx +++ b/src/content/docs/developers/interfaces.mdx @@ -62,7 +62,7 @@ Visit the [Monetization events](/developers/events) page for more information. The `MonetizationCurrencyAmount` interface is used to populate the `value` and `currency` variables contained within the `MonetizationEvent amountSent` property. - Value - The amount. A valid decimal monetary value containing the amount that was sent. -- Currency - The currency code. An ISO 4217-compliant currency code, when possible, that represents the currency that was sent, such as USD or GBP. +- Currency - The currency code. An ISO 4217-compliant currency code, when possible, that represents the currency that was sent. For example, USD (for US dollar) or GBP (for Great Britain Pound). The `MonetizationCurrencyAmount` interface is modeled on the Payment Request API’s `PaymentCurrencyAmount` dictionary. diff --git a/src/content/docs/developers/libraries.mdx b/src/content/docs/developers/libraries.mdx index c46ee6ca..e06f103b 100644 --- a/src/content/docs/developers/libraries.mdx +++ b/src/content/docs/developers/libraries.mdx @@ -3,7 +3,14 @@ title: Libraries tableOfContents: false --- +import { LinkOut } from '@interledger/docs-design-system' import Libraries from '/src/components/docs/Libraries.astro' import data from '/src/data/home.json' +The most recent draft of the Web Monetization specification (v2.0) introduced updates to be more consistent with the design of other browser features. As a result, libraries that implemented v1.0 of the specification need code updates to be compatible with v2.0. + +We encourage the community to support the Web Monetization ecosystem by updating existing tools/libraries to be compatible with the latest spec and by creating new tools and plugins for frameworks and libraries. + +For more information, check out Santosh's developer guide to migrating the breaking changes in the latest Web Monetization draft. + diff --git a/src/content/docs/developers/link-element-webpage.mdx b/src/content/docs/developers/link-element-webpage.mdx index 01a073f5..8803084d 100644 --- a/src/content/docs/developers/link-element-webpage.mdx +++ b/src/content/docs/developers/link-element-webpage.mdx @@ -12,6 +12,7 @@ import Media from "/src/partials/link-element-media.mdx"; import HowHtml from "/src/partials/link-element-how-html.mdx"; import HowRel from "/src/partials/link-element-how-rel.mdx"; import HowAgent from "/src/partials/link-element-how-agent.mdx"; +import ContPayments from "/src/partials/link-element-cont-payments.mdx"; import Specification from '/src/components/docs/Specification.astro' @@ -55,6 +56,10 @@ import Specification from '/src/components/docs/Specification.astro' ### Web Monetization agent +### Continuous payments + + + ## Specification \ No newline at end of file diff --git a/src/content/docs/developers/link-element.mdx b/src/content/docs/developers/link-element.mdx index c9115b43..1644748e 100644 --- a/src/content/docs/developers/link-element.mdx +++ b/src/content/docs/developers/link-element.mdx @@ -13,6 +13,7 @@ import Media from "/src/partials/link-element-media.mdx"; import HowHtml from "/src/partials/link-element-how-html.mdx"; import HowRel from "/src/partials/link-element-how-rel.mdx"; import HowAgent from "/src/partials/link-element-how-agent.mdx"; +import ContPayments from "/src/partials/link-element-cont-payments.mdx"; import Specification from '/src/components/docs/Specification.astro' @@ -56,6 +57,10 @@ import Specification from '/src/components/docs/Specification.astro' ### Web Monetization agent +### Continuous payments + + + ## Specification \ No newline at end of file diff --git a/src/content/docs/developers/overview.mdx b/src/content/docs/developers/overview.mdx index cdbca06b..75892a6e 100644 --- a/src/content/docs/developers/overview.mdx +++ b/src/content/docs/developers/overview.mdx @@ -6,7 +6,7 @@ tableOfContents: import { LinkOut } from '@interledger/docs-design-system' -Web Monetization is a light-weight and non-intrusive way for you to monetize your content while preserving the privacy of your supporters. You can use Web Monetization to replace or complement your existing revenue models. All it takes is a [wallet address or payment pointer](/wallets) and a [single line of code](/developers/link-element). +Web Monetization is a light-weight and non-intrusive way for you to monetize your content while preserving the privacy of your supporters. You can use Web Monetization to replace or complement your existing revenue models. All it takes is a [wallet address](/wallets) and a [single line of code](/developers/link-element). ## Benefits @@ -17,7 +17,7 @@ Other solutions may require both you and your supporters to use the same applica ### Complement existing revenue models. - **Reach a wider paying audience.** Some offerings, such as subscriptions, can result in missed revenue opportunities due to concerns about price, renewal frequencies, accepted currencies, and fees. Plus, some supporters simply don't want to create and keep track of another account. Web Monetization can supplement your current offerings by allowing your supporters to pay how, when, and what they want without creating site-by-site accounts. -- **Regain lost ad revenue.** If your site is even partially sustained by ad revenue, then every impression counts. Many ad networks pay per thousand impressions, pay different amounts based on the country your supporter is in, and may require you to earn a minimum amount before you can access your revenue. While ad blockers can improve user experience, they also make earning ad revenue more difficult. Web Monetization can help make up the difference. +- **Regain lost ad revenue.** If your site is sustained by ad revenue, then every impression counts. Many ad networks pay per thousand impressions, pay different amounts based on the country your supporter is in, and may require you to earn a minimum amount before you can access your revenue. While ad blockers can improve user experience, they also make earning ad revenue more difficult. Web Monetization can help make up the difference. ### Use in place of other revenue models. @@ -43,13 +43,13 @@ Sending and receiving payments via Web Monetization requires the sender and the In general, wallet providers are regulated entities within the countries they operate. Obtaining the proper licensing and registration to become a wallet provider can be an expensive, complex, and time consuming process. Also, there are technical integrations required to support Web Monetization. All of this means a compatible wallet provider may not yet be available in your area. -### Web Monetization does not track or collect personally identifiable information. +### Web Monetization doesn't track or collect personally identifiable information. -Web Monetization is designed to preserve the privacy of your supporters. While you can use [`monetization`](/developers/events) events to determine sent and received amounts, Web Monetization does not track your supporters' names, wallet addresses/payment pointers, IP addresses, or other information that could enable you to correlate a payment with a specific individual or determine their browsing behavior. +Web Monetization is designed to preserve the privacy of your supporters. While you can use [`monetization`](/developers/events) events to determine payment amounts, Web Monetization doesn't track your supporters' names, wallet addresses, IP addresses, or other information that could enable you to correlate a payment with a specific individual or determine their browsing behavior. -### Web Monetization does not allow you to pull payments from your supporters' accounts. +### Web Monetization doesn't allow you to pull payments from your supporters' accounts. -One key differentiator of Web Monetization is that your supporters are in control of if, when, and how much they pay. Web Monetization does not allow you to pull a payment on behalf of your supporters. When you web monetize a page, you are embedding your wallet address/payment pointer so that your supporters' extension knows you're able to accept Web Monetization payments. It's up to your supporters to decide whether to pay. +One key differentiator of Web Monetization is that your supporters are in control of if, when, and how much they pay. Web Monetization doesn't allow you to pull a payment on behalf of your supporters. When you web monetize a page, you are embedding your wallet address so that your supporters' extension knows you're able to accept Web Monetization payments. It's up to your supporters to decide whether to pay. ### Coding your page to respond after receiving a specific amount will take some work. @@ -57,4 +57,4 @@ Web Monetization is designed to allow supporters to control when to pay, how muc ### There might be fees. -Web Monetization does not charge or collect fees; however, your digital wallet provider might. For example, you may be charged a currency conversion fee if you are sent a payment in USD, but receive your payments in GBP. Be sure to consider supported currencies and fees when choosing a wallet provider that's best for you. +Web Monetization doesn't charge or collect fees, but your digital wallet provider might. For example, you may be charged a currency conversion fee if you are sent a payment in dollars, but receive your payments in pounds. Be sure to consider supported currencies and fees when choosing a wallet provider that's best for you. diff --git a/src/content/docs/developers/permissions-policy.mdx b/src/content/docs/developers/permissions-policy.mdx index ec09469e..762a724c 100644 --- a/src/content/docs/developers/permissions-policy.mdx +++ b/src/content/docs/developers/permissions-policy.mdx @@ -10,7 +10,7 @@ import Specification from '/src/components/docs/Specification.astro' import BrowserCompat from '/src/components/docs/BrowserCompat.astro' import data from '/src/data/browser-compat-data/permissionpolicy.json' -A Permissions Policy provides a mechanism for you to explicitly declare what functionality can and cannot be used on your website. +A Permissions Policy provides a mechanism for you to explicitly declare what functionality can and can't be used on your website. The `monetization` policy directive allows you to enable and disable the Web Monetization API within a document and within any of the document's nested browsing contexts (iframes). diff --git a/src/content/docs/developers/rss-atom-jsonfeed.mdx b/src/content/docs/developers/rss-atom-jsonfeed.mdx index 67899822..ed3e3993 100644 --- a/src/content/docs/developers/rss-atom-jsonfeed.mdx +++ b/src/content/docs/developers/rss-atom-jsonfeed.mdx @@ -4,7 +4,7 @@ title: RSS, Atom, and JSON Feed import { LinkOut } from '@interledger/docs-design-system' -Web Monetization links can be used with content syndication formats [RSS 2.0](#rss-20), [Atom XML](#atom), and [JSON Feed](#json-feed). Feed readers and podcasting apps can expose a piece of content’s wallet address or payment pointer to a Web Monetization client, such as the Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension) or embedded SDK. +Web Monetization links can be used with content syndication formats [RSS 2.0](#rss-20), [Atom XML](#atom), and [JSON Feed](#json-feed). Feed readers and podcasting apps can expose a piece of content’s wallet address or payment pointer to a Web Monetization client, such as Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension) or embedded SDK. ## RSS 2.0 diff --git a/src/content/docs/developers/tools.mdx b/src/content/docs/developers/tools.mdx index 22c97ca9..b47bcf7d 100644 --- a/src/content/docs/developers/tools.mdx +++ b/src/content/docs/developers/tools.mdx @@ -11,7 +11,7 @@ next: import { LinkButton } from '@astrojs/starlight/components'; import { LinkOut } from "@interledger/docs-design-system"; -The Publisher Tools page provides a collection of easy-to-customize components that you can use to promote Web Monetization and encourage your visitors to support you. +The publisher tools page provides a collection of easy-to-customize components that you can use to promote Web Monetization and encourage your visitors to support you. ## Banner diff --git a/src/content/docs/docs.mdx b/src/content/docs/docs.mdx index 632d1582..46f437ea 100644 --- a/src/content/docs/docs.mdx +++ b/src/content/docs/docs.mdx @@ -16,5 +16,5 @@ Site visitors can make a one-time contribution or send small continuous payments - + \ No newline at end of file diff --git a/src/content/docs/guides/receive-test-payments.mdx b/src/content/docs/guides/receive-test-payments.mdx index bab7c677..d75adbcb 100644 --- a/src/content/docs/guides/receive-test-payments.mdx +++ b/src/content/docs/guides/receive-test-payments.mdx @@ -5,12 +5,12 @@ title: Receive test payments import { Steps, Icon, Card } from '@astrojs/starlight/components' import { LinkOut, StylishHeader } from '@interledger/docs-design-system' -Use the Interledger's Web Monetization browser extension and Playground to receive payments without using real money. +Use Interledger Foundation's Web Monetization browser extension and Playground to receive payments without using real money. This tutorial takes you through using one funded test wallet to send and receive payments. In other words, the wallet you'll send payments from is the same wallet that will receive payments. :::tip[Before you begin] -You must have at least one [funded test wallet account](/guides/test-wallet-sign-up) on the Interledger Foundation's test network and [install and configure](/guides/send-test-payments) the Web Monetization browser extension. +You must have at least one [funded test wallet account](/guides/test-wallet-sign-up) on Interledger Foundation's test network and [install and configure](/guides/send-test-payments) the Web Monetization browser extension. ::: ## Web Monetization Playground @@ -19,7 +19,7 @@ The Web Monetization Playgroun Your browser extension will send payments to the address you enter if your wallet provider and the address's wallet provider can transact with one another. -If your browser extension is connected to a wallet that uses real money and you enter an address that your wallet provider can transact with, you will be making real payments. For the tutorials on this page, we are using fake money. +If your browser extension is connected to a wallet that uses real money and you enter an address that your wallet provider can transact with, you will be making real payments. For the tutorials on this page, we're using fake money. ## Receive continuous payments @@ -30,10 +30,10 @@ If your browser extension is connected to a wallet that uses real money and you :::note[Forgot your payment pointer?] Open the extension and select the cog icon. Then, select the **Wallet** tab and copy your payment pointer from the **Connected wallet address** field. ::: - 4. Remain on the Playground page, with the window active, long enough for a few events to appear on the page. The amount of time it takes for events to appear depends on the rate you have set up in the extension.If your rate is €0.60 EUR an hour, then it will take 5-6 minutes for three events to appear. + 4. Remain on the Playground page, with the window active, long enough for a few events to appear on the page. The time it takes for events to appear depends on the rate you have set up in the extension.If your rate is €0.60 EUR an hour, then it will take 5-6 minutes for three events to appear. 5. Select **Disable** to stop the payments. - 6. Sign in to your Interledger test wallet and select **Transactions** from the left menu. A completed outgoing payment appears for each event, as well as a single pending incoming payment with a zero amount.To mimic how a real wallet provider could act, the Interledger test network deducts a 0.01 fee from each outgoing payment. If your rate is €0.60 EUR an hour, each Playground event will show 0.01 EUR while each outgoing payment in your transaction list will show -€0.02. - 7. Wait 10 minutes, then refresh the page. The pending incoming transaction will show as completed and reflect the amount deposited into your wallet.If your rate is €0.60 EUR an hour and you waited for three Playground events, your incoming payment will be €0.03. + 6. Sign in to your Interledger test wallet and select **Transactions** from the left menu. A completed outgoing payment appears for each event, as well as a single pending incoming payment with a zero amount.To mimic how a real wallet provider could act, the Interledger test network deducts a 0.01 fee from each outgoing payment. If your rate is €0.60 EUR an hour, each Playground event will show €0.01 EUR while each outgoing payment in your transaction list will show a debit of €0.02. + 7. Wait 10 minutes, then refresh the page. The pending incoming transaction will show as completed and reflect the amount deposited into your wallet.If your rate is €0.60 EUR an hour and you waited for three Playground events, your incoming payment will be approximately €0.03. ## Receive a one-time payment @@ -44,4 +44,4 @@ If your browser extension is connected to a wallet that uses real money and you Open the extension and select the cog icon. Then, select the **Wallet** tab and copy your payment pointer from the **Connected wallet address** field. ::: 3. Open the extension, enter a one-time payment amount, then click **Send now**. A new event will appear in the Playground almost immediately. - 4. Sign in to your Interledger test wallet and select **Transactions** from the left menu. A completed outgoing and incoming payment will appear.To mimic how a real wallet provider could act, the Interledger test network deducts a 0.01 fee from each outgoing payment. If you made a one-time payment of €1.00 EUR, the completed incoming payment will be for €0.99. \ No newline at end of file + 4. Sign in to your Interledger test wallet and select **Transactions** from the left menu. A completed outgoing and incoming payment will appear.To mimic how a real wallet provider could act, the Interledger test network deducts a 0.01 fee from each outgoing payment. If you made a one-time payment of €1.00 EUR, the completed incoming payment will be for €0.99. \ No newline at end of file diff --git a/src/content/docs/guides/send-test-payments.mdx b/src/content/docs/guides/send-test-payments.mdx index 48631f09..01751d60 100644 --- a/src/content/docs/guides/send-test-payments.mdx +++ b/src/content/docs/guides/send-test-payments.mdx @@ -5,18 +5,18 @@ title: Send test payments import { Steps, Icon } from '@astrojs/starlight/components' import { LinkOut, StylishHeader } from '@interledger/docs-design-system' -Use the Interledger Web Monetization browser extension to send payments to a web monetized site without using real money. +Use Interledger Foundation's Web Monetization browser extension to send payments to a web monetized site without using real money. :::tip[Before you begin] -You must have a [funded test wallet account](/guides/test-wallet-sign-up) on the Interledger Foundation's test network. +You must have a [funded test wallet account](/guides/test-wallet-sign-up) on Interledger Foundation's test network. ::: ## Install the extension 1. Sign in to your wallet account. - 2. Download and install the Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension). - 3. Enter the payment pointer associated with your test wallet and a budget amount, then click **Connect**.
Extension setup screen with wallet address and amount fields, renew monthly toggle, and connect button 4. Click **Agree** to allow the extension to connect to your wallet. 5. Click **Accept** on the Interledger request screen. @@ -24,7 +24,7 @@ You must have a [funded test wallet account](/guides/test-wallet-sign-up) on the ## Configure continuous payments (optional) -By default, the extension sends continuous payments at a rate of $0.60 USD an hour ($0.01 a minute), or the equivalent in your chosen currency based on the exchange rate. +By default, the extension sends continuous payments at a rate of $0.60 USD an hour ($0.01 a minute), or the equivalent in your chosen currency based on the exchange rate. To change the rate of pay: @@ -36,7 +36,7 @@ To change the rate of pay: Visit https://sidvishnoi.com/test/wm/. -This page's test wallet receives all payments in Mexican pesos (MXN) regardless of the currency you chose to use for your own test wallet. +This page's test wallet receives all payments in Mexican pesos (MX$) regardless of the currency you chose to use for your own test wallet. Check the status of the extension. @@ -47,7 +47,7 @@ Check the status of the extension. Each payment appears within the *Monetization events* section on the test site.
Monetization events section showing two payments of MXN 0.21 -If your extension is using USD with the default rate of $0.60 an hour, a new event appears on the site about every two minutes as long as the window is active. Continuous (streaming) Web Monetization payments stop when the window is inactive. Keep the window active until a few payment events appear. Then, sign in to your wallet account and select **Transactions** to see the payments you've sent. +If your extension is using USD with the default rate of $0.60 an hour, a new event appears on the site about every two minutes as long as the window is active. Continuous (streaming) Web Monetization payments stop when the window is inactive. Keep the window active until a few payment events appear. Then, sign in to your wallet account and select **Transactions** to see the payments you've sent. ## Send a one-time payment diff --git a/src/content/docs/guides/test-wallet-sign-up.mdx b/src/content/docs/guides/test-wallet-sign-up.mdx index 6c9c5357..ff071c74 100644 --- a/src/content/docs/guides/test-wallet-sign-up.mdx +++ b/src/content/docs/guides/test-wallet-sign-up.mdx @@ -5,7 +5,7 @@ title: Sign up for a test wallet account import { Steps, Icon } from '@astrojs/starlight/components' import { LinkOut, StylishHeader } from '@interledger/docs-design-system' -Sign up for a test wallet with the Interledger Foundation to experiment with sending and receiving Web Monetization payments without using real money. +Sign up for a test wallet with Interledger Foundation to experiment with sending and receiving Web Monetization payments without using real money. ## Step 1 - Create an account @@ -21,7 +21,7 @@ Sign up for a test walletKYC steps. +Interledger Foundation's test wallet runs on a GateHub pre-production environment. This environment mimics their production environment, including many of their KYC steps. ::: ## Step 3 - Add a payment pointer diff --git a/src/content/docs/resources/get-involved.mdx b/src/content/docs/resources/get-involved.mdx index bb8b57c0..85396145 100644 --- a/src/content/docs/resources/get-involved.mdx +++ b/src/content/docs/resources/get-involved.mdx @@ -18,7 +18,7 @@ import { LinkOut } from '@interledger/docs-design-system' - Build applications with new and varied use cases around Web Monetization. For example, you could: - Add Web Monetization to your favorite open source project. - Create tools to allow websites to interact with web monetized visitors. Visual indicators, like celebration confetti, thank you notes, or payment counters are just a few ways to promote interaction. -- Contribute to the Interledger Foundation's Web Monetization extension by coding or testing. +- Contribute to Interledger Foundation's Web Monetization extension by coding or testing. ## Community events and hackathons diff --git a/src/content/docs/resources/glossary.mdx b/src/content/docs/resources/glossary.mdx index 5a1bb09f..a059e9b9 100644 --- a/src/content/docs/resources/glossary.mdx +++ b/src/content/docs/resources/glossary.mdx @@ -8,11 +8,11 @@ import { LinkOut } from '@interledger/docs-design-system'
-### Interledger Foundation (ILF) +### Interledger Foundation -The Interledger Foundation (ILF) is a global nonprofit foundation and steward of the Interledger Protocol, the Open Payments standard, and Web Monetization. +The Interledger Foundation is a global nonprofit foundation and steward of the Interledger Protocol, the Open Payments standard, and Web Monetization. -The ILF offers an open source [Web Monetization browser extension](/supporters/get-started) that showcases a pay-as-you-browse model, allowing you to define how often and how much to pay to web monetized websites. +Interledger Foundation offers an open source [Web Monetization browser extension](/supporters/get-started) that showcases a pay-as-you-browse model, allowing you to define how often and how much to pay to web monetized websites. ## O @@ -33,11 +33,13 @@ Wallet providers who support Open Payments issues each of their customers' accou ### Payment pointer -A payment pointer is a secure, unique identifier that's assigned to payment accounts that use the Interledger Simple Payment Setup Protocol (SPSP) to exchange payment information. The shorthand for a payment pointer starts with `$`. For example, `$wallet.example.com/alice`. +A payment pointer is similar to a wallet address. Where a wallet address begins with `https://`, a payment pointer begins with `$`. For example, `$wallet.example.com/alice`. Most payment pointers can be converted to wallet addresses by simply replacing the `$` with `https://`. For example, `https://wallet.example.com/alice`. -As a consumer of web monetized content, you'll enter your payment pointer into your Web Monetization extension to link the extension to your wallet. +Whether a wallet provider chooses to call their payment addresses *wallet addresses* or *payment pointers* is up to the provider, so you should become familiar with both terms. -To web monetize your own content, you must convert your payment pointer to its URL equivalent as the monetization `` element doesn't support the `$` in the `href` value. Enter your payment pointer into the field provided on paymentpointers.org to get your URL. +If you're setting up Interledger Foundation's Web Monetization extension, you can enter either a wallet address (`https://`) or a payment pointer (`$`). + +If you have a payment pointer and are monetizing your own content, the monetization `` element doesn't support the `$` in the `href` value. You must change the `$` to `https://`. ## T @@ -45,7 +47,7 @@ To web monetize your own content, you must convert your payment pointer to its U ### Test wallet -The test wallet is a wallet application provided by the ILF that lets you experiment with Web Monetization without using real money. You'll go through a typical Know Your Customer (KYC) sign-up flow, fund an account with play money, and get a payment pointer. +The test wallet is a wallet application provided by Interledger Foundation that lets you experiment with Web Monetization without using real money. You'll go through a typical Know Your Customer (KYC) sign-up flow, fund an account with play money, and get a payment pointer. [Sign up for a wallet account](/guides/test-wallet-sign-up), then test [sending](/guides/send-test-payments) and [receiving](/guides/receive-test-payments) payments using fake money. @@ -79,7 +81,7 @@ A Web Monetization agent is a non-user facing component of a Web Monetization ex - Instrument payments by calling the Open Payments APIs - Fire `monetization` events after an outgoing payment request is created - Process `monetization` events sent to the browser window via the `onmonetization` event handler -- Enable CSP `monetization-src` and Permissions Policy `monetization` directives +- Enable Content Security Policy (CSP) `monetization-src` and Permissions Policy `monetization` directives ### Web Monetization service provider diff --git a/src/content/docs/supporters/about-sending.mdx b/src/content/docs/supporters/about-sending.mdx index 053d9a4b..19589a4f 100644 --- a/src/content/docs/supporters/about-sending.mdx +++ b/src/content/docs/supporters/about-sending.mdx @@ -9,7 +9,7 @@ Sending Web Monetization payments requires you to have an account with a compati Your digital wallet provider will supply you with the financial account you'll use to send payments. Funding your wallet typically requires you to link a card or bank account to your wallet or make a deposit into your wallet. -Since wallet providers are financial entities, they are regulated within the countries they operate. One regulation, known as KYC (Know Your Customer), requires financial entities to collect your personal information and verify your identity before allowing you to open an account. +Since wallet providers are financial entities, they're regulated within the countries they operate. One regulation, known as Know Your Customer (KYC), requires financial entities to collect your personal information and verify your identity before allowing you to open an account. Sometimes the verification process can take up to 24 hours. ## Web Monetization-compatible digital wallets @@ -30,7 +30,7 @@ Your wallet provider will assign your wallet a unique identifier called a _walle The [Web Monetization extension](/supporters/get-started#install-the-extension) allows you to send payments. It links to your digital wallet account so that it can send payments from your wallet on your behalf. -When you set up the extension, you set your budget. Your budget is the max amount that the extension has access to. You can also set the amount that the extension will send per hour. The default is $0.60. +When you set up the extension, you set your budget. Your budget is the max amount that the extension has access to. You can also set the amount that the extension will send per hour. The default is $0.60 USD. If you're using a different currency, the extension will update to the closest equivalent amount. As you browse, the extension checks each page for Web Monetization. When found, the extension grabs the information it needs from the page's code to set up a payment based on your settings. @@ -46,14 +46,14 @@ If you're already familiar with Web Monetization, you may have heard about how i In general, a micropayment is a very small payment. Each wallet provider is responsible for: -- Deciding whether to support sending and/or receiving micropayments +- Deciding whether to support sending and receiving micropayments - Defining what a micropayment is in the context of their business - Determining the minimum amount for a micropayment #### Example 1 -Your wallet provider allows you to send micropayments. They've decided that a micropayment is any payment under $0.05 USD; however, the minimum amount they support is $0.01. This means you could, for example, send a payment as low as one US cent. +Your wallet provider allows you to send micropayments. They've decided that a micropayment is any payment under $0.05 USD, but the minimum amount they support is $0.01. This means you could, for example, send a payment as low as one US cent. #### Example 2 -Your wallet provider allows you to send micropayments. They've decided that a micropayment is a fraction of a US cent, with a minimum value of one hundredth of a cent. This means you could, for example, send a payment as low as $0.0001 USD. +Your wallet provider allows you to send micropayments. They've decided that a micropayment is a fraction of a US cent, with a minimum value of one hundredth of a cent. This means you could, for example, send a payment as low as $0.0001 USD. diff --git a/src/content/docs/supporters/get-started.mdx b/src/content/docs/supporters/get-started.mdx index d461b692..e9aa268b 100644 --- a/src/content/docs/supporters/get-started.mdx +++ b/src/content/docs/supporters/get-started.mdx @@ -6,22 +6,22 @@ import { Steps, Tabs, TabItem } from '@astrojs/starlight/components' import { LinkOut, StylishHeader } from '@interledger/docs-design-system' import ExtensionLinks from "/src/components/ExtensionLinks.astro" -The Interledger Foundation's Web Monetization browser extension lets you support your favorite web monetized sites directly from your web browser in a quick, non-intrusive, and privacy-preserving way. +Interledger Foundation's Web Monetization browser extension lets you support your favorite web monetized sites directly from your web browser in a quick, non-intrusive, and privacy-preserving way.
About web monetized sites -You can only use the extension to send payments to web monetized sites. Since Web Monetization is a newer technology, the Interledger Foundation encourages content owners and publishers to tell their audience they're web monetized via a banner or some other method. +You can only use the extension to send payments to web monetized sites. Interledger Foundation encourages content owners and publishers to tell their audience they're web monetized via a banner or some other method. If you're interested in web monetizing your own content, the [get started](/developers/get-started) page for developers is a good place to start.
About Web Monetization payments -To make Web Monetization payments, you only need a digital wallet from a Web Monetization-compatible [wallet provider](/wallets). There's no site-by-site account or subscription required for each individual site you want to support. +To make Web Monetization payments, you only need a digital wallet account from a Web Monetization-compatible [wallet provider](/wallets). There's no site-by-site account or subscription required. -A web monetized site cannot pull payments from your digital wallet. When you link the browser extension to your digital wallet, you're giving the extension permission to send payments on your behalf. These payments are automatically and continuously sent to each web monetized site you visit. You can also globally [disable continuous payments](#set-up-continuous-payments). +A web monetized site can't pull payments from your wallet. When you link the browser extension to your wallet, you're giving the extension permission to send payments on your behalf. These payments are automatically and continuously sent to each web monetized site you visit. You can also globally [disable continuous payments](#set-up-continuous-payments). -The sites you pay are not provided with any of your personally identifiable information, such as your name, email address, or IP address. +The sites you pay aren't provided with any of your personally identifiable information, such as your name, email address, or IP address.
## Install the extension @@ -39,9 +39,9 @@ After you install the extension, a page appears to guide you though the configur 1. Get a Web Monetization-compatible [wallet](/wallets).
An image of the onboarding screen showing the four steps to configure the extension :::note - You may experience a delay before you can fund your wallet while your provider performs any necessary regulatory checks. + You may experience a delay before you can fund your wallet while your provider performs necessary regulatory checks. ::: - 2. Find and copy your wallet address or payment pointer. You'll need it for Step 4. Your wallet provider will assign one to you during sign up. The exact naming depends on what your provider has chosen to use.
The Interledger Wallet dashboard displaying a wallet address + 2. Find and copy your wallet address (Interledger) or payment pointer (GateHub). You'll need it for Step 4.
Interledger Wallet dashboard displaying a wallet address ``` @@ -58,9 +58,9 @@ After you install the extension, a page appears to guide you though the configur 4. Enter the wallet address or payment pointer you found in Step 2.
Set up screen with fields for wallet address/payment pointer and amount and a renew monthly toggle (default is off). 5. Enter the amount the extension will have permission to send and select whether the amount should renew monthly. You can always [change these settings](#adjust-your-budget) later. :::note - The amount and renewal frequency is specific to the extension you're currently setting up. If you install the extension on a different browser and connect to the same wallet, that extension will have a separate budget. Payments made from one budget do not affect the balance of the other. + The amount and renewal frequency is specific to the extension you're setting up. If you install the extension on a different browser and connect to the same wallet, that extension will have a separate budget. Payments made from one budget don't affect the balance of the other. ::: - 6. Click **Connect**, then click **Agree** to allow the extension to connect to your wallet and add a key to your account.
Consent screen for allowing the extension to connect to your wallet with agree and decline buttons + 6. Click **Connect**, then click **Agree** to allow the extension to connect to your wallet account.
Consent screen for allowing the extension to connect to your wallet with agree and decline buttons :::note If your wallet provider's website opens in your browser, proceed to the next step. If you receive a connection error, review the instructions for [resolving the error](#resolve-a-key-addition-failure). ::: @@ -72,13 +72,13 @@ After you install the extension, a page appears to guide you though the configur ### About continuous payments -By default, the extension is set to send continuous payments at a rate of $0.60 USD an hour ($0.01 a minute). If you transact in a currency other than USD, then the extension will default to your currency's equivalent based on the exchange rate. For example, imagine you transact in Mexican pesos. If $0.60 is equivalent to $12.24 MXN, then the extension will default to $12.24 MXN an hour. +By default, the extension is set to send continuous payments at a rate of $0.60 USD an hour ($0.01 a minute). If you transact in a currency other than USD, then the extension will default to your currency's equivalent based on the exchange rate. For example, if you transact in Mexican pesos, $0.60 USD is equivalent to around MX $11.70. The extension will default to MX $11.70 an hour. Payments continue for as long as a web monetized page is active and in view. Continuous payments stop if you: * Disable the extension * Disable continuous payments within the extension's settings * Minimize your browser -* Switch to a different tab +* Change the focus away from the tab/switch to a different tab * Close the tab or browser * Spend all of your budget @@ -96,7 +96,7 @@ Payments continue for as long as a web monetized page is active and in view. Con You can make a one-time payment to a page instead of -- or in addition to -- continuous payments. The amount of the one-time payment is deducted from your budget. - 1. Ensure the URL shown above the amount field is the page you intend to pay.
Extension showing an available balance of five dollars, with one dollar in the amount field and send now button active + 1. Ensure the address shown above the amount field is the page you intend to pay.
Extension showing an available balance of five dollars, with one dollar in the amount field and send now button active 2. Enter an amount. Be sure your balance can cover the amount, otherwise the payment will fail. Click **Send now**.
Extension showing an available balance of four dollars, with a success message indicating one dollar was sent @@ -106,7 +106,12 @@ You can make a one-time payment to a page instead of -- or in addition to -- con Your budget is the amount you've given the extension permission to spend from your wallet. If you spend your budgeted amount, the extension will display an orange circle in the toolbar and show an "out of funds" message. You can manually add more funds using the steps below. -If your budget is set to renew monthly and you are out of funds, you can either wait for your budget to renew (your renewal date is shown in the extension) or manually add funds. If you choose to add more funds, the amount you enter will become your new renewal amount and your renewal date will change. +If your budget is set to renew monthly and you are out of funds, you can: + +* Wait for your budget to renew (your renewal date is shown in the extension) or +* Manually add funds + +If you choose to add more funds, the amount you enter will become your new renewal amount and your renewal date will change. ### Change your budget settings @@ -118,7 +123,7 @@ If your budget is set to renew monthly and you are out of funds, you can either 3. Enter the new amount in the **Budget amount** field. 4. Select the **Monthly** toggle to enable/disable monthly renewals of your budget. 5. Click **Submit changes**. A new tab opens to your wallet provider. - 6. Sign in to your wallet account if you haven't already, then confirm the new budget. + 6. Sign in to your wallet account if needed, then confirm the new budget. ## Disconnect the extension from your wallet @@ -129,7 +134,7 @@ When you disconnect the extension from your wallet, the extension can no longer When you disconnect the extension, your remaining balance, if any, remains in your wallet. ::: -The extension only supports one wallet connection at a time. If, for example, you have two wallets from which you want to make payments, you must disconnect from the first wallet before you can connect the extension to your second wallet. +The extension only supports one wallet connection at a time. For example, if you have two wallet accounts from which to make payments, you must disconnect from the first wallet before you can connect the extension to your second wallet. 1. Click the **Settings** icon in the upper-right of the extension.
Extension showing a cog icon in the upper-right![Continuous payments turned off in extension](/img/docs/extension/disabled-monetized.png 'Inactive icon state with green circle and checkmark') | Page is web monetized, but the extension is **not** continuously paying | |
![Continuous payments turned off in extension, needs user attention](/img/docs/extension/disabled-attention.png 'Inactive icon state with orange circle and exclamation mark')
| Page is web monetized, but the extension needs user attention and is **not** continuously paying | -|
![Continuous payments turned off in extension, page is not web monetized](/img/docs/extension/disabled-unmonetized.png 'Inactive icon state with red circle and x')
| Page is **not** web monetized, so the extension is **not** continuously paying | +|
![Continuous payments turned off in extension, page isn't web monetized](/img/docs/extension/disabled-unmonetized.png 'Inactive icon state with red circle and x')
| Page is **not** web monetized and the extension is **not** continuously paying | ## FAQ @@ -193,7 +198,7 @@ When the **Continuous payment** toggle is on, the extension icon appears in colo I get an error from my wallet provider when linking the extension to my wallet. Why? It's hard to say without a specific error message. Two likely scenarios are: * You waited too long to accept the connection. Your wallet provider might only give you a short window to accept the connection to keep your account safe. -* You accepted the connection too quickly--within seconds. Your wallet provider may do this as a security measure against bots or to ensure you've read the contents of the screen. Interledger Wallet, for example, enforces a minimum five second wait. +* You accepted the connection too quickly--within a few seconds. Your wallet provider may do this as a security measure against bots or to ensure you've read the contents of the screen. Interledger Wallet, for example, enforces a minimum five second wait. Click **Connect** and try linking your extension again. @@ -201,7 +206,7 @@ Click **Connect** and try linking your extension again.
I know the page I'm visiting is web monetized, but the extension says its not. Why? -The most likely reason is that your wallet provider and the content owner or publisher's wallet provider are not yet able to transact with one another. Your extension will display an exclamation mark within an orange circle. Open the extension to read the messaging. +The most likely reason is that your wallet provider and the content owner or publisher's wallet provider are unable to transact with one another. Your extension will display an exclamation mark within an orange circle. Open the extension to read the messaging. Visit the [Web Monetization-enabled wallets](/wallets) page for a list of compatible wallet providers. diff --git a/src/content/docs/supporters/overview.mdx b/src/content/docs/supporters/overview.mdx index fc344f7f..48adbe73 100644 --- a/src/content/docs/supporters/overview.mdx +++ b/src/content/docs/supporters/overview.mdx @@ -8,17 +8,17 @@ import { LinkOut } from '@interledger/docs-design-system' Web Monetization is an immediate and secure way for you to support websites, content owners, and publishers. -With Web Monetization, you can express your gratitude by making a one-time contribution or by sending small continuous payments as you spend time on their content. All you need is a wallet address or payment pointer, and the Interledger Foundation's Web Monetization browser extension. Visit the [Get started](/supporters/get-started) page for details. +With Web Monetization, you can express your gratitude by making a one-time contribution or by sending small continuous payments as you spend time on their content. Visit the [Get started](/supporters/get-started) page for instructions. ## Benefits ### Control who, when, and how much to pay. -All payments to web monetized sites must be explicitly authorized or pre-authorized by you. Sites cannot pull payments from your payment account under any circumstance. +All payments to web monetized sites must be explicitly authorized or pre-authorized by you. Sites can't pull payments from your payment account under any circumstance. ### Your payments are private. -Web Monetization does not provide the recipient with personally identifiable information such as your name, wallet address/payment pointer, IP address, or anything else the recipient could use to correlate a payment with you. +Web Monetization doesn't provide the recipient with personally identifiable information such as your name, wallet address/payment pointer, IP address, or anything else the recipient could use to correlate a payment with you. ### You choose your wallet provider. @@ -28,7 +28,7 @@ Some solutions require you to sign up for a particular application, platform, or Part of setting up the Web Monetization extension involves linking the extension to your wallet. This link allows the extension to communicate with your wallet without storing sensitive payment details in the extension or in the browser itself. -### Web Monetization is not tied to a specific currency. +### Web Monetization isn't tied to a specific currency. Part of choosing a compatible digital wallet is selecting one that allows you to pay in your preferred currency. When you send a payment, the recipient will receive it in the currency they selected when signing up with their compatible wallet provider. @@ -38,9 +38,9 @@ The only account you need is the one you create with your wallet provider. You d ## Constraints -### Web Monetization is not an ad blocker. +### Web Monetization isn't an ad blocker. -Sending a payment to a web monetized site does not guarantee an ad-free experience. Web Monetization provides publishers an alternative revenue model to ads, but the decision to not load ads in response to a payment is entirely theirs. +Sending a payment to a web monetized site doesn't guarantee an ad-free experience. Web Monetization provides publishers an alternative revenue model to ads, but the decision whether to load ads in response to a payment is entirely theirs. ### The network of Web Monetization-enabled wallet providers is nascent, but growing. diff --git a/src/content/docs/tutorials/contribution-counter.mdx b/src/content/docs/tutorials/contribution-counter.mdx index 7a5ebaf1..f29a741f 100644 --- a/src/content/docs/tutorials/contribution-counter.mdx +++ b/src/content/docs/tutorials/contribution-counter.mdx @@ -5,7 +5,7 @@ title: Show visitors how much they've contributed import Wallet from '/src/partials/wallet-prereq.mdx' import Disclaimer from '/src/partials/glitch.mdx' -In this tutorial, you'll create a script that will display a counter on your page. The counter will show your visitors how much they've contributed while on the page during their current browsing session. The counter updates in real time and reflects both time-based payments (e.g., X amount per minute) and one-time payments. +In this tutorial, you'll create a script that will display a counter on your page. The counter will show your visitors how much they've contributed while on the page during their current browsing session. The counter updates in real time and reflects both time-based payments (X amount per minute) and one-time payments. ### Before you begin @@ -23,7 +23,7 @@ For visitors with Web Monetization, the counter will update based on the amount ## Create your script -Use the `monetization` event to show a web monetized visitor how much they've sent in USD. +Use the `monetization` event to show a web monetized visitor how much they've sent in $ USD. ### The code @@ -69,7 +69,7 @@ Use the `monetization` event to show a web monetized visitor how much they've se We’ll bind the `monetization` event if the visitor is web monetized (`window.MonetizationEvent` is defined). -The `monetization` event contains details about the payments that occur. The `amountSent` attribute of the event returns the amount (`value`) and `currency` code of the sent payment. A currency code is a three-letter code, like USD, EUR, or GBP. +The `monetization` event contains details about the payments that occur. The `amountSent` attribute of the event returns the amount (`value`) and `currency` code of the sent payment. A currency code is a three-letter code, like USD for US dollar, EUR for the euro, or GBP for Great Britain Pound. ```javascript {1,6} if (window.MonetizationEvent) { diff --git a/src/content/docs/tutorials/revenue-sharing.mdx b/src/content/docs/tutorials/revenue-sharing.mdx index 26265f2e..e58b9d18 100644 --- a/src/content/docs/tutorials/revenue-sharing.mdx +++ b/src/content/docs/tutorials/revenue-sharing.mdx @@ -18,7 +18,7 @@ In this tutorial, you'll define a list of recipients and their weights and creat The chance of a recipient's wallet address or payment pointer being chosen is equal to their expected share of the revenue. -The simplest way weight is by assigning values that add up to 100. For example, if Alice has a weight of 75 and Bob has a weight of 25, then Alice has a 75% chance of being chosen. This means ~75% of web monetized visitors will be paying to Alice (and 25% to Bob). Because the random choice is not correlated to other variables like the length of time the visitor spends on the page, the laws of probability say that Alice’s share will approach 75% of the page’s total revenue as more users visit the site. +The simplest way weight is by assigning values that add up to 100. For example, if Alice has a weight of 75 and Bob has a weight of 25, then Alice has a 75% chance of being chosen. This means ~75% of web monetized visitors will be paying to Alice (and 25% to Bob). Because the random choice isn't correlated to other variables like the length of time the visitor spends on the page, the laws of probability say that Alice’s share will approach 75% of the page’s total revenue as more users visit the site. Another way is to use weighting factors. The higher a recipient's weight, the heavier/more important it is. This translates into a higher share of revenue. For example, if three recipients each have a weight of 1, then they all equally important. Each recipient will eventually receive ~33% of the revenue (100 divided by 3 recipients). If Alice has a weight of 1, Bob a weight of 2, and Carol a weight of 3, then their percentages will be ~17, 33, and 50, respectively. @@ -28,7 +28,7 @@ If you'd prefer not to use a script, you can use our Interledger Wallet | USA, EU, Canada, South Africa | USD, EUR, CAD, ZAR | -| GateHub | EU | EUR | +| Interledger Wallet | USA, Canada, EU, South Africa | $ USD, $ CAD, € EUR, R ZAR | +| GateHub* | USA, EU | $ USD, € EUR | -This table will be updated as more wallet providers become available. +* Select *Hosted* wallet during setup + +Some wallet providers will allow you to select your own wallet address. A wallet address will look like this: `https://interledger.app/`. + +### Supported currencies + +When choosing a wallet provider for Web Monetization, be sure to select one that supports your preferred currency. Wallet providers may support different currencies, including cryptocurrencies. + +### Wallet addresses and payment pointers + +Some wallet providers will use the term *wallet address* while others use the term *payment pointer*. Wallet addresses contain `https://` while payment pointers contain `$`. + + + + ``` + https://wallet.example.com/alice + ``` + + + ``` + $wallet.example.com/alice + ``` + + + +## Limitations + +### Interledger Wallet + +For now, users of the Interledger Wallet can only send and receive from other Interledger Wallet users who are in the same region and using the same currency. + +### GateHub + +For now, users of the GateHub wallet can only send and receive from other GateHub wallet users. ## Interledger test wallet @@ -38,7 +71,7 @@ The Interledger test wallet provides a great way to test Web Monetization withou
GateHub - Users of GateHub will have a _payment pointer_. To locate your payment pointer: + Users of GateHub will have a _payment pointer_. Note that in GateHub your payment pointer is not the same thing as your wallet name. To locate your payment pointer: 1. Select your wallet, then click **Advanced**.
2. Scroll down to **Interledger Settings**. @@ -48,14 +81,4 @@ The Interledger test wallet provides a great way to test Web Monetization withou If you're setting up the extension, you can enter your payment pointer as it's shown. If you're adding Web Monetization to your website, you must change `$` to `https://`. For example, `https://ilp.gatehub.net/150012576/USD`. ::: -
- -## Limitations - -### Interledger Wallet - -Users of the Interledger Wallet can only send and receive from other Interledger Wallet users who are in the same region and using the same currency. - -### GateHub - -Users of the GateHub wallet can only send and receive from other GateHub wallet users. \ No newline at end of file +
\ No newline at end of file diff --git a/src/partials/link-element-cont-payments.mdx b/src/partials/link-element-cont-payments.mdx new file mode 100644 index 00000000..dcdce398 --- /dev/null +++ b/src/partials/link-element-cont-payments.mdx @@ -0,0 +1,8 @@ +If your visitor is sending continuous payments, the payments will continue for as long as your web monetized page is active and in view. Continuous payments stop if your visitor: + +* Disables the extension +* Disables continuous payments within the extension’s settings +* Minimizes their browser +* Changes focus away from your site/switches to a different tab +* Closes your site or their browser +* Spends all of their budget diff --git a/src/partials/link-element-how-agent.mdx b/src/partials/link-element-how-agent.mdx index 539422b0..96b7f5b8 100644 --- a/src/partials/link-element-how-agent.mdx +++ b/src/partials/link-element-how-agent.mdx @@ -11,9 +11,9 @@ The purpose of the Web Monetization agent is to recognize when a page is web mon - Instrumenting payments by calling the [Open Payments APIs](/developers/about-receiving#a-deeper-dive-into-payments), which are APIs implemented by wallet providers - Firing [`monetization`](/developers/events) events after an outgoing payment is created - Processing `monetization` events sent to the browser window via the `onmonetization` event handler -- Enabling the CSP [`monetization-src`](/developers/csp) and Permissions Policy [`monetization`](/developers/permissions-policy) directives +- Enabling the Content Security Policy (CSP) [`monetization-src`](/developers/csp) and Permissions Policy [`monetization`](/developers/permissions-policy) directives -Until Web Monetization agents are natively built in to web browsers, an agent must be added to browsers in some other way. That's why the agent is included as part of the Interledger Foundation's extension. +Until Web Monetization agents are natively built into web browsers, an agent must be added to browsers in some other way. That's why the agent is included as part of Interledger Foundation's extension. diff --git a/src/partials/link-element-how-rel.mdx b/src/partials/link-element-how-rel.mdx index 473a40c5..f5ce3e2e 100644 --- a/src/partials/link-element-how-rel.mdx +++ b/src/partials/link-element-how-rel.mdx @@ -1,3 +1,3 @@ Browsers already know how to interpret certain `rel` values because of web standards. One such standard is `stylesheet`. When a browser loads a page that contains ``, the browser automatically knows to import a style sheet from the given URL. -The `monetization` link type, however, is not yet a standard. Major web browsers don't automatically know what to do when encountering this link type in a page. Until `monetization` becomes a standard, browsers must rely on a Web Monetization agent. \ No newline at end of file +The `monetization` link type, however, isn't a standard yet. Major web browsers don't automatically know what to do when encountering this link type in a page. Until `monetization` becomes a standard, browsers must rely on a Web Monetization agent, like the one built into Interledger Foundation's [Web Monetization extension](/supporters/get-started). \ No newline at end of file diff --git a/src/partials/link-element-iframes.mdx b/src/partials/link-element-iframes.mdx index f773bc47..072362da 100644 --- a/src/partials/link-element-iframes.mdx +++ b/src/partials/link-element-iframes.mdx @@ -1,6 +1,6 @@ import { LinkOut } from '@interledger/docs-design-system' -Nested browsing contexts (iframes) can contain monetization `` elements; however, your site visitor’s Web Monetization agent determines how iframes are monetized. A few examples of how a Web Monetization agent can monetize iframes include: +Nested browsing contexts (iframes) can contain monetization `` elements, but your site visitor’s Web Monetization agent determines how iframes are monetized. A few examples of how a Web Monetization agent can monetize iframes include: * Splitting payments evenly between all monetization links within both the parent and the iframe * Splitting payments evenly between all monetization links in the parent and the first monetization link it finds in the iframe’s ``, while ignoring any other monetization links in the iframe diff --git a/src/partials/link-element-multilink.mdx b/src/partials/link-element-multilink.mdx index 062f9406..24c9fcc6 100644 --- a/src/partials/link-element-multilink.mdx +++ b/src/partials/link-element-multilink.mdx @@ -1,6 +1,6 @@ import { LinkOut } from '@interledger/docs-design-system' -An HTML page can contain multiple monetization `` elements; however, your site visitor’s Web Monetization agent could be designed to handle multiple links in a particular way. For example, an agent might: +An HTML page can contain multiple monetization `` elements, but your site visitor’s Web Monetization agent could be designed to handle multiple links in a particular way. For example, an agent might: * Split payments evenly between all links * Split payments between the first few links it finds diff --git a/src/partials/link-element-overview.mdx b/src/partials/link-element-overview.mdx index 185cc590..f8fbe330 100644 --- a/src/partials/link-element-overview.mdx +++ b/src/partials/link-element-overview.mdx @@ -1 +1 @@ -From a creator/developer perspective, the monetization `` element is one of the two key pieces to web monetizing an HTML page. The second piece is a wallet address/payment pointer. \ No newline at end of file +From a creator/developer perspective, the monetization `` element is one of the two key pieces to web monetizing an HTML page. The second piece is a wallet address. \ No newline at end of file diff --git a/src/partials/link-element-syntax.mdx b/src/partials/link-element-syntax.mdx index 5e5c7e6d..ee454699 100644 --- a/src/partials/link-element-syntax.mdx +++ b/src/partials/link-element-syntax.mdx @@ -1,9 +1,9 @@ ```html - + ``` * The `rel` attribute is always `monetization` -* The `href` attribute equals your wallet address or your payment pointer in URL format +* The `href` attribute equals your wallet address For example: