Documentation request: interacting with smart contracts

wackerow commented 9 months ago

Re-posting issue from #6327 to bring to surface. Still think this is a good idea and help welcomed

Is your feature request related to a problem? Please describe.

In our smart contract docs we explain how to write, compile & deploy smart contracts but often developers don't want/need to deploy their own smart contracts, they simply want to interact with existing contracts that are already deployed.

Describe the solution you'd like

Create a new "Interacting with smart contracts" documentation page: (within /smart-contracts/)

Explain the different ways to interact with smart contracts (i.e. CRUD)
- querying data (which doesn't create a transaction)
- mutating data, by triggering a tx from an EOA (or from another contract)
Explain contract ABIs & how they are consumed by other developer tools/libraries to understand the interface of a smart contract & how to interact with the contract
List different approaches/tools/projects that allow developer to write programs that interact with contracts
- e.g. https://ethereum.org/en/developers/docs/apis/javascript/
- e.g. https://ethereum.org/en/developers/docs/apis/backend/
Link to tutorials that demonstrate different approaches?
- e.g. https://ethereum.org/en/developers/tutorials/calling-a-smart-contract-from-javascript/
...anything else?

Describe alternatives you've considered

Considered adding a section on ABIs in the "Compiling smart contracts" page but this topic seems to warrant a dedicated page. Often people who want to interact with a smart contract won't be the person compiling/deploying the contract.

Additional context

This came up in discussions on #6308 & the value of having greater explanation of contract ABI & metadata.

Want to contribute?

We love contributions from the Ethereum community! Please comment on an issue if you'd like to give any input or if you're interested in helping out with a PR.

allwin199 commented 9 months ago

@wackerow I would like to contribute.

NirmitKhurana10 commented 9 months ago

I would want to contribute to this please.

NirmitKhurana10 commented 9 months ago

@wackerow

wackerow commented 8 months ago

Hey @NirmitKhurana10! Sorry for delay and thanks for volunteering... Assigning you to the issue... for content like this, please don't hesitate to post an outline or draft here for some initial review before committing too much time to this.

Our Discord server is always available as well to get feedback if needed.

wackerow commented 8 months ago

Shoot sorry, I see @allwin199 had replied first... You're currently assigned to the opcodes issue... @NirmitKhurana10 I don't see you assigned to any, so for the sake of balance will keep you assigned for now, but please let us know if you don't have capacity for this. Thanks!

NirmitKhurana10 commented 8 months ago

I am available for any issues, let me know!

On Tue, Mar 19, 2024 at 3:59 PM Paul Wackerow @.***> wrote:

Shoot sorry, I see @allwin199 https://github.com/allwin199 had replied first... You're currently assigned to the opcodes issue... @NirmitKhurana10 https://github.com/NirmitKhurana10 I don't see you assigned to any, so for the sake of balance will keep you assigned for now, but please let us know if you don't have capacity for this. Thanks!

— Reply to this email directly, view it on GitHub https://github.com/ethereum/ethereum-org-website/issues/12195#issuecomment-2008010062, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQDTUQAFJJM3GCWYDJTY5TTYZCKIPAVCNFSM6AAAAABDKYTCJWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMBYGAYTAMBWGI . You are receiving this because you were mentioned.Message ID: @.***>

NirmitKhurana10 commented 8 months ago

Can you please give me a link to the opcodes issue

wackerow commented 8 months ago

Hey @NirmitKhurana10, the opcodes PR was separate from this, and has already been merged (#12217)... are you still interested in working on this issue?

github-actions[bot] commented 6 months ago

This issue is stale because it has been open 30 days with no activity.

minimalsm commented 3 months ago

Hey @NirmitKhurana10, I've unassigned you here to open it up to the community as we've not heard anything.

Let us know if you're still interested on working on this 😀 thanks!

github-actions[bot] commented 1 month ago

This issue is stale because it has been open 30 days with no activity.

Jagadeeshftw commented 1 month ago

Hi @minimalsm, @isabelladebrito, I'm interested to work on this, can you assign this to me.

github-actions[bot] commented 3 weeks ago

This issue is stale because it has been open 30 days with no activity.

ethereum / ethereum-org-website

Documentation request: interacting with smart contracts #12195