Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/content/docs/developers/about-receiving.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ In general, a micropayment is a very small payment. Each wallet provider is resp
- 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 <abbr>USD</abbr>. 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 received 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 threshold amount.

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.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/developers/activity-streams.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <LinkOut href="https://www.w3.org/TR/activitystreams-core/">Activity Streams 2.0</LinkOut> <LinkOut href="https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object">`Object`</LinkOut>.

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/developers/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ By adding an event listener to the relevant monetization `<link>` element (or on
The `amountSent` property returns the `value` and `currency` of the sent payment.

- `value` - The amount. A <LinkOut href="https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value">valid decimal monetary value</LinkOut> containing the amount that was sent.
- `currency` - The currency code. A well-formed 3-letter <LinkOut href="https://www.iban.com/currency-codes">ISO4217</LinkOut> code that represents the currency that was sent, such as USD for US dollar or GBP for Great Britain Pound.
- `currency` - The currency code. A well-formed 3-letter <LinkOut href="https://www.iban.com/currency-codes">ISO4217</LinkOut> code that represents the currency that was sent, such as <abbr>USD</abbr> (for US dollar) or <abbr>GBP</abbr> (for Great Britain Pound).

```js title="Example"
"value": "1.23"
"currency": "USD"
```

:::note[Received amount]
The `amountSent` isn't necessarily the amount received. For example, if your payment account is set up to receive Great Britain Pound (GBP), but your site visitor's account sends in US dollar (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 <abbr>GBP</abbr> (Great Britain Pound), but your site visitor's account sends in <abbr>USD</abbr> (US dollar), then exchange rates and currency conversion fees could affect the amount you receive.
:::

#### Examples using `amountSent`
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/developers/interfaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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. For example, USD for US dollar or GBP for Great Britain Pound.
- Currency - The currency code. An ISO 4217-compliant currency code, when possible, that represents the currency that was sent. For example, <abbr>USD</abbr> (for US dollar) or <abbr>GBP</abbr> (for Great Britain Pound).

The `MonetizationCurrencyAmount` interface is modeled on the Payment Request API’s <LinkOut href="https://www.w3.org/TR/payment-request/#paymentcurrencyamount-dictionary">`PaymentCurrencyAmount`</LinkOut> dictionary.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/developers/rss-atom-jsonfeed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ Site visitors can make a one-time contribution or send small continuous payments
<LinkCard title="For visitors to web monetized content" href="/supporters/overview" description="As a content consumer, you pay as much or as little as you want, as often as you want, as you spend time on web monetized sites." />
<LinkCard title="For website owners, content owners, and publishers" href="/developers/overview" description="Get paid directly for the work you own, create, publish, or contribute to on the web." />
<LinkCard title="For developers" href="/developers/link-element" description="Get started by adding Web Monetization to an HTML page. Web Monetization can also be added to RSS, ATOM, and JSON feeds, as well as Activity Streams." />
<LinkCard title="Get the browser extension" href="/supporters/get-started#install-the-extension" description="Download the Interledger Foundation's browser extension. Currently available for Chrome, Firefox, and Edge." />
<LinkCard title="Get the browser extension" href="/supporters/get-started#install-the-extension" description="Download Interledger Foundation's browser extension. Currently available for Chrome, Firefox, and Edge." />
</CardGrid>
12 changes: 6 additions & 6 deletions src/content/docs/guides/receive-test-payments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.<Card title="Example">If your rate is €0.60 EUR an hour, then it will take 5-6 minutes for three events to appear.</Card>
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.<Card title="Example">If your rate is €0.60 <abbr>EUR</abbr> an hour, then it will take 5-6 minutes for three events to appear.</Card>
5. Select **Disable** to stop the payments.
6. Sign in to your <LinkOut href="https://wallet.interledger-test.dev/">Interledger test wallet</LinkOut> 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.<Card title="Outgoing payment amounts">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.</Card>
7. Wait 10 minutes, then refresh the page. The pending incoming transaction will show as completed and reflect the amount deposited into your wallet.<Card title="Example">If your rate is €0.60 EUR an hour and you waited for three Playground events, your incoming payment will be approximately €0.03.</Card>
6. Sign in to your <LinkOut href="https://wallet.interledger-test.dev/">Interledger test wallet</LinkOut> 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.<Card title="Outgoing payment amounts">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 <abbr>EUR</abbr> an hour, each Playground event will show 0.01 <abbr>EUR</abbr> while each outgoing payment in your transaction list will show -€0.02.</Card>
7. Wait 10 minutes, then refresh the page. The pending incoming transaction will show as completed and reflect the amount deposited into your wallet.<Card title="Example">If your rate is €0.60 <abbr>EUR</abbr> an hour and you waited for three Playground events, your incoming payment will be approximately €0.03.</Card>
</Steps>

## Receive a one-time payment
Expand All @@ -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 <LinkOut href="https://wallet.interledger-test.dev/">Interledger test wallet</LinkOut> and select **Transactions** from the left menu. A completed outgoing and incoming payment will appear.<Card title="Incoming payment amount">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.</Card>
4. Sign in to your <LinkOut href="https://wallet.interledger-test.dev/">Interledger test wallet</LinkOut> and select **Transactions** from the left menu. A completed outgoing and incoming payment will appear.<Card title="Incoming payment amount">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 <abbr>EUR</abbr>, the completed incoming payment will be for €0.99.</Card>
12 changes: 6 additions & 6 deletions src/content/docs/guides/send-test-payments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ 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

<Steps>
1. Sign in to your <LinkOut href="https://wallet.interledger-test.dev/">wallet account</LinkOut>.
2. Download and install the Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension).
2. Download and install Interledger Foundation's [Web Monetization browser extension](/supporters/get-started#install-the-extension).
3. Enter the payment pointer associated with your test wallet. For example, `$ilp.interledger-test.dev/mytestwallet`. Then, enter a budget amount and click **Connect**.<br /><img
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to ask testnet team to replace payment pointer with wallet address now 😄🤞🏽. But looks good!

src='/img/docs/extension/connection-setup.png' alt='Extension setup screen with wallet address and amount fields, renew monthly toggle, and connect button' style='max-width:300px' class='img-outline'/>
4. Click **Agree** to allow the extension to connect to your wallet.
Expand All @@ -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 <abbr>USD</abbr> an hour ($0.01 a minute), or the equivalent in your chosen currency based on the exchange rate.

To change the rate of pay:
<Steps>
Expand All @@ -36,7 +36,7 @@ To change the rate of pay:

Visit <LinkOut href="https://sidvishnoi.com/test/wm/" withIcon={false}>https://sidvishnoi.com/test/wm/</LinkOut>.

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.
This page's test wallet receives all payments in Mexican pesos (<abbr>MX</abbr>$) regardless of the currency you chose to use for your own test wallet.

Check the status of the extension.

Expand All @@ -47,7 +47,7 @@ Check the status of the extension.

Each payment appears within the *Monetization events* section on the test site.<br /><img src='/img/docs/testwallet/testwallet-sid-continuous-events.png' alt='Monetization events section showing two payments of MXN 0.21' style='max-width:250px' class='img-outline'/>

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 <LinkOut href="https://wallet.interledger-test.dev/">wallet account</LinkOut> and select **Transactions** to see the payments you've sent.
If your extension is using <abbr>USD</abbr> 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 <LinkOut href="https://wallet.interledger-test.dev/">wallet account</LinkOut> and select **Transactions** to see the payments you've sent.

## Send a one-time payment

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/guides/test-wallet-sign-up.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <LinkOut href="https://wallet.interledger-test.dev">test wallet</LinkOut> with the Interledger Foundation to experiment with sending and receiving Web Monetization payments without using real money.
Sign up for a <LinkOut href="https://wallet.interledger-test.dev">test wallet</LinkOut> with Interledger Foundation to experiment with sending and receiving Web Monetization payments without using real money.

## Step 1 - Create an account

Expand All @@ -21,7 +21,7 @@ Sign up for a <LinkOut href="https://wallet.interledger-test.dev">test wallet</L
As you go through the Know Your Customer (KYC) check, the only real information you must share is your email address. All other information can be fake because you're signing up for a test environment.

:::note[Reason for checks]
The Interledger test wallet runs on a GateHub pre-production environment. This environment mimics their production environment, including many of their <LinkOut href="https://support.gatehub.net/hc/en-us/articles/360021131234-KYC-requirements-for-account-verification">KYC steps</LinkOut>.
Interledger Foundation's test wallet runs on a GateHub pre-production environment. This environment mimics their production environment, including many of their <LinkOut href="https://support.gatehub.net/hc/en-us/articles/360021131234-KYC-requirements-for-account-verification">KYC steps</LinkOut>.
:::

## Step 3 - Add a payment pointer
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/resources/get-involved.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- <LinkOut href='https://github.com/interledger/web-monetization-extension'>Contribute</LinkOut> to the Interledger Foundation's Web Monetization extension by coding or testing.
- <LinkOut href='https://github.com/interledger/web-monetization-extension'>Contribute</LinkOut> to Interledger Foundation's Web Monetization extension by coding or testing.

## Community events and hackathons

Expand Down
Loading