Skip to content

chore: update public API XML docs#141

Merged
jopmiddelkamp merged 2 commits intomasterfrom
feature/complete-xml-docs
Mar 31, 2026
Merged

chore: update public API XML docs#141
jopmiddelkamp merged 2 commits intomasterfrom
feature/complete-xml-docs

Conversation

@cuongph87
Copy link
Copy Markdown
Contributor

@cuongph87 cuongph87 commented Mar 27, 2026

Auto-generated Summary 🤖

Types of changes

This addresses #136

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses issue #136 by reducing public API XML documentation debt across the SDK so IntelliSense and generated docs provide clearer guidance for the Horizon/Soroban/ledger/domain surfaces.

Changes:

  • Adds/updates XML <summary>, <remarks>, <param>, <returns>, and enum value docs across many public types.
  • Documents request builder APIs (Horizon + Soroban RPC) and response/result models to improve discoverability.
  • Documents key domain primitives (transactions, keys/StrKey, memo types, ledger keys/entries, claim predicates, assets).

Reviewed changes

Copilot reviewed 194 out of 194 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
StellarDotnetSdk/Transactions/TransactionPreconditions.cs Adds XML docs for validation and V2 precondition detection methods.
StellarDotnetSdk/Transactions/TransactionBuilder.cs Adds class/member XML docs for transaction builder usage.
StellarDotnetSdk/Transactions/Transaction.cs Adds XML docs for transaction and Soroban-related mutators.
StellarDotnetSdk/Transactions/TimeBounds.cs Adds property docs for MinTime/MaxTime.
StellarDotnetSdk/Transactions/SubmitTransactionOptions.cs Adds class docs for submission options.
StellarDotnetSdk/Transactions/FeeBumpTransaction.cs Adds class docs for fee bump transactions.
StellarDotnetSdk/StrKey.cs Adds enum and enum-value docs for StrKey version bytes.
StellarDotnetSdk/Soroban/TransactionEvent.cs Adds class docs for Soroban transaction events.
StellarDotnetSdk/Soroban/SorobanTransactionMetaExtensionV1.cs Adds class docs for Soroban meta extension v1.
StellarDotnetSdk/Soroban/SorobanTransactionData.cs Adds class docs for Soroban transaction data.
StellarDotnetSdk/Soroban/SorobanServer.cs Adds Dispose() behavior documentation.
StellarDotnetSdk/Soroban/SorobanResources.cs Adds class docs for Soroban resource limits.
StellarDotnetSdk/Soroban/SorobanResourceExtensionV0.cs Adds class/method docs for archived entry extensions + XDR conversion.
StellarDotnetSdk/Soroban/ScAddress.cs Adds docs for Soroban address wrapper subclasses.
StellarDotnetSdk/Soroban/SCVal.cs Adds docs for many Soroban value/error types and XDR conversion helpers.
StellarDotnetSdk/Soroban/OperationMetaV2.cs Adds class docs for v2 operation metadata.
StellarDotnetSdk/Soroban/ExtensionPoint.cs Adds docs for zero-discriminant extension point.
StellarDotnetSdk/Soroban/DiagnosticEvent.cs Adds class docs for diagnostic events.
StellarDotnetSdk/Soroban/ContractEventV0.cs Adds class docs for contract event V0 body.
StellarDotnetSdk/Soroban/ContractEvent.cs Adds class docs for contract events.
StellarDotnetSdk/Soroban/AuthMode.cs Adds enum docs for auth mode.
StellarDotnetSdk/Signer.cs Adds class docs for account signers.
StellarDotnetSdk/Server.cs Adds class docs, request-builder property docs, and Root() docs.
StellarDotnetSdk/Responses/SorobanRpc/TransactionInfo.cs Adds class docs and transaction status enum docs.
StellarDotnetSdk/Responses/SorobanRpc/SorobanRpcResponse.cs Adds generic JSON-RPC response envelope docs.
StellarDotnetSdk/Responses/SorobanRpc/SimulateTransactionResponse.cs Adds docs for LedgerEntryChange model.
StellarDotnetSdk/Responses/SorobanRpc/SendTransactionResponse.cs Adds docs for send-transaction status enum values.
StellarDotnetSdk/Responses/SorobanRpc/GetTransactionsResponse.cs Adds class docs for getTransactions response.
StellarDotnetSdk/Responses/SorobanRpc/GetTransactionResponse.cs Adds class docs for getTransaction response.
StellarDotnetSdk/Responses/SorobanRpc/GetLedgerEntriesResponse.cs Adds class docs for getLedgerEntries response.
StellarDotnetSdk/Responses/SorobanRpc/GetLatestLedgerResponse.cs Adds class docs for getLatestLedger response.
StellarDotnetSdk/Responses/SorobanRpc/GetHealthResponse.cs Adds class docs for getHealth response.
StellarDotnetSdk/Responses/SorobanRpc/GetFeeStatsResponse.cs Adds docs for inclusion fee stats model.
StellarDotnetSdk/Responses/SorobanRpc/GetEventsResponse.cs Adds docs for event info model.
StellarDotnetSdk/Responses/SorobanRpc/Events.cs Adds class docs describing events collection payload.
StellarDotnetSdk/Responses/Results/TransactionResult.cs Adds docs for some transaction result subclasses and inner result pair.
StellarDotnetSdk/Responses/Results/SimplePaymentResult.cs Adds class docs.
StellarDotnetSdk/Responses/Results/SetTrustlineFlagsResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/SetOptionsResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/RevokeSponsorshipResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/RestoreFootprintResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/PaymentResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/PathPaymentStrictSendResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/PathPaymentStrictReceiveResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/OperationResult.cs Adds base operation result docs.
StellarDotnetSdk/Responses/Results/OfferEntry.cs Adds docs for offer entry flags enum.
StellarDotnetSdk/Responses/Results/ManageSellOfferResult.cs Adds docs for result + success variants (deleted/created/updated).
StellarDotnetSdk/Responses/Results/ManageDataResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/ManageBuyOfferResult.cs Adds docs for result + success variants (deleted/updated/created).
StellarDotnetSdk/Responses/Results/LiquidityPoolWithdrawResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/LiquidityPoolDepositResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/InvokeHostFunctionResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/InflationResult.cs Adds docs for result + success result and nested payout model.
StellarDotnetSdk/Responses/Results/ExtendFootprintTtlResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/EndSponsoringFutureReservesResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/CreateClaimableBalanceResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/CreateAccountResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/ClawbackResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/ClawbackClaimableBalanceResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/ClaimClaimableBalanceResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/ChangeTrustResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/BumpSequenceResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/BeginSponsoringFutureReservesResult.cs Adds docs for result + success result.
StellarDotnetSdk/Responses/Results/AllowTrustResult.cs Adds class docs for allow trust result.
StellarDotnetSdk/Responses/Results/AccountMergeResult.cs Adds class docs for account merge result.
StellarDotnetSdk/Requests/UriTemplate.cs Adds docs for both template resolution overloads.
StellarDotnetSdk/Requests/TransactionsRequestBuilder.cs Adds class docs for transactions endpoint builder.
StellarDotnetSdk/Requests/TradesRequestBuilder.cs Adds method docs for trade filtering (base/counter/offer).
StellarDotnetSdk/Requests/TradesAggregationRequestBuilder.cs Adds method docs for aggregation query parameters.
StellarDotnetSdk/Requests/SorobanRpc/SorobanRpcRequest.cs Adds docs for JSON-RPC request envelope.
StellarDotnetSdk/Requests/SorobanRpc/GetTransactionsRequest.cs Adds docs for getTransactions request parameters.
StellarDotnetSdk/Requests/SorobanRpc/GetEventsRequest.cs Adds docs for getEvents request + nested filter/pagination types.
StellarDotnetSdk/Requests/ResponseHandler.cs Adds docs for response deserialization + exception translation.
StellarDotnetSdk/Requests/RequestBuilderStreamable.cs Adds docs for streamable request builder interface/base class.
StellarDotnetSdk/Requests/RequestBuilderExecutePageable.cs Adds docs for pageable execution interface/base class.
StellarDotnetSdk/Requests/RequestBuilder.cs Adds docs for OrderDirection enum and Uri property.
StellarDotnetSdk/Requests/PaymentsRequestBuilder.cs Adds docs for payments request builder interfaces.
StellarDotnetSdk/Requests/PathsRequestBuilder.cs Adds docs for path query parameters + validation behavior.
StellarDotnetSdk/Requests/PathStrictSendRequestBuilder.cs Adds docs for strict-send query methods.
StellarDotnetSdk/Requests/PathStrictReceiveRequestBuilder.cs Adds docs for strict-receive query methods.
StellarDotnetSdk/Requests/OrderBookRequestBuilder.cs Adds docs for order book endpoint + asset setters.
StellarDotnetSdk/Requests/OperationsRequestBuilder.cs Adds class docs for operations endpoint builder.
StellarDotnetSdk/Requests/OffersRequestBuilder.cs Adds docs for offers request options model.
StellarDotnetSdk/Requests/LiquidityPoolsRequestBuilder.cs Adds docs for reserve filtering helper.
StellarDotnetSdk/Requests/LedgersRequestBuilder.cs Adds class docs for ledgers endpoint builder.
StellarDotnetSdk/Requests/HttpResponseException.cs Adds class docs describing HTTP error exception.
StellarDotnetSdk/Requests/FriendBotRequestBuilder.cs Adds docs for Friendbot endpoint builder and parameter setter.
StellarDotnetSdk/Requests/FeeStatsRequestBuilder.cs Adds class docs for fee stats endpoint builder.
StellarDotnetSdk/Requests/EffectsRequestBuilder.cs Adds class docs and docs for liquidity pool effects helpers.
StellarDotnetSdk/Requests/DefaultStellarSdkHttpClient.cs Adds class docs for preconfigured HttpClient behavior.
StellarDotnetSdk/Requests/ClaimableBalancesRequestBuilder.cs Adds docs for filtering helper methods.
StellarDotnetSdk/Requests/AccountsRequestBuilder.cs Adds docs for accounts request options model.
StellarDotnetSdk/Operations/InvokeHostFunctionOperation.cs Adds docs for Soroban invoke/create/upload ops and many related models/helpers.
StellarDotnetSdk/Network.cs Adds class docs for network passphrase/network id concept.
StellarDotnetSdk/Memos/MemoText.cs Adds class/property docs for text memo.
StellarDotnetSdk/Memos/MemoReturnHash.cs Adds class docs for return-hash memo.
StellarDotnetSdk/Memos/MemoNone.cs Adds class docs for memo none.
StellarDotnetSdk/Memos/MemoId.cs Adds class docs for memo id.
StellarDotnetSdk/Memos/MemoHash.cs Adds class docs for memo hash.
StellarDotnetSdk/LiquidityPool/LiquidityPoolId.cs Adds class docs and XDR conversion docs.
StellarDotnetSdk/LiquidityPool/LiquidityPoolConstantProductParameters.cs Adds class docs for constant product pool parameters.
StellarDotnetSdk/LiquidityPool/LiquidityPool.cs Adds class docs for liquidity pool domain object.
StellarDotnetSdk/LedgerKeys/LedgerKeyTtl.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyTrustline.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyOffer.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyLiquidityPool.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyData.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyContractData.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyContractCode.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyConfigSetting.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyClaimableBalance.cs Adds class docs.
StellarDotnetSdk/LedgerKeys/LedgerKeyAccount.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/TrustlineEntryExtensionV2.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/TrustlineEntryExtensionV1.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/StateArchivalSettings.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/OfferEntryExtension.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LiquidityPoolConstantProduct.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryUpdated.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryTtl.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryTrustline.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryRestored.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryOffer.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryLiquidityPool.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryExtensionV1.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryData.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryCreated.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryContractData.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryContractCode.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryClaimableBalance.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/LedgerEntryAccount.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/EvictionIterator.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/DataEntryExtension.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ContractCodeEntryExtensionV1.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ContractCodeCostInputs.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingScpTiming.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingLiveSorobanStateSizeWindow.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractParallelComputeV0.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractMaxSizeBytes.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractLedgerCostExtV0.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractLedgerCost.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractHistoricalData.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractExecutionLanes.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractEvents.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractDataKeySizeBytes.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractDataEntrySizeBytes.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractCostParamsMemoryBytes.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractCostParamsCpuInstructions.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractCostParamEntry.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractCompute.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ConfigSettingContractBandwidth.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/ClaimableBalanceEntryExtensionV1.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/AccountEntryExtensionV3.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/AccountEntryExtensionV2.cs Adds class docs.
StellarDotnetSdk/LedgerEntries/AccountEntryExtensionV1.cs Adds class docs.
StellarDotnetSdk/Federation/StellarTomlNotFoundInvalidException.cs Adds exception docs.
StellarDotnetSdk/Federation/ServerErrorException.cs Adds exception docs.
StellarDotnetSdk/Federation/NotFoundException.cs Adds exception docs.
StellarDotnetSdk/Federation/MalformedAddressException.cs Adds exception docs.
StellarDotnetSdk/Federation/FederationServer.cs Adds Dispose() documentation for underlying HttpClient.
StellarDotnetSdk/Federation/ConnectionErrorException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/TooManySignaturesException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/TooManyRequestsException.cs Adds exception/constructor docs.
StellarDotnetSdk/Exceptions/SubmitTransactionUnknownResponseException.cs Adds exception/constructor docs.
StellarDotnetSdk/Exceptions/SubmitTransactionTimeoutResponseException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/ServiceUnavailableException.cs Adds exception/constructor docs.
StellarDotnetSdk/Exceptions/NotEnoughSignaturesException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/NoNetworkSelectedException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/MemoTooLongException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/FormatException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/ClientProtocolException.cs Adds exception docs.
StellarDotnetSdk/Exceptions/AssetCodeLengthInvalidException.cs Adds exception docs.
StellarDotnetSdk/EventSources/SSEEventSource.cs Adds class/member docs for SSE event source wrapper.
StellarDotnetSdk/EventSources/IEventSource.cs Adds interface/member docs for SSE contract.
StellarDotnetSdk/Converters/SendTransactionStatusEnumJsonConverter.cs Adds converter docs.
StellarDotnetSdk/Converters/KeyPairJsonConverter.cs Adds converter docs.
StellarDotnetSdk/Claimants/ClaimPredicateUnconditional.cs Adds class docs.
StellarDotnetSdk/Claimants/ClaimPredicateOr.cs Adds class/ctor docs.
StellarDotnetSdk/Claimants/ClaimPredicateNot.cs Adds class/ctor docs.
StellarDotnetSdk/Claimants/ClaimPredicateBeforeRelativeTime.cs Adds class docs.
StellarDotnetSdk/Claimants/ClaimPredicateBeforeAbsoluteTime.cs Adds class/ctor/property docs.
StellarDotnetSdk/Claimants/ClaimPredicateAnd.cs Adds class/ctor docs.
StellarDotnetSdk/ClaimAtom.cs Adds docs for claim atom subclasses.
StellarDotnetSdk/Base32Encoding.cs Adds docs for Base32 encoding options.
StellarDotnetSdk/Assets/TrustlineAsset.cs Adds docs for XDR conversion and wrapper type.
StellarDotnetSdk/Assets/LiquidityPoolShareTrustlineAsset.cs Adds class/method docs for pool share trustline asset.
StellarDotnetSdk/Assets/LiquidityPoolShareChangeTrustAsset.cs Adds class/method docs for pool share change trust asset.
StellarDotnetSdk/Assets/ChangeTrustAsset.cs Adds docs for wrapper type.
StellarDotnetSdk/Assets/AssetTypeNative.cs Adds class docs.
StellarDotnetSdk/Assets/AssetTypeCreditAlphaNum4.cs Adds class docs.
StellarDotnetSdk/Assets/AssetTypeCreditAlphaNum12.cs Adds class docs.
StellarDotnetSdk/Accounts/MuxedAccountMed25519.cs Adds class and IsMuxedAccount docs.
StellarDotnetSdk/Accounts/KeyPair.cs Improves class/member XML docs and remarks.
StellarDotnetSdk/Accounts/ITransactionBuilderAccount.cs Adds interface docs.
StellarDotnetSdk/Accounts/IAccountId.cs Adds interface docs.

