Skip to content

thanedouglass/soroban-stellar-contracts

Repository files navigation

Soroban Project

Project Structure

This repository uses the recommended structure for a Soroban project:

.
├── contracts
│   └── hello_world
│       ├── src
│       │   ├── lib.rs
│       │   └── test.rs
│       └── Cargo.toml
├── Cargo.toml
└── README.md
  • New Soroban contracts can be put in contracts, each in their own directory. There is already a hello_world contract in there to get you started.
  • If you initialized this project with any other example contracts via --with-example, those contracts will be in the contracts directory as well.
  • Contracts should have their own Cargo.toml files that rely on the top-level Cargo.toml workspace for their dependencies.
  • Frontend libraries can be added to the top-level directory as well. If you initialized this project with a frontend template via --frontend-template you will have those files already included.

Soroban Frontend in Astro

A Frontend Template suitable for use with soroban contract init --frontend-template, powered by Astro.

Getting Started

  • cp .env.example .env
  • npm install
  • npm run dev

How it works

If you look in package.json, you'll see that the start & dev scripts first run the initialize.js script. This script loops over all contracts in contracts/* and, for each:

  1. Deploys to a local network (needs to be running with docker run or soroban network start)
  2. Saves contract IDs to .soroban/contract-ids
  3. Generates TS bindings for each into the packages folder, which is set up as an npm workspace
  4. Create a file in src/contracts that imports the contract client and initializes it for the standalone network.

You're now ready to import these initialized contract clients in your Astro templates or your React, Svelte, Vue, Alpine, Lit, and whatever else JS files. You can see an example of this in index.astro.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published