Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.

Commit 9bcc5cd

Browse files
LoisRPStormtv
andauthored
xpring to ripplex except for GitHub URLs (#118)
Co-authored-by: Tyler Storm <4524823+Stormtv@users.noreply.github.com>
1 parent df0b23f commit 9bcc5cd

11 files changed

Lines changed: 54 additions & 54 deletions

docs/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ If you want to verify whether CORS is correctly set up for your PayID server, yo
3636
headers.append('Accept', 'application/xrpl-mainnet+json')
3737
headers.append('PayID-Version', '1.0')
3838
39-
fetch(new Request('https://xpring.money/alice'), {
39+
fetch(new Request('https://ripplex.money/alice'), {
4040
method: 'GET',
4141
headers,
4242
mode: 'cors',

docs/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ PayID is a simple, web-based protocol designed to make it as easy to send someon
1111
- [Create a PayID](#create-a-payid)
1212
- [Request a PayID](#request-a-payid)
1313
- [Learn More](#learn-more)
14-
- [Xpring SDK Integration](#xpring-sdk-integration)
14+
- [RippleX Dev Kit Integration](#ripplex-dev-kit-integration)
1515

1616
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.
1717

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

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

129-
## Xpring SDK Integration
129+
## RippleX Dev Kit Integration
130130

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

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

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

139-
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).
139+
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).
140140

141141
## Learn More
142142

docs/metrics.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ title: Metrics
44
sidebar_label: Metrics
55
---
66

7-
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.
7+
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.
88

9-
## Reporting metrics to Xpring
9+
## Reporting metrics to RippleX
1010

11-
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.
11+
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.
1212

13-
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:
13+
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:
1414

1515
```sh
16-
# Xpring's Prometheus pushgateway
16+
# RippleX's Prometheus pushgateway
1717
PUSH_GATEWAY_URL=https://push00.mon.payid.tech
1818
```
1919

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

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

50-
**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.
50+
**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.
5151

5252
### How to pull metrics to Prometheus
5353

@@ -77,9 +77,9 @@ scrape_configs:
7777
7878
### How to push metrics from the PayID server to Prometheus
7979
80-
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.
80+
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.
8181
82-
By default, the reference PayID server pushes metrics to the Xpring pushgateway. To push metrics to your own pushgateway, follow these steps:
82+
By default, the reference PayID server pushes metrics to the RippleX pushgateway. To push metrics to your own pushgateway, follow these steps:
8383
8484
1. Set the environment variables `PUSH_GATEWAY_URL` with the url to your pushgateway.
8585
2. Restart your PayID server.
@@ -88,7 +88,7 @@ For example, if the fictitious company Vandelay Industries wants to push metrics
8888

8989
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.
9090

91-
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.
91+
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.
9292

9393
## Visualize metrics with Prometheus and Grafana
9494

docs/payid-cli.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ To run PayID CLI in interactive mode, run `payid` to open an interactive session
3030
In interactive mode, you can then run PayID CLI commands as desired with the form
3131
`<command> <arguments>`, such as:
3232

33-
`load 'nhartner$xpring.money'`
33+
`load 'nhartner$ripplex.money'`
3434

3535
To exit interactive mode, run `exit`.
3636

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

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

41-
`payid load 'nhartner$xpring.money'`
41+
`payid load 'nhartner$ripplex.money'`
4242

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

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

4949
## Example commands
5050

51-
**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.
51+
**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.
5252

5353
### Load a PayID
5454

5555
This command loads the specified PayID from a remote server.
5656

57-
`load loisrp$xpring.money`
57+
`load loisrp$ripplex.money`
5858

5959
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.
6060

6161
```json
6262
{
63-
"payId": "loisrp$xpring.money",
63+
"payId": "loisrp$ripplex.money",
6464
"version": "1.0",
6565
"addresses": [
6666
{
@@ -76,7 +76,7 @@ The output fetches all the PayID address mappings for the given PayID from the r
7676
"environment": "TESTNET",
7777
"addressDetailsType": "CryptoAddressDetails",
7878
"addressDetails": {
79-
"address": "$xpring.money/LoisRP"
79+
"address": "$ripplex.money/LoisRP"
8080
}
8181
}
8282
],
@@ -94,15 +94,15 @@ The output returns the updated information about the PayID. In this example, the
9494

9595
```json
9696
{
97-
"payId": "loisrp$xpring.money",
97+
"payId": "loisrp$ripplex.money",
9898
"version": "1.0",
9999
"addresses": [
100100
{
101101
"paymentNetwork": "INTERLEDGER",
102102
"environment": "TESTNET",
103103
"addressDetailsType": "CryptoAddressDetails",
104104
"addressDetails": {
105-
"address": "$xpring.money/LoisRP"
105+
"address": "$ripplex.money/LoisRP"
106106
}
107107
}
108108
],
@@ -120,14 +120,14 @@ The output returns the updated information for the PayID, including the added cr
120120

121121
```json
122122
{
123-
"payId": "loisrp$xpring.money",
123+
"payId": "loisrp$ripplex.money",
124124
"addresses": [
125125
{
126126
"paymentNetwork": "INTERLEDGER",
127127
"environment": "TESTNET",
128128
"addressDetailsType": "CryptoAddressDetails",
129129
"addressDetails": {
130-
"address": "$xpring.money/LoisRP"
130+
"address": "$ripplex.money/LoisRP"
131131
}
132132
},
133133
{

docs/payid-schemas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A single user can have multiple destinations, because the same user can have add
1616

1717
```json
1818
{
19-
"payId": "johndoe$xpring.money",
19+
"payId": "johndoe$ripplex.money",
2020
"addresses": [
2121
{
2222
"paymentNetwork": "XRPL",

docs/remote-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ When you have deployed a PayID server, you can then set up [NGINX Reverse Proxy
4949

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

52-
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/).
52+
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/).
5353
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.
5454
**Note:** You can add PayIDs for each (pay_id, network, environment) tuple. Use this cURL command to set up a PayID.
5555
```bash
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
id: xpring-sdk-payid-get-started
3-
title: Get Started with Xpring SDK and PayID
4-
sidebar_label: Get Started with Xpring SDK and PayID
2+
id: ripplex-dev-kit-payid-get-started
3+
title: Get Started with RippleX Dev Kit and PayID
4+
sidebar_label: Get Started with RippleX Dev Kit and PayID
55
---
66

7-
[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.
7+
[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.
88

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

1111
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:
1212
`git clone git@github.com:xpring-eng/Xpring-SDK-Demo.git`
@@ -16,4 +16,4 @@ Try this demo that uses the Xpring-JS SDK.
1616
`node src/index-xrp.js`
1717
4. If you have another PayID, you can edit the script and substitute that PayID, and then run it and see the results.
1818

19-
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).
19+
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).

docs/ripplex-dev-kit-payid.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
id: ripplex-dev-kit-payid
3+
title: Use RippleX Dev Kit With PayID
4+
sidebar_label: RippleX Dev Kit Integration
5+
---
6+
7+
[RippleX Dev Kit](https://github.com/xpring-eng/xpring-sdk) can be used to simplify the process of developing with PayID.
8+
9+
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).
10+
11+
## Documentation
12+
13+
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.
14+
15+
## Demos
16+
17+
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).

docs/welcome-to-payid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Refer to the [PayID protocol whitepaper](https://payid.org/whitepaper.pdf) for a
2828

2929
## Implementations
3030

31-
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.
31+
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.
3232

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

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

5555
## Future features and integrations
5656

57-
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.
57+
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.
5858

5959
### Verifiable PayID
6060

docs/xpring-sdk-payid.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)