Comment thread StellarDotnetSdk/Transactions/TransactionPreconditions.cs
Comment thread StellarDotnetSdk/Transactions/TransactionBuilder.cs
Copy link
Copy Markdown
Contributor

@jopmiddelkamp jopmiddelkamp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

XML Documentation Review

I verified every factual claim across all 194 changed files. The vast majority are accurate and well-written. Found 6 issues in the new documentation that need attention (details in inline comments below).

Note: I also found some pre-existing documentation issues (not introduced by this PR) that may be worth fixing separately:

  • KeyPair.cs Sign() returns doc says "null if the private key is null" but actually throws an Exception
  • KeyPair.cs FromSecretSeed(string) param has typo "eed Char array" (should be "Seed string")
  • KeyPair.cs FromPublicKey says "32 byte address" (should be "32 byte public key" — "address" means StrKey-encoded in Stellar)
  • FederationServer.cs CreateForDomain has typo "reates" (missing "C")
  • ClaimAtom.cs base class says "owner" but for ClaimAtomLiquidityPool the XDR says "pool"
  • ScAddress.cs ScContractId param says "contract pool ID" — "pool" is a copy-paste error

Comment thread StellarDotnetSdk/Exceptions/TooManySignaturesException.cs Outdated
Comment thread StellarDotnetSdk/Exceptions/NotEnoughSignaturesException.cs Outdated
Comment thread StellarDotnetSdk/Exceptions/SubmitTransactionTimeoutResponseException.cs Outdated
Comment thread StellarDotnetSdk/Soroban/SCVal.cs Outdated
Comment thread StellarDotnetSdk/Requests/FriendBotRequestBuilder.cs Outdated
Comment thread StellarDotnetSdk/Requests/PathStrictSendRequestBuilder.cs Outdated
@jopmiddelkamp jopmiddelkamp merged commit 34cadad into master Mar 31, 2026
4 checks passed
@jopmiddelkamp jopmiddelkamp deleted the feature/complete-xml-docs branch March 31, 2026 02:33
@cuongph87 cuongph87 added the chore label Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants