Skip to content

Commit

Permalink
[Soroban Merge] Tools section (#304)
Browse files Browse the repository at this point in the history
* add some placeholders for the new "tools" pages

* add a navbar item for the new "tools" sidebar

* use a `docsSidebar` item for the `Docs` navbar item

* create a second sidebar for 'tools' and manually do the docs sidebar

* add some redirects for the tools page

* move the current tools/sdks page into the tools section for now

* fix some broken links

* adding Soroban and Stellar tools

Tools pages combined from Soroban and Stellar docs in the Developer Tools section in Tools tab

* first SDKs

* small changes to SDKs directory structure

* fix some broken links

* added the rest of the SDKs

* move some things around

* update to sdk library and topnav

* add a note and link to the AssemblyScript SDK on byoSDK page

* add a touch of context to the SDKs generated index page? (testing)

* correct a link for okashi in dev-tools

* remove "learning tools" from Tools list

* adding Keizai (newly added Soroban tool)

* remove old tools & SDKs section

* add missing link

* quick README update

* change soroban-cli repository link in dev tools

---------

Co-authored-by: Bri <[email protected]>
  • Loading branch information
ElliotFriend and briwylde08 authored Feb 23, 2024
1 parent 0a9fa5c commit 1d2725f
Show file tree
Hide file tree
Showing 13 changed files with 532 additions and 139 deletions.
2 changes: 1 addition & 1 deletion api/horizon/introduction/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Horizon is an API for interacting with the Stellar network.

This API serves the bridge between apps and [Stellar Core](/docs/run-core-node). Projects like wallets, decentralized exchanges, and asset issuers use Horizon to submit transactions, query an account balance, or stream events like transactions to an account.

Horizon is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) and can be accessed via cURL, a browser, or one of the [Stellar SDKs](/docs/tools-and-sdks). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls.
Horizon is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) and can be accessed via cURL, a browser, or one of the [Stellar SDKs](/docs/tools/sdks). To reduce the complexity of your project, we recommend you use an SDK instead of making direct API calls.

The Stellar Development Foundation (SDF) runs two instances of Horizon:

