README
¶
stellar-rpc
RPC Server for Stellar.
This repo is home to the Stellar RPC. The RPC provides information that the network currently has in its view. It has the ability to send a transaction to the network, and query the network for the status of previously sent transactions, and is meant to be simple, scalable, and familiar to blockchain developers.
RPC Methods
To learn about the RPC methods, please see our RPC Developer Docs.
To Use an Ecosystem RPCs
To use RPC from an ecosystem provider for futurenet, testnet, or mainnet, please see our list of Ecosystem RPC Providers.
Run Your Own RPC
If you are interested in running your own RPC, please review the Admin Guide.
Run Tests
Unit tests:
go test -v -failfast ./...
Integration tests:
STELLAR_RPC_INTEGRATION_TESTS_ENABLED=true \
STELLAR_RPC_INTEGRATION_TESTS_CORE_MAX_SUPPORTED_PROTOCOL=25 \
STELLAR_RPC_INTEGRATION_TESTS_CAPTIVE_CORE_BIN=$(which stellar-core) \
go test -v -failfast ./cmd/stellar-rpc/internal/integrationtest/...
Latest Release
For latest releases, please see releases.
Upcoming Features
For upcoming features, please see the project board.
Report Bugs or Request Features
To report bugs or request features, please open an issue on the official RPC repo.
To Contribute
Please fork this see good first issues on here.
Developer Docs: https://developers.stellar.org/docs
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
stellar-rpc
command
|
|
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval
command
Command coordinator-runner renders the release perf-eval coordinator's sticky PR comment.
|
Command coordinator-runner renders the release perf-eval coordinator's sticky PR comment. |
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval/backfill-test/runner
command
Command runner runs the backfill ingestion benchmark on the box (then keeps serving in handoff mode).
|
Command runner runs the backfill ingestion benchmark on the box (then keeps serving in handoff mode). |
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval/endpoint-load-test/runner
command
Command runner drives the endpoint load-test leg's on-box half: it waits for the backfill box's serve-ready object, seeds request data from it, and blasts its read-path endpoints.
|
Command runner drives the endpoint load-test leg's on-box half: it waits for the backfill box's serve-ready object, seeds request data from it, and blasts its read-path endpoints. |
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval/gather
command
Command gather is the GHA-runner half of every perf-eval leg: it polls S3 for the result object the box publishes and relays it as step outputs.
|
Command gather is the GHA-runner half of every perf-eval leg: it polls S3 for the result object the box publishes and relays it as step outputs. |
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval/go-bench/runner
command
Command runner runs the audited endpoint Go benchmarks on the box for the release candidate and a baseline release, and publishes a benchstat comparison of the two.
|
Command runner runs the audited endpoint Go benchmarks on the box for the release candidate and a baseline release, and publishes a benchstat comparison of the two. |
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval/harness
Package harness holds the generic EC2-leg machinery shared by the perf-eval legs.
|
Package harness holds the generic EC2-leg machinery shared by the perf-eval legs. |
|
stellar-rpc/internal/integrationtest/infrastructure/perf-eval/ingest-load-test/runner
command
Command runner runs the apply-load ingestion benchmark on the box.
|
Command runner runs the apply-load ingestion benchmark on the box. |