Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Guides & Tutorials improvement #6676

Merged
merged 56 commits into from
Jan 7, 2024
Merged
Changes from 1 commit
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
827e8f8
restructure the folders and add category.yml to all of them for clear…
web3js-org Dec 23, 2023
6d8b2c9
created introduction file withshort packages explanation
web3js-org Dec 23, 2023
5a12855
finished quickstart guide with basic examples
web3js-org Dec 23, 2023
2723ded
finished introduction
web3js-org Dec 23, 2023
13e2bc5
delete features file (added this in introduction)
web3js-org Dec 23, 2023
7f1dbbd
fixed typo
web3js-org Dec 24, 2023
d493826
metamask (react and html) connection
web3js-org Dec 24, 2023
e3efa24
added emojis to the categories
web3js-org Dec 24, 2023
df7c5aa
separated the examples into different files
web3js-org Dec 24, 2023
b82c2da
removed transactions sections and put them into wallet sections
web3js-org Dec 28, 2023
d3fd65f
rewrote mastering wallet and accounts
web3js-org Dec 28, 2023
ea1190d
reorder and changed name of promievents
web3js-org Dec 28, 2023
bdaf7c4
rewrote local wallet tutorial
web3js-org Dec 28, 2023
07460a8
rewrote/reorganized signing tutorial
web3js-org Dec 28, 2023
d843760
added diagram of wallet and accounts for the index
web3js-org Dec 28, 2023
ff879d8
rewrote/reorganized transactions section
web3js-org Dec 28, 2023
e987cbb
added little warning to node_wallet and changed title
web3js-org Dec 28, 2023
6ef631d
restructure the examples into several tutorials
web3js-org Dec 28, 2023
74574e6
renamed file
web3js-org Dec 28, 2023
2431b06
removed CJS imports
web3js-org Dec 28, 2023
87db969
rename file and reorganized folder structure of infer guide
web3js-org Dec 28, 2023
bd75c28
removed CJS imports
web3js-org Dec 28, 2023
be739d6
renamed label
web3js-org Dec 28, 2023
c9de06d
created different file to show all the explained web3-eth methods
web3js-org Dec 28, 2023
7c1e889
fixed some typos
web3js-org Dec 28, 2023
729edc3
removed step 7 which is in another file
web3js-org Dec 28, 2023
0172bf0
removed folder and renamed the file
web3js-org Dec 28, 2023
41f3e5a
removed folder and renamed the file
web3js-org Dec 28, 2023
44afd14
fixed typos and reorganized structure of the file
web3js-org Dec 28, 2023
07674b9
fixed format of tree shaking guide
web3js-org Dec 28, 2023
8462b22
organized typos/structure but didn't change the code at all
web3js-org Dec 29, 2023
671bd49
added showcase section and rephrase the intro
web3js-org Dec 29, 2023
344b31d
reorganized the spaces in the code samples
web3js-org Dec 29, 2023
53bf9f9
reorganized spaces in the codesamples
web3js-org Dec 29, 2023
6eb8834
reorganized spaces in the codesamples
web3js-org Dec 29, 2023
5d1cf14
changed headings
web3js-org Dec 29, 2023
b2bc267
removed glossary in the sidebar and added it to guides and tutorials
web3js-org Dec 29, 2023
99ea8e4
Revert "removed glossary in the sidebar and added it to guides and tu…
web3js-org Jan 2, 2024
3c63118
fixed broken links
web3js-org Jan 2, 2024
5259eff
fixed broken links x2
web3js-org Jan 2, 2024
46b6958
shorten name to have it only in 1 line
web3js-org Jan 3, 2024
bbc89ab
add info about personal api is deprecated
web3js-org Jan 3, 2024
191ff37
renamed web3eth without dash to be consistent
web3js-org Jan 3, 2024
c933273
added parenthesis
web3js-org Jan 3, 2024
7309bb5
added link to web3js/plugins
web3js-org Jan 3, 2024
2801bd0
deleted glossary tab since it was added to the guides section
web3js-org Jan 4, 2024
3a85fa5
Revert "deleted glossary tab since it was added to the guides section"
web3js-org Jan 4, 2024
cb6c434
changed all double-quotes to single-quotes
web3js-org Jan 4, 2024
09d41f6
organized pre-requisites for each section
web3js-org Jan 7, 2024
7a6cde1
separated injected provider from truffle file
web3js-org Jan 7, 2024
f74cd34
changed title from truffle to third party provider
web3js-org Jan 7, 2024
53a62ed
replaced double quotes for single quotes
web3js-org Jan 7, 2024
73d2630
Update docs/docs/guides/wallet/signing.md
Jan 7, 2024
fcf45e9
Update docs/docs/guides/wallet/transactions.md
Jan 7, 2024
31e14a0
Merge branch 'guides_improvement' of github.com:web3/web3.js into gui…
web3js-org Jan 7, 2024
f06bbce
changed main header in for `Truffle`
web3js-org Jan 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
added showcase section and rephrase the intro
  • Loading branch information
