Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion docs/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you want to verify whether CORS is correctly set up for your PayID server, yo
headers.append('Accept', 'application/xrpl-mainnet+json')
headers.append('PayID-Version', '1.0')

fetch(new Request('https://xpring.money/alice'), {
fetch(new Request('https://ripplex.money/alice'), {
method: 'GET',
headers,
mode: 'cors',
Expand Down
10 changes: 5 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ PayID is a simple, web-based protocol designed to make it as easy to send someon
- [Create a PayID](#create-a-payid)
- [Request a PayID](#request-a-payid)
- [Learn More](#learn-more)
- [Xpring SDK Integration](#xpring-sdk-integration)
- [RippleX Dev Kit Integration](#ripplex-dev-kit-integration)

Your contributions are welcome. Check out the [PayID repository on GitHub](https://github.com/payid-org/payid), and note the [Contributing](https://github.com/payid-org/payid/blob/master/CONTRIBUTING.md) guidelines.

Expand Down Expand Up @@ -126,17 +126,17 @@ If you want to clean up the Docker containers, you can run `npm run devDown`.

Now that you've set up the basics, [learn more](#learn-more) about PayID and what you can do with it.

## Xpring SDK Integration
## RippleX Dev Kit Integration

PayID support is integrated into [Xpring SDK](https://github.com/xpring-eng/xpring-sdk).
PayID support is integrated into [RippleX Dev Kit](https://github.com/xpring-eng/ripplex-dev-kit).

Xpring SDK provides the ability to work with PayID. It provides three language libraries:
RippleX Dev Kit provides the ability to work with PayID. It provides three language libraries:

- [JavaScript](https://github.com/xpring-eng/xpring-js)
- [Java](https://github.com/xpring-eng/xpring4j)
- [Swift](https://github.com/xpring-eng/xpringkit)

These libraries help you connect your application to PayID without having to worry about the specifics of PayID. Try [Get Started With Xpring SDK and PayID](xpring-sdk-payid-get-started).
These libraries help you connect your application to PayID without having to worry about the specifics of PayID. Try [Get Started With RippleX Dev Kit and PayID](ripplex-dev-kit-payid-get-started).

## Learn More

Expand Down
18 changes: 9 additions & 9 deletions docs/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ title: Metrics
sidebar_label: Metrics
---

The reference implementation of PayID server automatically collects metrics using Prometheus. By default, metrics are pushed to the Xpring Prometheus pushgateway. This document describes how you can explicitly configure the PayID server to push to Xpring, or how to collect and analyze these metrics using your own metrics server.
The reference implementation of PayID server automatically collects metrics using Prometheus. By default, metrics are pushed to the RippleX Prometheus pushgateway. This document describes how you can explicitly configure the PayID server to push to RippleX, or how to collect and analyze these metrics using your own metrics server.

## Reporting metrics to Xpring
## Reporting metrics to RippleX

Xpring runs a metrics collection server for general use by anyone running a PayID server. Sharing your metrics with Xpring allows the PayID community to aggregate and monitor PayID adoption and growth metrics in one place.
RippleX runs a metrics collection server for general use by anyone running a PayID server. Sharing your metrics with RippleX allows the PayID community to aggregate and monitor PayID adoption and growth metrics in one place.

Metrics are reported to Xpring by default but you can push metrics to your own Prometheus pushgateway. Here's how to configure your PayID server to do that:
Metrics are reported to RippleX by default but you can push metrics to your own Prometheus pushgateway. Here's how to configure your PayID server to do that:

```sh
# Xpring's Prometheus pushgateway
# RippleX's Prometheus pushgateway
PUSH_GATEWAY_URL=https://push00.mon.payid.tech
```

Expand Down Expand Up @@ -47,7 +47,7 @@ This chart shows the rate per minute of PayID lookup requests:

You can use a push or pull method to obtain metrics from Prometheus.

**Tip:** Note that both push and pull methods can be used together simultaneously. For example, to pull metrics into an internal Prometheus server and push metrics to a third-party Prometheus server like Xpring.
**Tip:** Note that both push and pull methods can be used together simultaneously. For example, to pull metrics into an internal Prometheus server and push metrics to a third-party Prometheus server like RippleX.

### How to pull metrics to Prometheus

Expand Down Expand Up @@ -77,9 +77,9 @@ scrape_configs:

### How to push metrics from the PayID server to Prometheus

Alternatively, you can push metrics from the PayID server to Prometheus using a [pushgateway](https://github.com/prometheus/pushgateway). This setup requires running a pushgateway in addition to a Prometheus server, and configuring the PayID server to push metrics to the pushgateway. Prometheus then pulls metrics from the pushgateway. In this setup, Prometheus and pushgateway do not need to run inside the same network as the PayID server(s), but the PayID server must be able to reach the pushgateway over http. This is the recommended method for pushing metrics to a third party such as Xpring.
Alternatively, you can push metrics from the PayID server to Prometheus using a [pushgateway](https://github.com/prometheus/pushgateway). This setup requires running a pushgateway in addition to a Prometheus server, and configuring the PayID server to push metrics to the pushgateway. Prometheus then pulls metrics from the pushgateway. In this setup, Prometheus and pushgateway do not need to run inside the same network as the PayID server(s), but the PayID server must be able to reach the pushgateway over http. This is the recommended method for pushing metrics to a third party such as RippleX.

By default, the reference PayID server pushes metrics to the Xpring pushgateway. To push metrics to your own pushgateway, follow these steps:
By default, the reference PayID server pushes metrics to the RippleX pushgateway. To push metrics to your own pushgateway, follow these steps:

1. Set the environment variables `PUSH_GATEWAY_URL` with the url to your pushgateway.
2. Restart your PayID server.
Expand All @@ -88,7 +88,7 @@ For example, if the fictitious company Vandelay Industries wants to push metrics

By default, a PayID server will push metrics every 15 seconds to the configured pushgateway. To change this frequency, set the `PUSH_METRICS_INTERVAL` value. For example, to push every 5 minutes (300 seconds), set `PUSH_METRICS_INTERVAL=300`. This value must be a positive number.

As mentioned above, you can also explicitly set `PUSH_GATEWAY_URL=https://push00.mon.payid.tech` to push the metrics from your PayID server to Xpring.
As mentioned above, you can also explicitly set `PUSH_GATEWAY_URL=https://push00.mon.payid.tech` to push the metrics from your PayID server to RippleX.

## Visualize metrics with Prometheus and Grafana

Expand Down
20 changes: 10 additions & 10 deletions docs/payid-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ To run PayID CLI in interactive mode, run `payid` to open an interactive session
In interactive mode, you can then run PayID CLI commands as desired with the form
`<command> <arguments>`, such as:

`load 'nhartner$xpring.money'`
`load 'nhartner$ripplex.money'`

To exit interactive mode, run `exit`.

To run PayID CLI in single-command mode, prefix each command with `payid`. Each command takes the form

`payid <command> <arguments>`, such as:

`payid load 'nhartner$xpring.money'`
`payid load 'nhartner$ripplex.money'`

Use single-command mode for scripts, or to chain the results of multiple commands together, such as:

Expand All @@ -48,19 +48,19 @@ When you pass a PayID as an argument in non-interactive mode, make sure to escap

## Example commands

**Tip**: If you obtain an XRP testnet wallet, you get a PayID based on your Xpring account that is already linked to an XRP address. This is useful for testing. Visit the [xpring.io portal](https://xpring.io/portal) and sign in with Github. The Xpring portal launchpad page opens. Click **XRP Testnet Wallet** and follow the steps to create your wallet. Your PayID has the form `<github-username>$xpring.money` and you can use this PayID value in these example commands.
**Tip**: If you obtain an XRP testnet wallet, you get a PayID based on your RippleX account that is already linked to an XRP address. This is useful for testing. Visit the [RippleX.io portal](https://RippleX.io/portal) and sign in with Github. The RippleX portal launchpad page opens. Click **XRP Testnet Wallet** and follow the steps to create your wallet. Your PayID has the form `<github-username>$ripplex.money` and you can use this PayID value in these example commands.

### Load a PayID

This command loads the specified PayID from a remote server.

`load loisrp$xpring.money`
`load loisrp$ripplex.money`

The output fetches all the PayID address mappings for the given PayID from the remote server and displays the resulting JSON. In this example, the PayID has two crypto-addresses attached to it.

```json
{
"payId": "loisrp$xpring.money",
"payId": "loisrp$ripplex.money",
"version": "1.0",
"addresses": [
{
Expand All @@ -76,7 +76,7 @@ The output fetches all the PayID address mappings for the given PayID from the r
"environment": "TESTNET",
"addressDetailsType": "CryptoAddressDetails",
"addressDetails": {
"address": "$xpring.money/LoisRP"
"address": "$ripplex.money/LoisRP"
}
}
],
Expand All @@ -94,15 +94,15 @@ The output returns the updated information about the PayID. In this example, the

```json
{
"payId": "loisrp$xpring.money",
"payId": "loisrp$ripplex.money",
"version": "1.0",
"addresses": [
{
"paymentNetwork": "INTERLEDGER",
"environment": "TESTNET",
"addressDetailsType": "CryptoAddressDetails",
"addressDetails": {
"address": "$xpring.money/LoisRP"
"address": "$ripplex.money/LoisRP"
}
}
],
Expand All @@ -120,14 +120,14 @@ The output returns the updated information for the PayID, including the added cr

```json
{
"payId": "loisrp$xpring.money",
"payId": "loisrp$ripplex.money",
"addresses": [
{
"paymentNetwork": "INTERLEDGER",
"environment": "TESTNET",
"addressDetailsType": "CryptoAddressDetails",
"addressDetails": {
"address": "$xpring.money/LoisRP"
"address": "$ripplex.money/LoisRP"
}
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/payid-schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A single user can have multiple destinations, because the same user can have add

```json
{
"payId": "johndoe$xpring.money",
"payId": "johndoe$ripplex.money",
"addresses": [
{
"paymentNetwork": "XRPL",
Expand Down
2 changes: 1 addition & 1 deletion docs/remote-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ When you have deployed a PayID server, you can then set up [NGINX Reverse Proxy

- To bring this down, run `npm run devDown`

12. Check your IP address and the website in your browser to confirm the server is running. You should see a success page that looks like [this](https://xpring.money/).
12. Check your IP address and the website in your browser to confirm the server is running. You should see a success page that looks like [this](https://ripplex.money/).
13. Load up your desired PayID to the database using the [Admin API](https://api.payid.org/?version=latest#7a19329b-80eb-451f-bbb8-d9656892a788). If you use a subdomain rather than a path, then you must set up a DNS record for the subdomain as described in step 3.
**Note:** You can add PayIDs for each (pay_id, network, environment) tuple. Use this cURL command to set up a PayID.
```bash
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: xpring-sdk-payid-get-started
title: Get Started with Xpring SDK and PayID
sidebar_label: Get Started with Xpring SDK and PayID
id: ripplex-dev-kit-payid-get-started
title: Get Started with RippleX Dev Kit and PayID
sidebar_label: Get Started with RippleX Dev Kit and PayID
---

[Xpring SDK](https://xpring.io/docs/), a platform that provides developer tools, services, and programs to integrate money into your apps, also provides support for PayID by simplifying the resolution of a PayID to its associated network addresses. Xpring SDK is available for JavaScript, Java, and Swift.
[RippleX Dev Kit](https://RippleX.io/docs/), a platform that provides developer tools, services, and programs to integrate money into your apps, also provides support for PayID by simplifying the resolution of a PayID to its associated network addresses. RippleX Dev Kit is available for JavaScript, Java, and Swift.

Try this demo that uses the Xpring-JS SDK.
Try this demo that uses RippleX-JS.

1. Clone the [GitHub repository](https://github.com/xpring-eng/Xpring-SDK-Demo). If you want to use SSH, enter this command at the command line:
`git clone git@github.com:xpring-eng/Xpring-SDK-Demo.git`
Expand All @@ -16,4 +16,4 @@ Try this demo that uses the Xpring-JS SDK.
`node src/index-xrp.js`
4. If you have another PayID, you can edit the script and substitute that PayID, and then run it and see the results.

To see similar functionality for Java and Swift, follow the README.md instructions for [Xpring4j SDK](https://github.com/xpring-eng/Xpring-SDK-Demo/tree/master/java) and [XpringKit SDK](https://github.com/xpring-eng/Xpring-SDK-Demo/tree/master/swift).
To see similar functionality for Java and Swift, follow the README.md instructions for [RippleX4j](https://github.com/xpring-eng/Xpring-SDK-Demo/tree/master/java) and [RippleXKit](https://github.com/xpring-eng/Xpring-SDK-Demo/tree/master/swift).
17 changes: 17 additions & 0 deletions docs/ripplex-dev-kit-payid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
id: ripplex-dev-kit-payid
title: Use RippleX Dev Kit With PayID
sidebar_label: RippleX Dev Kit Integration
---

[RippleX Dev Kit](https://github.com/xpring-eng/xpring-sdk) can be used to simplify the process of developing with PayID.

RippleX Dev Kit provides libraries in [JavaScript](https://github.com/xpring-eng/xpring-js), [Java](https://github.com/xpring-eng/xpring4j), and [Swift](https://github.com/xpring-eng/xpringkit).

## Documentation

RippleX Dev Kit provides classes and utilites to work with PayID. Head over to the PayID documentation for the [JavaScript](https://github.com/xpring-eng/Xpring-JS#usage-payid), [Java](https://github.com/xpring-eng/Xpring4j#usage-payid), or [Swift](https://github.com/xpring-eng/XpringKit#usage-payid) libraries to get started.

## Demos

RippleX Dev Kit provides a number of demos in their demo repo. You can browse PayID demos in [JavaScript](https://github.com/xpring-eng/xpring-js#usage-payid), [Java](https://github.com/xpring-eng/xpring4j#usage-payid), or [Swift](https://github.com/xpring-eng/xpringkit#usage-payid). For a quick run through the demo, see [Get Started With RippleX Dev Kit and PayID](ripplex-dev-kit-payid-get-started).
4 changes: 2 additions & 2 deletions docs/welcome-to-payid.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Refer to the [PayID protocol whitepaper](https://payid.org/whitepaper.pdf) for a

## Implementations

You can decide how you want to implement the PayID protocol. To facilitate ease of use, Xpring has created a [reference implementation for a PayID server](payid-reference-overview). Check out the [PayID repository on Github](https://github.com/xpring-eng/payid/). Refer to [Getting started](/) for a quick guide to deploy your own PayID server, manage users, and execute transactions.
You can decide how you want to implement the PayID protocol. To facilitate ease of use, RippleX has created a [reference implementation for a PayID server](payid-reference-overview). Check out the [PayID repository on Github](https://github.com/xpring-eng/payid/). Refer to [Getting started](/) for a quick guide to deploy your own PayID server, manage users, and execute transactions.

If you want to contribute to PayID, see [Contributing to PayID](https://github.com/payid-org/payid/blob/master/CONTRIBUTING.md).

Expand All @@ -54,7 +54,7 @@ A PayID implementation requires the use of TLS (Transport Level Security). As de

## Future features and integrations

PayID is an extensible and flexible open standard, and therefore can be used as a basis for additional solutions. In upcoming releases, Xpring intends to extend PayID capabilities as described here.
PayID is an extensible and flexible open standard, and therefore can be used as a basis for additional solutions. In upcoming releases, RippleX intends to extend PayID capabilities as described here.

### Verifiable PayID

Expand Down
17 changes: 0 additions & 17 deletions docs/xpring-sdk-payid.md

This file was deleted.

4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module.exports = {
items: [
'getting-started',
'verifiable-payid-tutorial',
'xpring-sdk-payid-get-started',
'ripplex-dev-kit-payid-get-started',
'metrics-tutorial',
],
},
Expand Down Expand Up @@ -53,7 +53,7 @@ module.exports = {
},
{
type: 'doc',
id: 'xpring-sdk-payid',
id: 'ripplex-dev-kit-payid',
},
{
type: 'doc',
Expand Down