Expand Down
2 changes: 1 addition & 1 deletion docs/building-apps/wallet/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,4 @@ The anchor class also supports [SEP-10]: Stellar Authentication and [SEP-24]: Ho
[sep-24]: https:/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md
[sep-10]: ./sep10.mdx
[sep-24]: ./sep24.mdx
[horizon sdk]: /docs/tools-and-sdks#sdk-library
[horizon sdk]: /docs/tools/sdks
2 changes: 1 addition & 1 deletion docs/fundamentals-and-concepts/stellar-stack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The Soroban CLI is the command line interface to Soroban and can be downloaded [

SDKs simplify some of the work of accessing Horizon and the Soroban RPC by converting the data into friendlier formats and allowing you to program in the language of your choice. Stellar’s SDKs show you how to request data and create and submit transactions. Soroban's SDKs allow you to write smart contracts in Rust and interact with smart contracts in a myriad of other languages.

View Stellar's [SDK library](../tools-and-sdks#sdk-library) to access our SDKs and their documentation. View Soroban's [SDK library](https://soroban.stellar.org/docs/category/sdks) in the Soroban docs.
View Stellar's [SDK library](../tools/sdks/library.mdx) to access our SDKs and their documentation. View Soroban's [SDK library](https://soroban.stellar.org/docs/category/sdks) in the Soroban docs.

## DeFi protocols

Expand Down
2 changes: 1 addition & 1 deletion docs/run-core-node/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Alert } from "@site/src/components/Alert";

Stellar is a peer-to-peer network made up of nodes, which are computers that keep a common distributed [ledger](../fundamentals-and-concepts/stellar-data-structures/ledgers.mdx), and that communicate to validate and add [transactions](../fundamentals-and-concepts/stellar-data-structures/operations-and-transactions.mdx) to it. Nodes use a program called Stellar Core — an implementation of the [Stellar Consensus Protocol](../fundamentals-and-concepts/stellar-consensus-protocol.mdx) — to stay in sync as they work to agree on the validity of transaction sets and to apply them to the ledger. Generally, nodes reach consensus, apply a transaction set, and update the ledger every 3-5 seconds.

You don’t need to run a node to build on Stellar: you can start developing with your [SDK of choice](../tools-and-sdks.mdx#sdk-library), and use public instances of Horizon to query the ledger and submit transactions right away. In fact, the Stellar Development Foundation offers two public instances of Horizon — one for the public network and one for the testnet — which you can read more about in our [API reference docs](https://developers.stellar.org/api). [Lobstr](https://horizon.stellar.lobstr.co), [Public Node](https://horizon.publicnode.org/), and [Coinqvest](https://horizon.stellar.coinqvest.com) also offer public Horizon instances.
You don’t need to run a node to build on Stellar: you can start developing with your [SDK of choice](../tools/sdks/library.mdx), and use public instances of Horizon to query the ledger and submit transactions right away. In fact, the Stellar Development Foundation offers two public instances of Horizon — one for the public network and one for the testnet — which you can read more about in our [API reference docs](https://developers.stellar.org/api). [Lobstr](https://horizon.stellar.lobstr.co), [Public Node](https://horizon.publicnode.org/), and [Coinqvest](https://horizon.stellar.coinqvest.com) also offer public Horizon instances.

Even if you _do_ want to run your [own instance of Horizon](../run-platform-server/index.mdx), it bundles its own version of Core and manages its lifetime entirely, so there's no need to run a standalone instance.

Expand Down
127 changes: 0 additions & 127 deletions docs/tools-and-sdks.mdx

This file was deleted.

140 changes: 140 additions & 0 deletions docs/tools/developer-tools.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
---
title: Developer Tools
sidebar_position: 20
---

## Anchor Tools

### [Anchor Directory](https://anchors.stellar.org/?)

View all anchors on Stellar, their currencies, and where they operate.

### [Demo Wallet](https://demo-wallet.stellar.org/)

An application for interactively testing anchor services. Lets financial application developers test their integrations and learn how Stellar ecosystem protocols (SEPs) work; use the demo wallet to test Regulated Assets (SEP-8), Hosted Deposit and Withdrawal (SEP-24), and Cross-Border Payments (SEP-31) with any home domain that has a Stellar Info File (also known as SEP-1, or a stellar.toml file).

### [Polaris](https://django-polaris.readthedocs.io/en/stable/)

An extendable django app that makes it easy for anchors to facilitate cross-border payments and enable deposits and withdrawals; run a web server supporting any combination of SEP-1, 6, 10, 12, and 24.

## Asset Tools

### [Asset Sandbox](https://stellar.cheesecakelabs.com/?utm_source=stellar&utm_medium=landing-page&utm_campaign=stellar-asset-sandbox)

A sandbox supported by SDF and Cheesecake Labs for businesses to experiment with asset issuance on Stellar's test network.

## Block Explorers

### [StellarExpert](https://stellar.expert/explorer/public)

Explore transactions and network activity with StellarExpert. Check stats specific to an asset code, transaction hash, account address, or ledger sequence number. Not available for Futurenet.

### [StellarChain](https://stellarchain.io/)

Explore transactions and network activity for Stellar’s networks, including Futurenet.

### [Soroban Explorer](https://soroban.nownodes.io/)

Built specifically for Soroban, you can explore transactions and network activity for Stellar’s Testnet and Futurenet (Mainnet coming soon).

### [Stellar Explorer](https://steexp.com/)

Check data related to payments, accounts, deployed contracts, and more for Stellar’s Futurenet, Testnet, and Mainnet.

## CLI

### [Soroban CLI](https:/stellar/soroban-cli)

The command line interface to Soroban smart contracts. It allows you to build, deploy, and interact with smart contracts; configure identities; generate key pairs; manage networks; and more.

Install Soroban CLI as explained in [Setup](https://soroban.stellar.org/docs/getting-started/setup).

Auto-generated comprehensive reference documentation is available [here](https:/stellar/soroban-cli/blob/main/docs/soroban-cli-full-docs.md).

## Data Indexers

### [SubQuery](https://subquery.network/)

An open-source data indexer that supports both Stellar and Soroban. SubQuery allows users to build a custom API for their dapp or smart contract and provides clean indexed data to any service. You can index ledgers, transactions, operations, and effects from Stellar and transactions and events from Soroban into your own Postgres database. Read the quick start guide here.

### [Mercury](https://mercurydata.app/)

A network indexing service that provides a toolkit to help get you started working with Stellar network data.

### [BlockEden](https://blockeden.xyz/)

An all-in-one Soroban RPC, indexer GraphQL API, and data analytics web portal.

### [Goldsky](https://goldsky.com/)

Mirror and indexer coming soon.

## GUIs

[Laboratory](https://laboratory.stellar.org/#?network=test)

A GUI where you can use and learn about the Stellar network on the Testnet and Pubnet. You can create accounts, construct and submit transactions, and query Horizon endpoints without needing to know code.

[Okashi](https://okashi.dev)

A web GUI for building, deploying, and testing contracts.

## IDEs

[Sorobix](https://sorobix.vercel.app/)

An IDE where you can write, deploy, and invoke contracts on the Stellar network using Soroban.

## Network Status

### [Dashboard](https://dashboard.stellar.org/)

Displays the current status of the Testnet and Mainnet. Monitor fee stats, recent operations, lumen supply, and more.

### [Stellarbeat](https://stellarbeat.io/)

View Stellar network nodes and visualize consensus.

### [Status Page](https://status.stellar.org/)

Tracks network incidents and scheduled maintenance for the Testnet and Mainnet. Subscribe to updates to be notified about important events, including protocol upgrades and Testnet resets.

## Smart Contract Resources

### [Soroban Copilot](https:/mootz12/soroban-copilot)

A collection of no_std Rust packages focused on making Soroban development easier.

### [Soroban React](https:/esteblock/soroban-react)

A simple, powerful framework for building modern Soroban dapps using React.

### [Soroban Dev](https://sorobandev.com/)

A web developer's guide to Soroban. Contains guides for learning Soroban and Rust, developer tools, example applications, and more.

## Core and Horizon Operator Tools

### [GitHub Repository](https:/stellar/go/tree/master/tools)

A GitHub repository with tools like Stellar Archivist (for Stellar Core archive maintenance) and Horizon cmp (compares responses of two Horizon servers).

## Testing

### [Keizai](https://keizai.dev/)

Keizai is an open-source postman-inspired application, designed to simplify and elevate the testing process for developers working with Soroban smart contracts.

## Wallets

### [Account Viewer](https://accountviewer.stellar.org/)

A stripped-down wallet where you can check an account’s XLM balance and send simple payments on Testnet and Mainnet.

### [Albedo](https://albedo.link/)

A web-based wallet for Stellar transaction signing and identity verification.

### [Freighter](https://www.freighter.app/)

SDF’s flagship non-custodial wallet extension that allows users to sign Stellar transactions via their browser.
10 changes: 10 additions & 0 deletions docs/tools/sdks/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: SDKs
sidebar_position: 10
---

import DocCardList from "@theme/DocCardList";

This section provides the [SDK Library](./library.mdx) that contains a complete collection of SDKs that can interact with the Stellar network. We also detail the minimum requirements if you'd like to [Build Your Own SDK](./build-your-own.mdx).

<DocCardList />
Loading

0 comments on commit 1d2725f

Please sign in to comment.