opcode-open-spring-fest / net_worth_mate

"Net Worth Mate" is designed as a comprehensive asset management platform that offers users a robust set of tools to manage and evaluate their financial holdings.

Net_Worth_Mate

Introduction ✨

"Net Worth Mate" is designed as a comprehensive asset management platform that offers users a robust set of tools to manage and evaluate their financial holdings.

Technologies Used 🧑‍💻

• Solidity

Contact 📱

If you have any questions or feedback, please reach out to us at [email protected] or [email protected] 📧

Setup

To set up Net_Worth_Mate on your local machine, follow these steps:

1. Fork the repository:

   • Click the "Fork" button at the top right corner of this repository's page on GitHub. This will create a copy of the repository in your GitHub account.

2. Clone the forked repository:

git clone https://github.com/<yourusername>/net_worth_mate.git

3. Navigate to the project directory:

cd net_worth_mate

4. Install Node.js dependencies(make sure node is installed on your laptop):

npm i

5. Open the contract folder and copy all the contents of the net_worth_mate.sol file and paste it on remix (or you can use VS Code but remix ide is recommended). Remix ide(link) : http://lnkiy.in/Remix_ide
6. Create a new branch for your feature or bug fix.
7. Make your changes and commit them.
8. Push to the branch.
9. Submit a pull request with the issue number.

You are good to go to make your contribution!! All the best!.

net_worth_mate's Issues

[Feature]:

So, what is it about?

Asset Management Smart Contract

1. Enter Assets Function:

• Allows a user to enter their asset details such as house cost, jewellery cost, cars cost, land cost, and cash cost.
• Calculates the total worth and stores it.

2. View Own Assets:

• Only the owner of the assets can view their details.

3. Check Worth Function:

• Enables a user to check the total worth of their assets.

4. Update Details Function:

• Allows the owner to update their asset details.

5. Sell Function:

• Allows the owner to sell assets.
• Checks are performed to ensure that the owner has sufficient assets to sell.

6. Buy Function:

• Enables the owner to buy assets from outside.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Create a function to set a broker.

So, what is it about?

Create a function so that the user can set any address as it's broker(only one address ) . This broker can now sell any asset on behalf of the user. Also a portion of the sell i.e. commission goes to the broker(3%).

Note: Update the assets of the broker and the user.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Create a function to sell.

So, what is it about?

Create a function with appropriate modifiers so that the user can sell his assets according to his choice .
Input : (seller's address, thing to be sold(string)(ex: house), uint amt(the cost of that product))

Note: Accordingly update the cash of the seller and the buyer.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Set limit on the broker

So, what is it about?

Create a function so that the user can set limit on the broker as to what he can sell and at a maximum of what degree .This function allows for more control over the broker's actions and prevents unauthorized sales beyond specified limits.
Input type: (name of the asset, uint cost of the asset)

Note: Update the assets of the broker and the user.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Create a function to enter and view asset details.

So, what is it about?

Create a function with appropriate modifiers so that the user can enter their asset details i.e.. cost of their house, jewelry, automobiles(cars, motorbikes, yacht, etc.), cash, miscellaneous. Store these details in the structure and then map it with their address. And then also create a function so that a person can view his assets (without taking any input )

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Create a function to buy from outside the contract.

So, what is it about?

Create a function with appropriate modifiers so that the user can buy some assets from outside the contract (suppose from a shop) .
Input : (thing to be bought(string)(ex: house), uint amt(the cost of that product))

Note: Accordingly update the cash and asset of the user.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]:

So, what is it about?

Additional Functions

7. Set Broker Function:

• Allows the owner to set a broker for their assets.
• The broker will be responsible for managing the selling and buying of assets on behalf of the owner.

8. Set Limit Function:

• Enables the owner to set limits on what the broker can sell and for how much.
• This function allows for more control over the broker's actions and prevents unauthorized sales beyond specified limits.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Create a function to update his asset details

So, what is it about?

Create a function with appropriate modifiers so that the update his asset details i.e.. cost of their house, jewelry, automobiles(cars, motorbikes, yacht, etc.), cash, miscellaneous.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Create a function to view his entire net worth.

So, what is it about?

Create a function so that a user can view his entire net worth(without taking any input).
Return type: Uint

Code of Conduct

• I agree to follow this project's Code of Conduct