Skip to content

Docs: Add inline code examples for all core SDK client methods#111

Open
JinadJay wants to merge 1 commit into
BCPathway:mainfrom
JinadJay:docs/add-sdk-examples
Open

Docs: Add inline code examples for all core SDK client methods#111
JinadJay wants to merge 1 commit into
BCPathway:mainfrom
JinadJay:docs/add-sdk-examples

Conversation

@JinadJay
Copy link
Copy Markdown

  • Added examples for batch query methods (getBalances, getEvents)
  • Added examples for initialize and batchMint methods
  • Added examples for offline transaction builders (buildMintTx, buildTransferTx, buildApproveTx, buildBurnTx, signTx)
  • Added examples for simulation methods (simulate, simulateMint, simulateTransfer)
  • Added examples for multi-sig/admin pool methods (setAdminPool, upgrade, proposeAction, approveProposal, executeProposal)
  • Added examples for regulatory methods (setClawbackAdmin, clawback, updateName, updateSymbol)
  • Added examples for locking/vesting methods (lockTokens, withdrawLocked)
  • Updated API Reference table to include all methods

Closes #92

Summary

Type of Change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 📝 Documentation update
  • 🔧 Smart contract improvement
  • 🧪 Test coverage improvement
  • 🏗️ CI/Build improvement

Related Issue

Closes #

Changes Made

Testing

How has this been tested?

  • Rust unit tests pass (cargo test)
  • SDK compiles (npm run build in sdk/)
  • Manual testing against Soroban testnet
  • New tests added for changes

Test commands run:

# Contract tests
cargo test

# SDK build
cd sdk && npm run build

Checklist

  • My code follows the project's style guidelines
  • I have added NatSpec-style comments to new Rust functions
  • I have added JSDoc comments to new TypeScript functions
  • I have updated the README if needed
  • My branch follows the naming convention: feature/<issue-number>-<description>
  • I have not modified files outside the scope of this issue

Drips.network Contributor Info

  • Drips Profile:
  • Issue Claimed: #

Screenshots (if applicable)

- Added examples for batch query methods (getBalances, getEvents)
- Added examples for initialize and batchMint methods
- Added examples for offline transaction builders (buildMintTx, buildTransferTx, buildApproveTx, buildBurnTx, signTx)
- Added examples for simulation methods (simulate, simulateMint, simulateTransfer)
- Added examples for multi-sig/admin pool methods (setAdminPool, upgrade, proposeAction, approveProposal, executeProposal)
- Added examples for regulatory methods (setClawbackAdmin, clawback, updateName, updateSymbol)
- Added examples for locking/vesting methods (lockTokens, withdrawLocked)
- Updated API Reference table to include all methods

Closes BCPathway#92
@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 27, 2026

@JinadJay Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@JinadJay
Copy link
Copy Markdown
Author

#bc-forge

@p3ris0n
Copy link
Copy Markdown
Contributor

p3ris0n commented May 27, 2026

@JinadJay please resolve conflicts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Add Inline Code Examples to SDK README

2 participants