-
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,33 @@ | ||
# Smart Contracts Documentation | ||
|
||
## Overview | ||
This document provides an overview of the smart contracts used in the dApp. The contracts are deployed on the Ethereum blockchain and facilitate various functionalities of the application. | ||
|
||
## Contract Name: ExampleContract | ||
### Purpose | ||
The `ExampleContract` is designed to manage user interactions and store data on the blockchain. | ||
|
||
### Functions | ||
1. **getDetails** | ||
- **Description**: Retrieves the name and value stored in the contract. | ||
- **Returns**: | ||
- `string`: Name of the contract. | ||
- `uint256`: A numeric value associated with the contract. | ||
|
||
2. **interact** | ||
- **Description**: Allows users to interact with the contract by sending a value. | ||
- **Parameters**: | ||
- `value` (uint256): The value to be sent to the contract. | ||
- **Returns**: | ||
- `bool`: Indicates whether the interaction was successful. | ||
|
||
### Deployment | ||
- **Network**: Ethereum Mainnet | ||
- **Contract Address**: `0xYourContractAddressHere` | ||
- **ABI**: | ||
```json | ||
1 [ | ||
2 "function getDetails() view returns (string memory, uint256)", | ||
3 "function interact(uint256 value) public returns (bool)" | ||
4 ] | ||
``` |