Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readme #108

Merged
merged 1 commit into from
Mar 21, 2024
Merged
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
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# soroban-rpc
RPC Server for Soroban Contracts.


This repo is home to the Soroban RPC, soon to be renamed 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](https://developers.stellar.org/network/soroban-rpc/methods).

## To Use an Ecosystem RPCs
To enable autocomplete permanently, run:
To use RPC from an ecosystem provider for futurenet, testnet, or mainnet, please see our list of [Ecosystem RPC Providers](https://developers.stellar.org/network/soroban-rpc/rpc-providers).

## Run Your Own RPC
If you are interested in running your own RPC, please review the [Admin Guide](https://developers.stellar.org/network/soroban-rpc/admin-guide).

## Latest Release
For latest releases, please see
[releases](https://github.com/stellar/soroban-rpc/releases).

## Upcoming Features
For upcoming features, please see the [project
board](https://github.com/orgs/stellar/projects/37).

## Report Bugs or Request Features
To report bugs or request features, please open an issue on the official [RPC
repo](https://github.com/stellar/soroban-rpc).

## To Contribute
Please fork this see `good first issues` on
[here](https://github.com/stellar/soroban-rpc/contribute).

Developer Docs: https://developers.stellar.org/docs
Loading