{"id":47857844,"url":"https://github.com/xrplf/xrpl-docs-data-scripts","last_synced_at":"2026-04-03T23:01:45.033Z","repository":{"id":339041563,"uuid":"1134620985","full_name":"XRPLF/xrpl-docs-data-scripts","owner":"XRPLF","description":"Scripts to re-create persistent data on XRPL networks for docs usage.","archived":false,"fork":false,"pushed_at":"2026-02-17T17:56:56.000Z","size":98,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-17T22:40:00.544Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/XRPLF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-15T01:02:43.000Z","updated_at":"2026-02-17T17:57:00.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/XRPLF/xrpl-docs-data-scripts","commit_stats":null,"previous_names":["xrplf/xrpl-docs-data-scripts"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/XRPLF/xrpl-docs-data-scripts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XRPLF%2Fxrpl-docs-data-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XRPLF%2Fxrpl-docs-data-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XRPLF%2Fxrpl-docs-data-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XRPLF%2Fxrpl-docs-data-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XRPLF","download_url":"https://codeload.github.com/XRPLF/xrpl-docs-data-scripts/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XRPLF%2Fxrpl-docs-data-scripts/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31381007,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T21:40:47.592Z","status":"ssl_error","status_checked_at":"2026-04-03T21:40:05.436Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-03T23:01:44.164Z","updated_at":"2026-04-03T23:01:45.026Z","avatar_url":"https://github.com/XRPLF.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XRPL Docs Data Scripts\n\nThe scripts contained in this repository re-create specific persistent data in an [XRP Ledger (XRPL)](https://xrpl.org) test network after that network has been reset, so that XRPL documentation can depend on the existence of that data.\n\n## Setup \u0026 Usage\n\nThese scripts require Node.js (LTS) and `npm`.\n\n```sh\nnpm i\n```\n\nTwo things are needed before you can run the scripts:\n\n1. You must provide secrets and environment information using an `.env` file at the repo top. See `example.env` for an example.\n2. Your network or test server needs a faucet running. See [Faucet Setup](#faucet-setup) for examples.\n\nWith both of those in place, you can run the scripts:\n\n```sh\nnpm run make-data\n```\n\nYou can also run _just_ the read-only checks on network status, even without a faucet:\n\n```sh\nnpm run test-only\n```\n\n### Network Setup - Stand-Alone Mode\n\nYou can test this using an XRP Ledger core server (`rippled` or `xrpld`) in stand-alone mode. First, start the server:\n\n```sh\nrippled -a --start\n```\n\nIn this repo's `.env` file, set the `WS_URL` to use either the public or admin WebSocket API provided by your server. For example, to connect to the admin WS port of a locally-running `rippled` using the default config file:\n\n```ini\nWS_URL=ws://localhost:6006/\n```\n\nIn stand-alone mode, the server won't close new ledgers automatically because there's no consensus process. You can approximate one by running `ledger_accept` automatically, for example, the following command automatically closes a ledger every 3 seconds:\n\n```sh\nwatch -n 3 rippled ledger_accept\n```\n\n### Network Setup - Private Network with Docker\n\nYou can [run an entire multi-node private network using Docker](https://xrpl.org/docs/infrastructure/testing-and-auditing/run-private-network-with-docker). The network should automatically start when you start the containers. For example:\n\n```sh\ndocker-compose up -d\n```\n\nIf you followed the private network tutorial exactly, you can use the public WebSocket ports of any of the three validators, which are mapped to ports `8001`, `8002`, and `8003` on the host machine. For example:\n\n```ini\nWS_URL=ws://localhost:8001/\n```\n\nThe private network closes ledgers automatically, so the only further setup is the faucet.\n\n\n### Faucet Setup\n\nThis repo contains a minimalist XRP Faucet server you can use to fund accounts on a private network. It uses the same `.env` file for configuration as the main scripts. You can run the faucet as follows:\n\n```sh\nnpm run faucet\n```\n\nThe faucet runs until killed (for example with Ctrl-C), so run this in a separate shell from the one you're running the scripts in.\n\nYou can configure the faucet with the following vars:\n\n| Field | Definition |\n|-------|------------|\n| `WS_URL` | The WebSocket URL the faucet should use to connect to the XRP Ledger server. The faucet uses the same configuration as the data scripts. |\n| `FAUCET_PORT` | What port the faucet should listen on. If unspecifies, uses **6061**. |\n| `FAUCET_ADDRESS` | Address (base58) of the faucet account which holds XRP. If unspecified, uses the genesis account **rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh**. |\n| `FAUCET_SEED` | Seed (base58) of the faucet account. If unspecified, uses the genesis account's seed. |\n| `FAUCET_KEY_TYPE` | Algorithm to use when deriving the faucet account's address from the seed (`secp256k1` or `ed25519`). If unspecified, uses **secp256k1**. |\n| `FUND_XRP` | How much XRP (not drops) to provide on each call. If unspecified, uses **1000**. |\n\n## Summary of Scripts Included\n\n1. `check-env-vars.js` - Confirms that certain environment variables, necessary for these scripts to run, are defined properly.\n2. `check-genesis-account.js` - Check the status of the genesis account to see if it has readily-available XRP. (Read-only)\n3. `check-amendments.js` - Compare amendment status to Mainnet to see if this network is missing any amendments that are enabled on Mainnet. (Read-only)\n4. `check-reserves.js` - Compare reserves and base transaction to see if this network's settings match Mainnet's. (Read-only)\n5. `tst-offer-setup.js` - Ensures that the **TST Issuer** rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd is funded and there are offers to buy and sell TST for XRP at a well-defined exchange rate and spread. These are used in DEX tutorials.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxrplf%2Fxrpl-docs-data-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxrplf%2Fxrpl-docs-data-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxrplf%2Fxrpl-docs-data-scripts/lists"}