harmony-one / bounties

Bounty program is to help the community take part in the development of the Harmony blockchain. It covers from core feature to validator tooling, from dApp development to DeFi integration.

MIT License

59 stars 23 forks source link

Encode Hackathon - Bug bounty for Harmony Marketplace SDK (Documentation Error) #126

Open victaphu opened 1 year ago

victaphu commented 1 year ago

Description

Related to the Encode Hackathon, this bounty is for promotion of the Harmony Marketplace SDK

Context

Identify documentation errors in the Harmony Marketplace SDK and do a PR to fix the errors. Limited to 10 errors found in the SDK

Acceptance Criteria

[ ] Document the error found in the SDK on this bug bounty
[ ] Link to the PR that is pushed to the Marketplace SDK

Reward

We will reward based on the document errors found and may bundle a few errors together for payment 3 bounties up to $300 USD in ONE per bounty

victaphu commented 1 year ago

@jacksteroo please review and confirm

jacksteroo commented 1 year ago

Confirmed

j05u3 commented 1 year ago

The approve, allowance and transferFrom functions in HRC20 had a wrong description
The contractURI function in HRC721 had a wrong description
tokenURI on HRC721 didn't have a parameter in the example code

PR: https://github.com/blockcoders/harmony-marketplace-sdk/pull/54

We also added more details to the documentation about the functions of HRC20, HRC721 and HRC1155 according to the methods available on the marketplace-sdk and its parameters, 🙏 please comment whether they are necessary or need to be removed.

victaphu commented 1 year ago

hi @j05u3 thanks for the PR, let me get the blockcoders folks to confirm and we can start approving it

victaphu commented 1 year ago

hey @j05u3 did you find any other documentation improvements?

j05u3 commented 1 year ago

hey @j05u3 did you find any other documentation improvements?

we couldn't find other improvements, only the ones on the PR