web3js-org committed Dec 29, 2023
commit 671bd4955f626d731462804c7a59aacb2b223471
49 changes: 43 additions & 6 deletions docs/docs/guides/web3_plugin_guide/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,48 @@
---
sidebar_position: 6
sidebar_label: 'Plugins'
sidebar_position: 1
sidebar_label: 'Introduction'
---

# web3.js Plugins Guide
# Introduction

In addition to the web3.js standard libraries, plugins add specific functionality to the end user. This extra functionality could be wrappers around specific contracts, additional RPC method wrappers, or could even extend the logic of web3.js methods.
Welcome to the web3.js Plugins Guide, an exciting new feature introduced in web3.js v4! In addition to the core web3.js libraries, plugins bring specialized functionalities tailored for end-users (functionalities that you, as a developer, can create). These enhancements may involve creating wrappers for specific contracts, adding extra features to RPC methods, or extending the capabilities of web3.js methods. Dive in and explore this innovative addition to web3.js v4!

- [web3.js Plugin Developer Guide](/guides/web3_plugin_guide/plugin_authors)
- [Plugin User Guide](/guides/web3_plugin_guide/plugin_users)
- [Plugin Developer Guide (For Creators)](/guides/web3_plugin_guide/plugin_authors)
- [Plugin User Guide (Usage)](/guides/web3_plugin_guide/plugin_users)

## Plugin Showcase

### Chainlink Plugin
- [`npm i @chainsafe/web3-plugin-chainlink`](https://www.npmjs.com/package/@chainsafe/web3-plugin-chainlink)
- **Description**: A Web3.js 4.x Plugin for Interacting With Chainlink Smart Contracts
- **Author**: ChainSafe Systems

### Tokens Plugin
- [`npm i @chainsafe/web3-plugin-tokens`](https://www.npmjs.com/package/@chainsafe/web3-plugin-tokens)
- **Description**: Plugin to extend web3.js with additional methods to interact with common token interfaces (ERC20, ERC721, ERC1155...)
- **Author**: Peter Grassberger & ChainSafe

### Craftsman Plugin
- [`npm i web3-plugin-craftsman`](https://www.npmjs.com/package/web3-plugin-craftsman)
- **Description**: web3.js plugin allowing instantiation of contract objects directly from Solidity source code
- **Author**: Muhammad-Altabba

### Optimism Plugin
- [`npm i @eth-optimism/web3.js-plugin`](https://www.npmjs.com/package/@eth-optimism/web3.js-plugin)
- **Description**: Web3.js plugin for OP-Chain gas estimation
- **Author**: Unknown

### Near Protocol Plugin
- [`npm i @conx3/web3-plugin-near`](https://npmjs.com/package/@conx3/web3-plugin-near)
- **Description**: web3.js plugin for Near Protocol
- **Author**: Muhammad Altabba

### Aurora Engine Plugin
- [`npm i @conx3/web3-plugin-aurora`](https://www.npmjs.com/package/@conx3/web3-plugin-aurora)
- **Description**: web3.js plugin for Aurora Engine, an EVM running atop NEAR protocol
- **Author**: Muhammad Altabba

### Superfluid Plugin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, but when new plugin will be added we will need to maintain this manually along with PR by contributor in web3.js website. so could you find way of automating this list using https://github.com/web3/web3js-landing/blob/main/src/pluginList.ts

- [`npm i web3-plugin-superfluid`](https://www.npmjs.com/package/web3-plugin-superfluid)
- **Description**: Superfluid Web3.js Plugin
- **Author**: Salman Dabbakuti