added docstring to usecontract and use token balance hooks #216

Redarcher9 · 2022-01-06T11:50:52Z

Closes #190

Description

Added docstring to useContract and useTokenBalance hooks

📝 Additional Information

Anything else you'd want reviewers to know.

changeset-bot · 2022-01-06T11:50:54Z

🦋 Changeset detected

Latest commit: 3d00718

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@web3-ui/hooks	Minor
@web3-ui/core	Patch
example	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Redarcher9 · 2022-01-06T13:18:01Z

@Nazeeh21 , I've raised a pull request for issue #190

Nazeeh21 · 2022-01-07T13:55:39Z

packages/hooks/src/hooks/useTokenBalance.ts

@@ -9,6 +9,20 @@ interface Props {
  accountAddress: string;
 }

+/**
+ * @dev Hook to use account token balance


I think Hook to get the token balance of the account would be more appropriate

Is this hook going to get used when something like a button saying "usetokenbalance" is clicked?.

Nazeeh21 · 2022-01-07T13:58:56Z

packages/hooks/src/hooks/useTokenBalance.ts

@@ -9,6 +9,20 @@ interface Props {
  accountAddress: string;
 }

+/**
+ * @dev Hook to use account token balance
+ * @param {string} tokenAddress Address of the token


@param tokenAddress Address of the token

Nazeeh21 · 2022-01-07T14:01:06Z

packages/hooks/src/hooks/useTokenBalance.ts

+/**
+ * @dev Hook to use account token balance
+ * @param {string} tokenAddress Address of the token
+ * @param {string} accountAddress Address of the account


param accountAddress Address of the account

Nazeeh21 · 2022-01-07T14:03:55Z

packages/hooks/src/hooks/useTokenBalance.ts

+ * @param {string} tokenAddress Address of the token
+ * @param {string} accountAddress Address of the account
+ * @returns {
+ * balance {string}:  balance in Wei converted to string.


balance: gives account balance for the token in Wei as a string

Nazeeh21 · 2022-01-07T14:05:31Z

packages/hooks/src/hooks/useTokenBalance.ts

+ * @param {string} accountAddress Address of the account
+ * @returns {
+ * balance {string}:  balance in Wei converted to string.
+ * loading {boolean}: True until transaction is undergoing, false when error is caught.


loading: True until the transaction is executing, false otherwise

Nazeeh21 · 2022-01-07T14:09:09Z

packages/hooks/src/hooks/useContract.ts

@@ -2,6 +2,16 @@ import React from 'react';
 import { Web3Context } from '../Provider';
 import { Contract } from 'ethers';

+/**
+ * @dev Hook to use a contract
+ * @param {string} address contract address


@param address contract address

Nazeeh21 · 2022-01-07T14:10:16Z

packages/hooks/src/hooks/useContract.ts

@@ -2,6 +2,16 @@ import React from 'react';
 import { Web3Context } from '../Provider';
 import { Contract } from 'ethers';

+/**
+ * @dev Hook to use a contract


@dev Hook to get the contract instance from ABI and contract address

Nazeeh21 · 2022-01-07T14:12:08Z

packages/hooks/src/hooks/useContract.ts

+/**
+ * @dev Hook to use a contract
+ * @param {string} address contract address
+ * @param {string} accountAddress contract ABI


@param abi contract ABI

Nazeeh21 · 2022-01-07T14:13:15Z

packages/hooks/src/hooks/useContract.ts

+ * @param {string} address contract address
+ * @param {string} accountAddress contract ABI
+ * @returns {
+ * contract {string}: Current contract in use


contract: An instance of the current contract

Nazeeh21 · 2022-01-07T14:13:50Z

packages/hooks/src/hooks/useContract.ts

+ * @param {string} accountAddress contract ABI
+ * @returns {
+ * contract {string}: Current contract in use
+ * isReady {boolean}: True when contract is set, false otherwise.


isReady: True when the contract is ready to use, false otherwise.

…okenbalance

Nazeeh21 · 2022-01-07T18:47:25Z

packages/hooks/src/hooks/useTokenBalance.ts

+/**
+ * @dev Hook to get the token balance of the account
+ * @param tokenAddress Address of the token
+ * param accountAddress Address of the account


@param accountAddress Address of the account

Nazeeh21

Overall nice, just a minor change is needed. Sorry for not adding the @ in the suggested review.

Redarcher9 · 2022-01-07T18:59:34Z

Hey @Nazeeh21 , sorry my bad I should have checked before commiting the change

with-heart · 2022-01-07T19:12:52Z

You should remove these files:

.changeset/rude-chefs-love.md
.vscode/settings.json

Changesets add entries to the CHANGELOG file so we should only create them with messages relevant to our users, and local VSCode settings shouldn't be checked in :)

Redarcher9 · 2022-01-07T19:20:51Z

Hi @with-heart ,

Thanks for your inputs. I'll make the changes and commit it.
I've a quick question for you though, what's the correct way to use changeset? Should I run the yarn changeset command after committing and pushing my code?

.changeset/three-donuts-sniff.md

packages/hooks/src/hooks/useContract.ts

packages/hooks/src/hooks/useTokenBalance.ts

packages/hooks/src/hooks/useContract.ts

with-heart · 2022-01-07T19:33:41Z

I've a quick question for you though, what's the correct way to use changeset? Should I run the yarn changeset command after committing and pushing my code?

Yeap that's fine! Usually adding changesets is the last thing I do when making a PR

Co-authored-by: with-heart <with.heart+git@pm.me>

…okenbalance

Redarcher9 · 2022-01-09T03:58:54Z

Hi @with-heart @Nazeeh21 ,
Can you please review my pull request? I've made the requested changes.

Nazeeh21 · 2022-01-09T11:08:18Z

Sure, will review it tomorrow

Nazeeh21 · 2022-01-10T05:12:29Z

Changes LGTM. We'll merge it once @with-heart approves it.
Thanks.

Dhaiwat10 · 2022-01-11T02:09:44Z

@allcontributors please add @Redarcher9 for docs!

allcontributors · 2022-01-11T02:09:52Z

@Dhaiwat10

I've put up a pull request to add @Redarcher9! 🎉

added docstring to usecontract and use token balance hooks

e9a20b1

added docstring to usecontract and usetokenbalance hooks

52a4dec

Nazeeh21 requested a review from Dhaiwat10 January 6, 2022 19:45

Nazeeh21 suggested changes Jan 7, 2022

View reviewed changes

Redarcher9 and others added 2 commits January 7, 2022 21:11

Merge branch 'Developer-DAO:main' into add-docstring-useContract-useT…

322ae45

…okenbalance

Added requested changes

0568e25

Redarcher9 requested a review from Nazeeh21 January 7, 2022 17:40

Nazeeh21 reviewed Jan 7, 2022

View reviewed changes

Nazeeh21 suggested changes Jan 7, 2022

View reviewed changes

Added requested changes

0aad754

Redarcher9 requested a review from Nazeeh21 January 7, 2022 18:58

Redarcher9 added 2 commits January 8, 2022 00:54

Delete rude chefs love.md

9d1f285

Delete vscode directory

daf47e6

with-heart requested changes Jan 7, 2022

View reviewed changes

Redarcher9 and others added 4 commits January 8, 2022 01:13

Update packages/hooks/src/hooks/useTokenBalance.ts

6d15ac0

Co-authored-by: with-heart <with.heart+git@pm.me>

Update .changeset/three-donuts-sniff.md

6d3847a

Co-authored-by: with-heart <with.heart+git@pm.me>

Update packages/hooks/src/hooks/useContract.ts

d236eff

Co-authored-by: with-heart <with.heart+git@pm.me>

Update packages/hooks/src/hooks/useContract.ts

543c721

Co-authored-by: with-heart <with.heart+git@pm.me>

Redarcher9 requested a review from with-heart January 7, 2022 19:46

Merge branch 'Developer-DAO:main' into add-docstring-useContract-useT…

5e5f2f6

…okenbalance

Nazeeh21 approved these changes Jan 10, 2022

View reviewed changes

Dhaiwat10 added 2 commits January 11, 2022 07:34

Merge branch 'main' into add-docstring-useContract-useTokenbalance

ef56919

Update useTokenBalance.ts

3d00718

Dhaiwat10 merged commit ece14b2 into Developer-DAO:main Jan 11, 2022

allcontributors bot mentioned this pull request Jan 11, 2022

docs: add Redarcher9 as a contributor for doc #236

Merged

github-actions bot mentioned this pull request Jan 11, 2022

Version Packages #233

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added docstring to usecontract and use token balance hooks #216

added docstring to usecontract and use token balance hooks #216

Redarcher9 commented Jan 6, 2022

changeset-bot bot commented Jan 6, 2022 •

edited

Loading

Redarcher9 commented Jan 6, 2022

Nazeeh21 Jan 7, 2022 •

edited

Loading

Redarcher9 Jan 7, 2022 •

edited

Loading

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 Jan 7, 2022

Nazeeh21 left a comment •

edited

Loading

Redarcher9 commented Jan 7, 2022

with-heart commented Jan 7, 2022

Redarcher9 commented Jan 7, 2022 •

edited

Loading

with-heart commented Jan 7, 2022

Redarcher9 commented Jan 9, 2022 •

edited

Loading

Nazeeh21 commented Jan 9, 2022

Nazeeh21 commented Jan 10, 2022

Dhaiwat10 commented Jan 11, 2022

allcontributors bot commented Jan 11, 2022

added docstring to usecontract and use token balance hooks #216

added docstring to usecontract and use token balance hooks #216

Conversation

Redarcher9 commented Jan 6, 2022

Description

📝 Additional Information

changeset-bot bot commented Jan 6, 2022 • edited Loading

🦋 Changeset detected

Redarcher9 commented Jan 6, 2022

Nazeeh21 Jan 7, 2022 • edited Loading

Choose a reason for hiding this comment

Redarcher9 Jan 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nazeeh21 left a comment • edited Loading

Choose a reason for hiding this comment

Redarcher9 commented Jan 7, 2022

with-heart commented Jan 7, 2022

Redarcher9 commented Jan 7, 2022 • edited Loading

with-heart commented Jan 7, 2022

Redarcher9 commented Jan 9, 2022 • edited Loading

Nazeeh21 commented Jan 9, 2022

Nazeeh21 commented Jan 10, 2022

Dhaiwat10 commented Jan 11, 2022

allcontributors bot commented Jan 11, 2022

changeset-bot bot commented Jan 6, 2022 •

edited

Loading

Nazeeh21 Jan 7, 2022 •

edited

Loading

Redarcher9 Jan 7, 2022 •

edited

Loading

Nazeeh21 left a comment •

edited

Loading

Redarcher9 commented Jan 7, 2022 •

edited

Loading

Redarcher9 commented Jan 9, 2022 •

edited

Loading