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

add web3-eth-account guide #6617

Merged
merged 9 commits into from
Dec 11, 2023
Merged

add web3-eth-account guide #6617

merged 9 commits into from
Dec 11, 2023

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Nov 22, 2023

Description

#6258
doc includes:

  • Executable examples
  • Local wallet
  • Signing
    replaced some privatekeys in docs to a place header

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage and my test cases cover all the lines and branches of the added code.
  • I ran npm run build and tested dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

Copy link

github-actions bot commented Nov 22, 2023

Bundle Stats

Hey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Asset Old size New size Diff Diff %
Total 0 590 KB 590 KB -
View detailed bundle breakdown

Added

Asset Old size New size Diff Diff %
web3.min.js 0 572 KB 572 KB -
../lib/commonjs/index.d.ts 0 8.63 KB 8.63 KB -
../lib/commonjs/accounts.d.ts 0 3.89 KB 3.89 KB -
../lib/commonjs/types.d.ts 0 2.45 KB 2.45 KB -
../lib/commonjs/web3.d.ts 0 1.14 KB 1.14 KB -
../lib/commonjs/abi.d.ts 0 1000 bytes 1000 bytes -
../lib/commonjs/eth.exports.d.ts 0 280 bytes 280 bytes -
../lib/commonjs/providers.exports.d.ts 0 148 bytes 148 bytes -
../lib/commonjs/version.d.ts 0 60 bytes 60 bytes -

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

No assets were unchanged

Copy link

cloudflare-workers-and-pages bot commented Nov 22, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 08dadd9
Status: ✅  Deploy successful!
Preview URL: https://26111028.web3-js-docs.pages.dev
Branch Preview URL: https://6258.web3-js-docs.pages.dev

View logs

@luu-alex luu-alex changed the title add local wallet guide add web3-eth-account guide Nov 22, 2023
Copy link

codecov bot commented Nov 23, 2023

Codecov Report

Merging #6617 (08dadd9) into 4.x (20cc5da) will increase coverage by 1.03%.
Report is 10 commits behind head on 4.x.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##              4.x    #6617      +/-   ##
==========================================
+ Coverage   89.36%   90.39%   +1.03%     
==========================================
  Files         215      215              
  Lines        8309     8322      +13     
  Branches     2248     2247       -1     
==========================================
+ Hits         7425     7523      +98     
+ Misses        884      799      -85     
Flag Coverage Δ
UnitTests 90.39% <ø> (+1.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
web3 ∅ <ø> (∅)
web3-core ∅ <ø> (∅)
web3-errors ∅ <ø> (∅)
web3-eth ∅ <ø> (∅)
web3-eth-abi ∅ <ø> (∅)
web3-eth-accounts ∅ <ø> (∅)
web3-eth-contract ∅ <ø> (∅)
web3-eth-ens ∅ <ø> (∅)
web3-eth-iban ∅ <ø> (∅)
web3-eth-personal ∅ <ø> (∅)
web3-net ∅ <ø> (∅)
web3-providers-http ∅ <ø> (∅)
web3-providers-ipc ∅ <ø> (∅)
web3-providers-ws ∅ <ø> (∅)
web3-rpc-methods ∅ <ø> (∅)
web3-utils ∅ <ø> (∅)
web3-validator ∅ <ø> (∅)

}

```
### import a private key and sign a transaction with the web3 package
Copy link
Contributor

Choose a reason for hiding this comment

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

also add example of contract using local web3 wallet for implicitly signing a tx for .send()
@luu-alex

Copy link
Contributor

@Muhammad-Altabba Muhammad-Altabba left a comment

Choose a reason for hiding this comment

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

I have few requests, please.

docs/docs/guides/basics/sign_and_send_tx/local_wallet.md Outdated Show resolved Hide resolved
docs/docs/guides/wallet/index.md Outdated Show resolved Hide resolved
@jdevcs
Copy link
Contributor

jdevcs commented Dec 11, 2023

approving, you may merge PR after addressing feedback, thanks

@luu-alex luu-alex merged commit 43b11b8 into 4.x Dec 11, 2023
60 of 65 checks passed
@luu-alex luu-alex deleted the 6258 branch December 11, 2023 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants