Adding documentation for every method

Author: benjaminsalon

docs/Technical-docs/README.md

@@ -4,34 +4,51 @@ soroban-react
 
 ## Table of contents
 
+### Interfaces
+
+- [connect_button_src.ConnectButtonProps](./interfaces/connect_button_src.ConnectButtonProps.md)
+- [contracts_src_contractTransaction.contractTransactionProps](./interfaces/contracts_src_contractTransaction.contractTransactionProps.md)
+- [contracts_src_useContractValue.fetchContractValueProps](./interfaces/contracts_src_useContractValue.fetchContractValueProps.md)
+- [contracts_src_useContractValue.useContractValueProps](./interfaces/contracts_src_useContractValue.useContractValueProps.md)
+- [contracts_src_useSendTransaction.SendTransactionOptions](./interfaces/contracts_src_useSendTransaction.SendTransactionOptions.md)
+- [contracts_src_useSendTransaction.SendTransactionResult](./interfaces/contracts_src_useSendTransaction.SendTransactionResult.md)
+- [core_src_SorobanContext.SorobanContextType](./interfaces/core_src_SorobanContext.SorobanContextType.md)
+- [core_src_SorobanReactProvider.SorobanReactProviderProps](./interfaces/core_src_SorobanReactProvider.SorobanReactProviderProps.md)
+- [types_src.NetworkDetails](./interfaces/types_src.NetworkDetails.md)
+- [types_src.WalletChain](./interfaces/types_src.WalletChain.md)
+- [wallet_data_src.WalletDataProps](./interfaces/wallet_data_src.WalletDataProps.md)
+
+
 ### Modules
 
-- [chains/src](modules/chains_src.md)
-- [connect-button/src](modules/connect_button_src.md)
-- [contracts/src](modules/contracts_src.md)
-- [contracts/src/contractInvoke](modules/contracts_src_contractInvoke.md)
-- [contracts/src/contractTransaction](modules/contracts_src_contractTransaction.md)
-- [contracts/src/defaultAddress](modules/contracts_src_defaultAddress.md)
-- [contracts/src/setTrustline](modules/contracts_src_setTrustline.md)
-- [contracts/src/transaction](modules/contracts_src_transaction.md)
-- [contracts/src/types](modules/contracts_src_types.md)
-- [contracts/src/useContractValue](modules/contracts_src_useContractValue.md)
-- [contracts/src/useSendTransaction](modules/contracts_src_useSendTransaction.md)
-- [core/src](modules/core_src.md)
-- [core/src/SorobanContext](modules/core_src_SorobanContext.md)
-- [core/src/SorobanReactProvider](modules/core_src_SorobanReactProvider.md)
-- [core/src/getDefaultConnectors](modules/core_src_getDefaultConnectors.md)
-- [core/src/useSorobanReact](modules/core_src_useSorobanReact.md)
-- [events/src](modules/events_src.md)
-- [events/src/SorobanEventsContext](modules/events_src_SorobanEventsContext.md)
-- [events/src/SorobanEventsProvider](modules/events_src_SorobanEventsProvider.md)
-- [events/src/useSorobanEvents](modules/events_src_useSorobanEvents.md)
-- [freighter/src](modules/freighter_src.md)
-- [types/src](modules/types_src.md)
-- [utils/src](modules/utils_src.md)
-- [utils/src/convert](modules/utils_src_convert.md)
-- [utils/src/identifiers](modules/utils_src_identifiers.md)
-- [wallet-data/src](modules/wallet_data_src.md)
-- [wallet-data/src/provideWalletChains](modules/wallet_data_src_provideWalletChains.md)
-- [wallet-data/src/useIsMounted](modules/wallet_data_src_useIsMounted.md)
-- [wallet-data/src/useNetwork](modules/wallet_data_src_useNetwork.md)
+- [chains/src](./modules/chains_src.md)
+- [connect-button/src](./modules/connect_button_src.md)
+- [contracts/src](./modules/contracts_src.md)
+- [contracts/src/contractInvoke](./modules/contracts_src_contractInvoke.md)
+- [contracts/src/contractTransaction](./modules/contracts_src_contractTransaction.md)
+- [contracts/src/defaultAddress](./modules/contracts_src_defaultAddress.md)
+- [contracts/src/setTrustline](./modules/contracts_src_setTrustline.md)
+- [contracts/src/transaction](./modules/contracts_src_transaction.md)
+- [contracts/src/types](./modules/contracts_src_types.md)
+- [contracts/src/useContractValue](./modules/contracts_src_useContractValue.md)
+- [contracts/src/useRegisteredContract](./modules/contracts_src_useRegisteredContract.md)
+- [contracts/src/useSendTransaction](./modules/contracts_src_useSendTransaction.md)
+- [contracts/src/wrapStellarAsset](./modules/contracts_src_wrapStellarAsset.md)
+- [core/src](./modules/core_src.md)
+- [core/src/SorobanContext](./modules/core_src_SorobanContext.md)
+- [core/src/SorobanReactProvider](./modules/core_src_SorobanReactProvider.md)
+- [core/src/getDefaultConnectors](./modules/core_src_getDefaultConnectors.md)
+- [core/src/useSorobanReact](./modules/core_src_useSorobanReact.md)
+- [events/src](./modules/events_src.md)
+- [events/src/SorobanEventsContext](./modules/events_src_SorobanEventsContext.md)
+- [events/src/SorobanEventsProvider](./modules/events_src_SorobanEventsProvider.md)
+- [events/src/useSorobanEvents](./modules/events_src_useSorobanEvents.md)
+- [freighter/src](./modules/freighter_src.md)
+- [types/src](./modules/types_src.md)
+- [utils/src](./modules/utils_src.md)
+- [utils/src/convert](./modules/utils_src_convert.md)
+- [utils/src/identifiers](./modules/utils_src_identifiers.md)
+- [wallet-data/src](./modules/wallet_data_src.md)
+- [wallet-data/src/provideWalletChains](./modules/wallet_data_src_provideWalletChains.md)
+- [wallet-data/src/useIsMounted](./modules/wallet_data_src_useIsMounted.md)
+- [wallet-data/src/useNetwork](./modules/wallet_data_src_useNetwork.md)

docs/Technical-docs/interfaces/connect_button_src.ConnectButtonProps.md

@@ -27,7 +27,7 @@ Whether the connect button is higher.
 
 #### Defined in
 
-[connect-button/src/index.tsx:22](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/connect-button/src/index.tsx#L22)
+[connect-button/src/index.tsx:22](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/connect-button/src/index.tsx#L22)
 
 ___
 
@@ -39,7 +39,7 @@ Label for the connect button.
 
 #### Defined in
 
-[connect-button/src/index.tsx:17](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/connect-button/src/index.tsx#L17)
+[connect-button/src/index.tsx:17](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/connect-button/src/index.tsx#L17)
 
 ___
 
@@ -51,4 +51,4 @@ The Soroban context.
 
 #### Defined in
 
-[connect-button/src/index.tsx:27](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/connect-button/src/index.tsx#L27)
+[connect-button/src/index.tsx:27](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/connect-button/src/index.tsx#L27)

docs/Technical-docs/interfaces/contracts_src_contractTransaction.contractTransactionProps.md

@@ -7,6 +7,8 @@ title: contractTransactionProps
 
 [contracts/src/contractTransaction](../modules/contracts_src_contractTransaction.md).contractTransactionProps
 
+Properties for building a transaction to invoke a smart contract method call.
+
 ## Table of contents
 
 ### Properties
@@ -25,7 +27,7 @@ title: contractTransactionProps
 
 #### Defined in
 
-[contracts/src/contractTransaction.tsx:8](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/contractTransaction.tsx#L8)
+[contracts/src/contractTransaction.tsx:11](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/contractTransaction.tsx#L11)
 
 ___
 
@@ -35,7 +37,7 @@ ___
 
 #### Defined in
 
-[contracts/src/contractTransaction.tsx:6](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/contractTransaction.tsx#L6)
+[contracts/src/contractTransaction.tsx:9](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/contractTransaction.tsx#L9)
 
 ___
 
@@ -45,7 +47,7 @@ ___
 
 #### Defined in
 
-[contracts/src/contractTransaction.tsx:7](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/contractTransaction.tsx#L7)
+[contracts/src/contractTransaction.tsx:10](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/contractTransaction.tsx#L10)
 
 ___
 
@@ -55,7 +57,7 @@ ___
 
 #### Defined in
 
-[contracts/src/contractTransaction.tsx:4](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/contractTransaction.tsx#L4)
+[contracts/src/contractTransaction.tsx:7](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/contractTransaction.tsx#L7)
 
 ___
 
@@ -65,4 +67,4 @@ ___
 
 #### Defined in
 
-[contracts/src/contractTransaction.tsx:5](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/contractTransaction.tsx#L5)
+[contracts/src/contractTransaction.tsx:8](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/contractTransaction.tsx#L8)

docs/Technical-docs/interfaces/contracts_src_useContractValue.fetchContractValueProps.md

@@ -26,7 +26,7 @@ title: fetchContractValueProps
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:91](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L91)
+[contracts/src/useContractValue.tsx:96](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L96)
 
 ___
 
@@ -36,7 +36,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:89](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L89)
+[contracts/src/useContractValue.tsx:94](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L94)
 
 ___
 
@@ -46,7 +46,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:90](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L90)
+[contracts/src/useContractValue.tsx:95](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L95)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:88](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L88)
+[contracts/src/useContractValue.tsx:93](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L93)
 
 ___
 
@@ -66,7 +66,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:87](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L87)
+[contracts/src/useContractValue.tsx:92](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L92)
 
 ___
 
@@ -76,4 +76,4 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:92](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L92)
+[contracts/src/useContractValue.tsx:97](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L97)

docs/Technical-docs/interfaces/contracts_src_useContractValue.useContractValueProps.md

@@ -25,7 +25,7 @@ title: useContractValueProps
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:21](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L21)
+[contracts/src/useContractValue.tsx:21](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L21)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:19](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L19)
+[contracts/src/useContractValue.tsx:19](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L19)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:20](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L20)
+[contracts/src/useContractValue.tsx:20](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L20)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:23](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L23)
+[contracts/src/useContractValue.tsx:23](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L23)
 
 ___
 
@@ -65,4 +65,4 @@ ___
 
 #### Defined in
 
-[contracts/src/useContractValue.tsx:22](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useContractValue.tsx#L22)
+[contracts/src/useContractValue.tsx:22](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useContractValue.tsx#L22)

docs/Technical-docs/interfaces/contracts_src_useSendTransaction.SendTransactionOptions.md

@@ -24,7 +24,7 @@ title: SendTransactionOptions
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:29](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L29)
+[contracts/src/useSendTransaction.tsx:35](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L35)
 
 ___
 
@@ -34,7 +34,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:28](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L28)
+[contracts/src/useSendTransaction.tsx:34](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L34)
 
 ___
 
@@ -44,7 +44,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:30](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L30)
+[contracts/src/useSendTransaction.tsx:36](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L36)
 
 ___
 
@@ -54,4 +54,4 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:27](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L27)
+[contracts/src/useSendTransaction.tsx:33](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L33)

docs/Technical-docs/interfaces/contracts_src_useSendTransaction.SendTransactionResult.md

@@ -35,7 +35,7 @@ title: SendTransactionResult<E>
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:12](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L12)
+[contracts/src/useSendTransaction.tsx:12](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L12)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:13](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L13)
+[contracts/src/useSendTransaction.tsx:13](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L13)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:14](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L14)
+[contracts/src/useSendTransaction.tsx:14](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L14)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:15](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L15)
+[contracts/src/useSendTransaction.tsx:15](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L15)
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:16](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L16)
+[contracts/src/useSendTransaction.tsx:16](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L16)
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:17](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L17)
+[contracts/src/useSendTransaction.tsx:17](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L17)
 
 ___
 
@@ -103,7 +103,7 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:22](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L22)
+[contracts/src/useSendTransaction.tsx:28](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L28)
 
 ___
 
@@ -115,20 +115,24 @@ ___
 
 ▸ (`txn?`, `opts?`): `Promise`\<`SimulateTransactionResponse` \| `Object`\>
 
+Sends a transaction and returns the result.
+
 ##### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `txn?` | [`Transaction`](../modules/contracts_src_types.md#transaction) |
-| `opts?` | [`SendTransactionOptions`](contracts_src_useSendTransaction.SendTransactionOptions.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `txn?` | [`Transaction`](../modules/contracts_src_types.md#transaction) | The transaction to send. |
+| `opts?` | [`SendTransactionOptions`](contracts_src_useSendTransaction.SendTransactionOptions.md) | Additional options for sending the transaction. |
 
 ##### Returns
 
 `Promise`\<`SimulateTransactionResponse` \| `Object`\>
 
+A promise that resolves to the transaction response or simulation result.
+
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:18](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L18)
+[contracts/src/useSendTransaction.tsx:24](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L24)
 
 ___
 
@@ -138,4 +142,4 @@ ___
 
 #### Defined in
 
-[contracts/src/useSendTransaction.tsx:23](https://github.com/paltalabs/soroban-react/blob/50e8963/packages/contracts/src/useSendTransaction.tsx#L23)
+[contracts/src/useSendTransaction.tsx:29](https://github.com/paltalabs/soroban-react/blob/cce29de/packages/contracts/src/useSendTransaction.tsx#L29)