-
Notifications
You must be signed in to change notification settings - Fork 160
docs: add agent skill for java-stellar-sdk #797
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "name": "lightsail-network", | ||
| "owner": { | ||
| "name": "lightsail-network" | ||
| }, | ||
| "metadata": { | ||
| "description": "Agent skills for the Stellar Java SDK (network.lightsail:stellar-sdk)." | ||
| }, | ||
| "plugins": [ | ||
| { | ||
| "name": "java-stellar-sdk", | ||
| "source": "./", | ||
| "description": "Teaches AI coding agents how to build Stellar blockchain applications using the Java Stellar SDK: transactions, operations, Horizon API, Soroban smart contracts, XDR/SCVal, and SEP protocols.", | ||
| "version": "0.1.0", | ||
| "author": { | ||
| "name": "overcat" | ||
| }, | ||
| "homepage": "https://github.com/lightsail-network/java-stellar-sdk", | ||
| "license": "Apache-2.0", | ||
| "category": "development", | ||
| "tags": ["stellar", "blockchain", "java", "sdk", "soroban", "agent-skill"] | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "name": "java-stellar-sdk", | ||
| "description": "Agent skill that teaches AI coding agents how to build Stellar blockchain applications with the Java Stellar SDK (network.lightsail:stellar-sdk): transactions, operations, Horizon, Soroban, XDR/SCVal, and SEP protocols.", | ||
| "version": "0.1.0", | ||
| "author": { | ||
| "name": "overcat" | ||
| }, | ||
| "homepage": "https://github.com/lightsail-network/java-stellar-sdk", | ||
| "license": "Apache-2.0" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Agent Skill for the Java Stellar SDK | ||
|
|
||
| This directory contains an [Agent Skills](https://agentskills.io/) compatible skill for | ||
| developers building Stellar applications in Java with the `stellar-sdk` package | ||
| (`network.lightsail:stellar-sdk`). | ||
|
|
||
| **Audience: SDK users, not java-stellar-sdk contributors.** The skill is a portable | ||
| artifact that can be installed in another project so coding agents have concise, | ||
| Stellar-specific guidance while generating application code. | ||
|
|
||
| ## Contents | ||
|
|
||
| ```text | ||
| skills/java-stellar-sdk/ | ||
| SKILL.md # entry point: install, conventions, critical rules, examples | ||
| references/ # topic-specific reference files loaded on demand | ||
| ``` | ||
|
|
||
| The skill is self-contained: examples are embedded directly, and external pointers use | ||
| absolute URLs such as the SDK Javadoc and GitHub. It should continue to work after being | ||
| copied into a project that does not contain this repository. | ||
|
|
||
| ## Installation options | ||
|
|
||
| | Environment | How to use this skill | | ||
| | --- | --- | | ||
| | Claude Code plugin | Add this repository as a plugin marketplace and install the `java-stellar-sdk` plugin. The marketplace manifest lives at `.claude-plugin/marketplace.json`. | | ||
| | Claude Code project skill | Copy `skills/java-stellar-sdk/` into your project at `.claude/skills/java-stellar-sdk/`. | | ||
| | Claude Code personal skill | Copy `skills/java-stellar-sdk/` into `~/.claude/skills/java-stellar-sdk/`. | | ||
| | Other Agent Skills compatible tools | Copy `skills/java-stellar-sdk/SKILL.md` and its `references/` directory into the location your tool uses for skills or reusable instructions. | | ||
| | Generic coding agents | Point your agent instructions file at `SKILL.md`, or paste the relevant reference file into the agent context. | | ||
|
|
||
| For Claude Code's skill and plugin behavior, see the Claude Code documentation for | ||
| [skills](https://docs.anthropic.com/en/docs/claude-code/skills) and | ||
| [plugin marketplaces](https://docs.anthropic.com/en/docs/claude-code/plugin-marketplaces). | ||
|
|
||
| ## Discovery and marketplaces | ||
|
|
||
| This repository is set up for two broad distribution paths: | ||
|
|
||
| - **Claude Code marketplaces:** `.claude-plugin/marketplace.json` describes this repository | ||
| as a Claude Code plugin source. | ||
| - **Agent Skills indexes and registries:** public directories or aggregators may discover | ||
| repositories containing `SKILL.md` files. Examples include community indexes such as | ||
| [skillsmp.com](https://skillsmp.com/) and any future Agent Skills compatible catalogs. | ||
|
|
||
| Third-party indexes are convenience discovery channels only. They are not required to use | ||
| the skill, and their indexing behavior, ranking, and update schedule are outside this | ||
| project's control. | ||
|
|
||
| ## Not shipped via Maven | ||
|
|
||
| Adding the `network.lightsail:stellar-sdk` dependency installs the SDK package only. It does | ||
| **not** install this skill. Install the skill through a plugin marketplace, by copying this | ||
| directory, or by cloning this repository. | ||
|
|
||
| ## Maintenance | ||
|
|
||
| The skill is maintained alongside the SDK so examples and API references can stay in sync. | ||
| Keep embedded examples small, explicit, and aligned with the SDK Javadoc. When SDK APIs | ||
| change, review `SKILL.md` and the files under `references/` as part of the same change. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,251 @@ | ||
| --- | ||
| name: java-stellar-sdk | ||
| description: Build Stellar blockchain applications in Java using stellar-sdk (network.lightsail:stellar-sdk). Use for transaction building, signing, Horizon queries, Soroban RPC, smart contract deployment/invocation, XDR/SCVal conversion, and SEP integrations. | ||
| license: Apache-2.0 | ||
| compatibility: Published artifacts target Java 8 bytecode (require Java 8+). Building from source requires JDK 21. | ||
| metadata: | ||
| sdk_package: network.lightsail:stellar-sdk | ||
| repository: lightsail-network/java-stellar-sdk | ||
| docs: https://javadoc.io/doc/network.lightsail/stellar-sdk | ||
| --- | ||
|
|
||
| # Stellar Java SDK (`network.lightsail:stellar-sdk`) | ||
|
|
||
| Write correct Java for the Stellar network using the `stellar-sdk` package. This file is | ||
| self-contained; load a file from `references/` only when the task needs that topic. | ||
|
|
||
| ## Install | ||
|
|
||
| Maven: | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>network.lightsail</groupId> | ||
| <artifactId>stellar-sdk</artifactId> | ||
| <version>3.0.0</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| Gradle: | ||
|
|
||
| ```groovy | ||
| implementation 'network.lightsail:stellar-sdk:3.0.0' | ||
| ``` | ||
|
|
||
| ## Import style | ||
|
|
||
| Public APIs live under `org.stellar.sdk`; operations under `org.stellar.sdk.operations`; | ||
| the contract helpers under `org.stellar.sdk.contract`; SCVal helpers under | ||
| `org.stellar.sdk.scval`; exceptions under `org.stellar.sdk.exception`, with the high-level | ||
| contract-client exceptions under `org.stellar.sdk.contract.exception`. | ||
|
|
||
| ```java | ||
| import org.stellar.sdk.Asset; | ||
| import org.stellar.sdk.KeyPair; | ||
| import org.stellar.sdk.Network; | ||
| import org.stellar.sdk.Server; | ||
| import org.stellar.sdk.Transaction; | ||
| import org.stellar.sdk.TransactionBuilder; | ||
| import org.stellar.sdk.operations.PaymentOperation; | ||
| import org.stellar.sdk.scval.Scv; | ||
| ``` | ||
|
|
||
| ## Clients | ||
|
|
||
| - `Server` — Horizon client. See `references/horizon.md`. | ||
| - `SorobanServer` — Soroban RPC client (`Closeable`). See `references/soroban.md`. | ||
| - `ContractClient` — high-level Soroban contract client (`Closeable`) that wraps the | ||
| simulate → prepare → sign → submit flow. See `references/soroban.md`. | ||
|
|
||
| The SDK is **synchronous** (built on OkHttp); there is no separate async client. | ||
|
|
||
| ## Java conventions (read this first) | ||
|
|
||
| These are the things that most often trip people up with *this* SDK: | ||
|
|
||
| - **Operations use Lombok builders.** Every operation is built with `XxxOperation.builder()... | ||
| .build()`, e.g. `PaymentOperation.builder().destination(d).asset(a).amount(amt).build()`. | ||
| `InvokeHostFunctionOperation` instead exposes static factories (see `references/operations.md`). | ||
| - **There are three asset types — don't mix them up.** `Asset` (payments, offers, paths), | ||
| `ChangeTrustAsset` (the `ChangeTrustOperation` line, wraps an `Asset` or `LiquidityPool`), and | ||
| `TrustLineAsset` (balances/trustline entries). See `references/assets.md`. | ||
| - **Amounts and balances are `BigDecimal`.** `new BigDecimal("10.5")`, never `double`/`float`. | ||
| - **`G...` and `M...` both work as a destination.** Address strings accept plain ed25519 | ||
| accounts and SEP-23 muxed accounts; use `MuxedAccount` to build/parse `M...` (see | ||
| `references/sep.md`). | ||
| - **Clients are `Closeable`.** `Server.close()`; wrap `SorobanServer`/`ContractClient` in | ||
| try-with-resources. `SSEStream` from `.stream(...)` must also be closed to stop it. | ||
| - **SDK exceptions are unchecked.** Everything extends `RuntimeException` | ||
| (`org.stellar.sdk.exception.SdkException`), so the compiler will not force you to catch them — | ||
| you still should. The common supertype for network/RPC errors is `NetworkException`. | ||
| - **`KeyPair.getSecretSeed()` returns `char[]`,** not `String`, so it can be zeroed after use. | ||
| - **Android:** works out of the box on API level 28+. For lower levels add the | ||
| [Java Stellar SDK Android SPI](https://github.com/lightsail-network/java-stellar-sdk-android-spi). | ||
| - **Example syntax.** The SDK runs on **Java 8+**, but the snippets in this skill use some | ||
| Java 9–16 conveniences for brevity. On Java 8, substitute equivalents: `List.of(...)` → | ||
| `Arrays.asList(...)`, `Map.of(...)` → a populated `LinkedHashMap`, `"x".repeat(n)` → a literal, | ||
| pattern-matching `instanceof` → a classic cast, and `java.net.http` → `HttpURLConnection` or | ||
| any HTTP client. | ||
|
|
||
| ## Critical rules (do not violate) | ||
|
|
||
| 1. **`BigDecimal` amounts, never `double`/`float`.** Use `new BigDecimal("350.1234567")`, | ||
| not `350.1234567`. Lumens have 7 decimal places; binary floats lose precision. | ||
| 2. **Prefer loading secret seeds at runtime** (env / a secret manager) over embedding | ||
| them in source: `KeyPair.fromSecretSeed(System.getenv("STELLAR_SECRET_KEY"))`. | ||
| 3. **Always set a timeout** with `.setTimeout(...)` (or explicit time bounds). A | ||
| transaction without one can hang in the pending pool indefinitely. | ||
| 4. **Use the correct network.** `Network.TESTNET` vs `Network.PUBLIC`. Signatures are | ||
| network-specific; a testnet-signed transaction is invalid on mainnet. | ||
| 5. **`TransactionBuilder.build()` increments the source account's sequence number.** If you | ||
| build but do not submit (or submission fails with `tx_bad_seq`), reload the account with | ||
| `server.loadAccount(...)` before building again. | ||
| 6. **For Soroban, prepare before signing.** `sorobanServer.prepareTransaction(tx)` (or | ||
| `ContractClient.invoke(...)` which simulates by default) fills in footprint, auth, and | ||
| resource fees. Signing before this produces an invalid transaction. | ||
| 7. **Convert contract args with `Scv.to*`** and read results with `Scv.from*`. Never pass | ||
| raw Java values to a contract. | ||
| 8. **Restore archived state** when simulation reports archived entries (see | ||
| `references/soroban.md`). | ||
| 9. **Close clients.** Call `server.close()` for `Server`; use try-with-resources for | ||
| `SorobanServer` and `ContractClient` (both implement `Closeable`). | ||
| 10. **Catch specific SDK exceptions** (`BadRequestException`, `BadResponseException`, | ||
| `PrepareTransactionException`, …), not a broad `Exception`. They all extend | ||
| `SdkException`; network/HTTP errors additionally share the `NetworkException` supertype, | ||
| but `PrepareTransactionException` and the contract-lifecycle exceptions extend | ||
| `SdkException` directly. Network/RPC exceptions live in `org.stellar.sdk.exception`; | ||
| `ContractClient`/`AssembledTransaction` errors live in `org.stellar.sdk.contract.exception`. | ||
|
|
||
| ## Minimal end-to-end examples | ||
|
|
||
| ### 1. Create / load a keypair | ||
|
|
||
| ```java | ||
| import org.stellar.sdk.KeyPair; | ||
|
|
||
| // New random account (fund it before use — see example 2). | ||
| KeyPair kp = KeyPair.random(); | ||
| System.out.println(kp.getAccountId()); // G... (safe to share) | ||
| System.out.println(kp.getSecretSeed()); // S... (secret — never log or commit in real code) | ||
|
|
||
| // Load an existing account from the environment. | ||
| KeyPair signer = KeyPair.fromSecretSeed(System.getenv("STELLAR_SECRET_KEY")); | ||
|
|
||
| // Verify-only keypair (cannot sign). | ||
| KeyPair publicOnly = KeyPair.fromAccountId("GD2JXEFGEO53CNQ22KN2ICOQ2LOASCABQHAIOMLZV265C246PFKKHPYU"); | ||
| ``` | ||
|
|
||
| ### 2. Build, sign, and submit a payment | ||
|
|
||
| ```java | ||
| import java.math.BigDecimal; | ||
| import org.stellar.sdk.*; | ||
| import org.stellar.sdk.operations.PaymentOperation; | ||
| import org.stellar.sdk.responses.TransactionResponse; | ||
|
|
||
| KeyPair source = KeyPair.fromSecretSeed(System.getenv("STELLAR_SECRET_KEY")); | ||
| String destination = "GD2JXEFGEO53CNQ22KN2ICOQ2LOASCABQHAIOMLZV265C246PFKKHPYU"; | ||
|
|
||
| Server server = new Server("https://horizon-testnet.stellar.org"); | ||
|
|
||
| // Reload right before building so the sequence number is current. | ||
| TransactionBuilderAccount account = server.loadAccount(source.getAccountId()); | ||
|
|
||
| PaymentOperation payment = | ||
| PaymentOperation.builder() | ||
| .destination(destination) | ||
| .asset(Asset.createNativeAsset()) | ||
| .amount(new BigDecimal("350.1234567")) // BigDecimal amount | ||
| .build(); | ||
|
|
||
| Transaction transaction = | ||
| new TransactionBuilder(account, Network.TESTNET) | ||
| .setBaseFee(Transaction.MIN_BASE_FEE) | ||
| .addMemo(Memo.text("Hello, Stellar!")) | ||
| .addOperation(payment) | ||
| .setTimeout(30) | ||
| .build(); | ||
|
|
||
| transaction.sign(source); | ||
| TransactionResponse response = server.submitTransaction(transaction); | ||
| System.out.println(response.getHash()); | ||
| server.close(); | ||
| ``` | ||
|
|
||
| New testnet accounts can be funded by Friendbot: | ||
| `GET https://friendbot.stellar.org?addr=<G...>`. | ||
|
|
||
| ### 3. Query Horizon | ||
|
|
||
| ```java | ||
| import org.stellar.sdk.Server; | ||
| import org.stellar.sdk.requests.RequestBuilder; | ||
| import org.stellar.sdk.responses.Page; | ||
| import org.stellar.sdk.responses.operations.OperationResponse; | ||
|
|
||
| Server server = new Server("https://horizon.stellar.org"); | ||
|
|
||
| // Request builders are chainable; .execute() runs the HTTP request. | ||
| Page<OperationResponse> payments = | ||
| server.payments() | ||
| .forAccount("GB6NVEN5HSUBKMYCE5ZOWSK5K23TBWRUQLZY3KNMXUZ3AQ2ESC4MY4AQ") | ||
| .order(RequestBuilder.Order.DESC) | ||
| .limit(10) | ||
| .execute(); | ||
| for (OperationResponse op : payments.getRecords()) { | ||
| System.out.println(op.getType()); | ||
| } | ||
| ``` | ||
|
|
||
| ### 4. Invoke a Soroban contract (read-only) | ||
|
|
||
| For contracts you call repeatedly, prefer **generated typed bindings** (see | ||
| `references/bindings.md`). The hand-written form with `ContractClient` is: | ||
|
|
||
| ```java | ||
| import java.util.List; | ||
| import org.stellar.sdk.Network; | ||
| import org.stellar.sdk.contract.ContractClient; | ||
| import org.stellar.sdk.scval.Scv; | ||
| import org.stellar.sdk.xdr.SCVal; | ||
|
|
||
| // A read-only call needs no signer, but `source` is required and must be an account | ||
| // that already exists on the target network — simulate() loads its sequence via | ||
| // server.getAccount(), which throws AccountNotFoundException if the account is missing. | ||
| String source = "GD2JXEFGEO53CNQ22KN2ICOQ2LOASCABQHAIOMLZV265C246PFKKHPYU"; | ||
|
|
||
| try (ContractClient client = | ||
| new ContractClient( | ||
| "CACZTW72246RA2MOCNKUBRRRRPT26UZ7LXE5ZHH44OGKIMCTQJ74O4D5", | ||
| "https://soroban-testnet.stellar.org:443", | ||
| Network.TESTNET)) { | ||
| SCVal result = | ||
| client | ||
| .invoke("hello", List.of(Scv.toSymbol("world")), source, null, null, | ||
| (int) org.stellar.sdk.Transaction.MIN_BASE_FEE) | ||
| .result(); // read-only: no signer needed | ||
| System.out.println(result); | ||
| } | ||
| ``` | ||
|
|
||
| For a state-changing call, pass `source` and `signer`, then `signAndSubmit(...)`. See | ||
| `references/soroban.md`. | ||
|
|
||
| ## Reference index | ||
|
|
||
| Load on demand: | ||
|
|
||
| - `references/quickstart.md` — install → keypair → fund → payment → query → contract. | ||
| - `references/transactions.md` — transaction lifecycle, memos, preconditions, fee bump, | ||
| multisig, XDR round-trips, sequence-number pitfalls. | ||
| - `references/assets.md` — `Asset` vs `ChangeTrustAsset` vs `TrustLineAsset`, native vs | ||
| alphanum4/12, canonical form. | ||
| - `references/operations.md` — catalog of every operation and its builder. | ||
| - `references/horizon.md` — Horizon client, request builders, pagination, streaming, errors. | ||
| - `references/soroban.md` — Soroban RPC client + `ContractClient`/`AssembledTransaction`. | ||
| - `references/bindings.md` — generate typed contract clients with `stellar-contract-bindings`. | ||
| - `references/xdr_scval.md` — SCVal conversion, `Address`, XDR encode/decode. | ||
| - `references/sep.md` — SEP support matrix and common flows (SEP-02/05/10/23/35/45/...). | ||
| - `references/troubleshooting.md` — exception hierarchy and common failures. | ||
|
|
||
| Full API docs (Javadoc): https://javadoc.io/doc/network.lightsail/stellar-sdk | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.