You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 8, 2024. It is now read-only.
-[RippleX Dev Kit Integration](#ripplex-dev-kit-integration)
15
15
16
16
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.
17
17
@@ -126,17 +126,17 @@ If you want to clean up the Docker containers, you can run `npm run devDown`.
126
126
127
127
Now that you've set up the basics, [learn more](#learn-more) about PayID and what you can do with it.
128
128
129
-
## Xpring SDK Integration
129
+
## RippleX Dev Kit Integration
130
130
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).
132
132
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:
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).
Copy file name to clipboardExpand all lines: docs/metrics.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ title: Metrics
4
4
sidebar_label: Metrics
5
5
---
6
6
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.
8
8
9
-
## Reporting metrics to Xpring
9
+
## Reporting metrics to RippleX
10
10
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.
12
12
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:
14
14
15
15
```sh
16
-
#Xpring's Prometheus pushgateway
16
+
#RippleX's Prometheus pushgateway
17
17
PUSH_GATEWAY_URL=https://push00.mon.payid.tech
18
18
```
19
19
@@ -47,7 +47,7 @@ This chart shows the rate per minute of PayID lookup requests:
47
47
48
48
You can use a push or pull method to obtain metrics from Prometheus.
49
49
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.
51
51
52
52
### How to pull metrics to Prometheus
53
53
@@ -77,9 +77,9 @@ scrape_configs:
77
77
78
78
### How to push metrics from the PayID server to Prometheus
79
79
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.
81
81
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:
83
83
84
84
1. Set the environment variables `PUSH_GATEWAY_URL` with the url to your pushgateway.
85
85
2. Restart your PayID server.
@@ -88,7 +88,7 @@ For example, if the fictitious company Vandelay Industries wants to push metrics
88
88
89
89
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.
90
90
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.
Copy file name to clipboardExpand all lines: docs/payid-cli.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,15 +30,15 @@ To run PayID CLI in interactive mode, run `payid` to open an interactive session
30
30
In interactive mode, you can then run PayID CLI commands as desired with the form
31
31
`<command> <arguments>`, such as:
32
32
33
-
`load 'nhartner$xpring.money'`
33
+
`load 'nhartner$ripplex.money'`
34
34
35
35
To exit interactive mode, run `exit`.
36
36
37
37
To run PayID CLI in single-command mode, prefix each command with `payid`. Each command takes the form
38
38
39
39
`payid <command> <arguments>`, such as:
40
40
41
-
`payid load 'nhartner$xpring.money'`
41
+
`payid load 'nhartner$ripplex.money'`
42
42
43
43
Use single-command mode for scripts, or to chain the results of multiple commands together, such as:
44
44
@@ -48,19 +48,19 @@ When you pass a PayID as an argument in non-interactive mode, make sure to escap
48
48
49
49
## Example commands
50
50
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.
52
52
53
53
### Load a PayID
54
54
55
55
This command loads the specified PayID from a remote server.
56
56
57
-
`load loisrp$xpring.money`
57
+
`load loisrp$ripplex.money`
58
58
59
59
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.
60
60
61
61
```json
62
62
{
63
-
"payId": "loisrp$xpring.money",
63
+
"payId": "loisrp$ripplex.money",
64
64
"version": "1.0",
65
65
"addresses": [
66
66
{
@@ -76,7 +76,7 @@ The output fetches all the PayID address mappings for the given PayID from the r
76
76
"environment": "TESTNET",
77
77
"addressDetailsType": "CryptoAddressDetails",
78
78
"addressDetails": {
79
-
"address": "$xpring.money/LoisRP"
79
+
"address": "$ripplex.money/LoisRP"
80
80
}
81
81
}
82
82
],
@@ -94,15 +94,15 @@ The output returns the updated information about the PayID. In this example, the
94
94
95
95
```json
96
96
{
97
-
"payId": "loisrp$xpring.money",
97
+
"payId": "loisrp$ripplex.money",
98
98
"version": "1.0",
99
99
"addresses": [
100
100
{
101
101
"paymentNetwork": "INTERLEDGER",
102
102
"environment": "TESTNET",
103
103
"addressDetailsType": "CryptoAddressDetails",
104
104
"addressDetails": {
105
-
"address": "$xpring.money/LoisRP"
105
+
"address": "$ripplex.money/LoisRP"
106
106
}
107
107
}
108
108
],
@@ -120,14 +120,14 @@ The output returns the updated information for the PayID, including the added cr
Copy file name to clipboardExpand all lines: docs/remote-deployment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ When you have deployed a PayID server, you can then set up [NGINX Reverse Proxy
49
49
50
50
- To bring this down, run `npm run devDown`
51
51
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/).
53
53
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.
54
54
**Note:** You can add PayIDs for each (pay_id, network, environment) tuple. Use this cURL command to set up a PayID.
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
5
5
---
6
6
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.
8
8
9
-
Try this demo that uses the Xpring-JS SDK.
9
+
Try this demo that uses RippleX-JS.
10
10
11
11
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:
@@ -16,4 +16,4 @@ Try this demo that uses the Xpring-JS SDK.
16
16
`node src/index-xrp.js`
17
17
4. If you have another PayID, you can edit the script and substitute that PayID, and then run it and see the results.
18
18
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).
[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).
Copy file name to clipboardExpand all lines: docs/welcome-to-payid.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ Refer to the [PayID protocol whitepaper](https://payid.org/whitepaper.pdf) for a
28
28
29
29
## Implementations
30
30
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.
32
32
33
33
If you want to contribute to PayID, see [Contributing to PayID](https://github.com/payid-org/payid/blob/master/CONTRIBUTING.md).
34
34
@@ -54,7 +54,7 @@ A PayID implementation requires the use of TLS (Transport Level Security). As de
54
54
55
55
## Future features and integrations
56
56
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.
0 commit comments