{"id":20091051,"url":"https://github.com/lfscamargo/soroban.boilerplate","last_synced_at":"2025-10-11T02:38:32.925Z","repository":{"id":259641840,"uuid":"879045437","full_name":"LFSCamargo/soroban.boilerplate","owner":"LFSCamargo","description":"Stellar and soroban smart contract boilerplate","archived":false,"fork":false,"pushed_at":"2024-11-21T16:56:27.000Z","size":215,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-13T02:47:58.065Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LFSCamargo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-26T20:14:35.000Z","updated_at":"2024-11-15T02:34:41.000Z","dependencies_parsed_at":"2024-10-27T03:24:40.698Z","dependency_job_id":"b9628804-05f2-4bea-be4d-fff14b8ef809","html_url":"https://github.com/LFSCamargo/soroban.boilerplate","commit_stats":null,"previous_names":["lfscamargo/soroban.boilerplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFSCamargo%2Fsoroban.boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFSCamargo%2Fsoroban.boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFSCamargo%2Fsoroban.boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LFSCamargo%2Fsoroban.boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LFSCamargo","download_url":"https://codeload.github.com/LFSCamargo/soroban.boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241526738,"owners_count":19976994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T16:27:57.314Z","updated_at":"2025-10-11T02:38:27.877Z","avatar_url":"https://github.com/LFSCamargo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Soroban Boilerplate\n\nThis repository provides a boilerplate for building Soroban contracts on the Stellar network. It includes a CLI tool for deploying contracts, a basic contract example, and a recommended project structure.\n\n## Project Structure\n\nThis repository uses the recommended structure for a Soroban project:\n\n```text\n.\n├── .github/workflows\n│   └── code-quality.yml\n├── .vscode\n│   ├── extensions.json\n│   └── settings.json\n├── cli\n│   ├── src\n│   │   ├── commands\n│   │   │   ├── deploy.ts\n│   │   │   └── index.ts\n│   │   ├── types\n│   │   │   ├── index.ts\n│   │   │   └── network.ts\n│   │   ├── utility\n│   │   │   ├── index.ts\n│   │   │   ├── directory-utility.ts\n│   │   │   ├── contract-utility.ts\n│   │   │   └── network-utility.ts\n│   │   └── main.ts\n│   ├── package.json\n│   └── tsconfig.json\n├── contracts\n│   └── hello_world\n│       ├── src\n│       │   ├── lib.rs\n│       │   └── test.rs\n│       └── Cargo.toml\n├── scripts\n│   └── install_stellar.sh\n├── .editorconfig\n├── .gitignore\n├── .nvmrc\n├── .prettierrc\n├── Cargo.lock\n├── Cargo.toml\n├── Makefile\n├── package.json\n├── pnpm-workspace.yaml\n├── README.md\n└── rustfmt.toml\n```\n\n## CLI Tool\n\nThe CLI tool is located in the `cli` directory. It provides commands to deploy Soroban contracts to the Stellar network.\n\n### Deploy Command\n\nTo deploy a contract, use the following command:\n\n```bash\npnpm deploy --deployer \u003csecretKey\u003e --contractWasm \u003cpath\u003e\n```\n\nReplace `\u003csecretKey\u003e` with the secret key of the account deploying the contract and `\u003cpath\u003e` with the path to the compiled WASM file of the contract.\n\n### Example\n\nTo deploy the `hello_world` contract, first compile it using the Rust toolchain:\n\n```bash\nmake build\n```\n\nThen, deploy it using the CLI:\n\n```bash\npnpm deploy --network \u003cdesired_network\u003e # Specify the network you want to deploy to, either testnet or mainnet\n --deployer \u003cyour_secret_key\u003e # A Stellar account secret key that looks like this `SBX5Q2Z7Y3F6V4Z5X6Y7Z8A9B0C1D2E3F4G5H6I7J8K9L0M1N2O3P4Q5R6S7T8U9`\n --contractWasm ./contracts/hello_world/target/wasm32v1-none/release/hello_world.wasm\n --constructorArgs \u003cfirst_argument\u003e # In this case we are going to pass the address of the owner\n --constructorArgs \u003csecond_argument\u003e # In this case we are going to pass the default greeting\n```\n\n## Contracts\n\nThe `hello_world` contract is a simple example that can be found in the `contracts/hello_world` directory. It includes a basic implementation of a Soroban contract written in Rust.\n\n## Installation, Building and Testing\n\nTo install the necessary dependencies for the project, run the following command:\n\n```bash\npnpm install\n```\n\nTo build the project, use the following command:\n\n```bash\nmake build\n```\n\nTo test the project, run:\n\n```bash\nmake test\n```\n\n## Code Quality Github Workflow\n\nThis repository includes a GitHub Actions workflow for code quality checks. The workflow is defined in `.github/workflows/code-quality.yml` and runs on every push and pull request. It checks for tests, and compiles the Rust contracts.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfscamargo%2Fsoroban.boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flfscamargo%2Fsoroban.boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flfscamargo%2Fsoroban.boilerplate/lists"}