Appearance

Quick Start Guide ​

Welcome to SORA, your all-in-one tool for Soroban and Stellar development. This guide will walk you through the essential features to help you start developing quickly and efficiently.

Installation ​

Before diving into the features, ensure you have SORA installed on your system. For detailed installation instructions, please refer to our Installation Guide.

TIP

Make sure you have the latest version of SORA installed to access all features and improvements.

Dashboard Overview ​

Upon launching SORA, you'll see a sidebar with the following main sections:

The top right corner shows your active identity and provides options for refreshing and adjusting settings.

1. Setting Up Your Environment ​

Configuring Networks ​

  1. Navigate to the Networks page.
  2. Click "Create New Network" to add a new Stellar network configuration.
  3. Enter the network details, including name, RPC URL, and network passphrase.

2. Managing Identities ​

  1. Go to the Identities page.
  2. Click "Create New Identity" to add a new Stellar identity.
  3. Choose between generating a new identity or importing an existing one.
  4. For testing, use the "Fund" button to add test funds to your identity on supported networks.

3. Creating Your First Project ​

  1. Navigate to the Projects page.
  2. Click "Create New Project" to start a new Soroban project.
  3. Fill in the project details:
    • Project name
    • Project path
    • Choose whether to include example contracts
    • Optionally specify a frontend template
  4. Use the "Open With" button to launch your project in your preferred code editor.

4. Working with Contracts ​

  1. Go to the Contracts page to view all contracts across your projects.
  2. Use the "Contract Actions" button to:
    • Build contracts
    • Deploy contracts
    • Invoke contract functions
  3. Utilize the AI-powered Command Generator for help with complex Soroban CLI commands.

5. Monitoring Events ​

  1. Visit the Events page.
  2. Click "Add New Event" to set up event monitoring for your contracts.
  3. Configure the event details, including start ledger, network, and RPC URL.

6. Using the Lab ​

  1. Access the Lab page for XDR-related operations.
  2. Use the interface to encode, decode, or validate XDR data.
  3. View the command history to track your XDR operations.

7. Reviewing Logs ​

  1. Check the Logs page for a history of commands executed in SORA.
  2. Use the tabs to switch between Command History and Application Logs.
  3. Utilize the search and filter options to find specific log entries.

8. Checking SORA Information ​

  1. Visit the About page for version information on SORA and its components.
  2. Use the provided links to make feature requests, report bugs, or review release notes.

Best Practices for Getting Started ​

TIP

Optimize your SORA experience:

  • Start by creating a small test project to familiarize yourself with the workflow.
  • Regularly check for updates to SORA and related tools.
  • Use the Networks page to manage different Stellar network configurations.
  • Leverage the Logs page to track and repeat common operations.
  • Explore each section of SORA to discover features that can enhance your productivity.

Troubleshooting Common Issues ​

WARNING

Watch out for these common pitfalls:

  • If commands fail, check your active identity and ensure it has the necessary permissions.
  • For network-related issues, verify your network configuration in the Networks page.
  • If contracts aren't deploying, check your identity's balance and network settings.
  • For unexpected behavior, try refreshing SORA or restarting the application.
  • Always keep your SORA version up to date to avoid compatibility issues.

Additional Resources ​

Remember, SORA is designed to streamline your Soroban and Stellar development workflow. Don't hesitate to explore each section in depth as you become more comfortable with the tool.

For more detailed information on each feature, click the links provided in the guide.