Gathering detailed insights and metrics for eth-sdk-wallet
Gathering detailed insights and metrics for eth-sdk-wallet
Installations
npm install eth-sdk-walletDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Releases
Unable to fetch releases
Languages
2
TypeScript
CSS
TypeScript (94.77%)
CSS (5.23%)
Developer
lolieatapple
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
Apache-2.0 License
2 Stars
220 Commits
2 Forks
1 Watchers
16 Branches
4 Contributors
Updated on Oct 26, 2023
Maintainers
1
Package Meta Information
Latest Version
0.1.8
Package Id
eth-sdk-wallet@0.1.8
Unpacked Size
348.55 kB
Size
71.58 kB
File Count
75
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
17
Peer Dependencies
5
Introduction
Nearly every dapp needs to connect to a crypto wallet.There are many options such as metamask, ledger. Hydro sdk wallet makes it easier to integrate different kinds of wallets together, and give an uniform interfaces to interative with them.
Hydro SDK wallet also support browser local wallets. Secrets are saved in browser localstorage under your domain.
There is a default ui in this package. You can also implement another ui as you wish.
Support wallets:
- Metamask
- Browser Local Wallet
- Wallet Connect Protocol
- Ledger Wallet
- Trust Wallet
- Coinbase Wallet
- Imtoken Wallet
- Wallet Link (Coinbase Wallet)
- D'CENT Wallet
- Fortmatic
- Trezor
Basic Usage Guide
This package requires React and Redux.
Step1: install npm package
npm i eth-sdk-wallet
Step2: Wallet Reducer
The store should know how to handle actions coming from the wallet components. To enable this, we need to pass the EthWalletReducer to your store.
1import { createStore, combineReducers } from "redux"; 2import { EthWalletReducer } from "eth-sdk-wallet"; 3 4const rootReducer = combineReducers({ 5 // ...your other reducers here 6 // you have to pass EthWalletReducer under 'EthWalletReducer' key 7 EthWalletReducer 8}); 9 10const store = createStore(rootReducer);
Step3: Wallet Component
To make the wallet logic work. We need to mount the Wallet and WalletButton components into your app. They should be mounted into Provider(see more details about Provider in react-redux). When the components is initialized, some monitors will start to work as well. They are monitoring the web3 wallet status(not installed, locking, account changed), ledger status(locked or not), and balances of all available addresses. You can config wallet through props. See more datials in the api section below.
1import React from "react"; 2import { Provider } from "react-redux"; 3import { Wallet, WalletButton } from "eth-sdk-wallet"; 4import { store } from "./store"; 5import "eth-sdk-wallet/index.css"; 6 7class App extends React.Component { 8 render() { 9 return ( 10 <Provider store={store}> 11 // ... your components 12 <Wallet nodeUrl="https://ropsten.infura.io" /> 13 <WalletButton /> 14 </Provider> 15 ); 16 } 17}
Step4: Use Account
We can get the current selected account by using selector functions.
1import React from "react"; 2import { connect } from "react-redux"; 3 4class App extends React.Component { 5 signMessage = async () => { 6 const { currentAccount } = this.props; 7 const signature = await currentAccount.wallet.signPersonalMessage("test message"); 8 console.log(signature); 9 }; 10 11 render() { 12 return ( 13 <div> 14 <button onClick={this.signMessage} /> 15 </div> 16 ); 17 } 18} 19export default connect(state => { 20 return { 21 currentAccount: getSelectedAccount(state) 22 }; 23})(App);
API
Wallet Component Props
| Name | Type | Default | Desc |
|---|---|---|---|
| nodeUrl | String | https://ropsten.infura.io | Ethereum JSON RPC Endpoint. |
| defaultWalletType | String | EXTENSION | default selected wallet type. Options are EXTENSION, Hydro_Wallet, WALLETCONNECT, Ledger. |
| translations | Translations | defaultTranslations | i18n translations. |
| walletTypes | Array | defaultWalletTypes | customized wallets. |
| menuOptions | Option[] | defaultMenuOptions | customized wallet menu. |
| loadWalletActions | Actions | {} | customized load wallet actions. |
| customLocalWallet | WalletClass | HydroWallet | customized local wallet class. |
| hideLocalWallet | Boolean | false | hide local wallet menu items. |
| unit | String | ETH | balance unit. |
| decimals | Number | 18 | balance decimals. |
| dcent | DcentClass | support D'CENT wallet, if provided, will show D'CENT option in dropdown menu. | |
| appName | String | WalletLink prop. | |
| appLogoUrl | String | WalletLink prop. | |
| fortmaticApiKey | String | Fortmatic option, if provided, will show Fortmatic option in dropdown menu. | |
| copyCallback | Function | alert("Copied to clipboard!") | copy address callback. |
| String | TrezorConnect manifest param | ||
| host | String | TrezorConnect manifest param |
Selectors
Methods to get data from redux store.
getAccount(state, accountID)Return the corresponding accountgetSelectedAccount(state)Return the selected accountgetAccounts(state)Return all available accounts
Action creators
These functions are redux action creators. You need to dispatch the result to store.
selectAccount(accountID, type)Change Selected AccountunlockBrowserWalletAccount(accountID, password)Unlock a browser local walletshowWalletModal()Show the wallets modalhideWalletModal()Hide the wallets modal
Account functions
When we get an account from redux store, we can call some functions of account.wallet object.
Send Transaction (eth_sendTransaction)
1/** 2 * Draft transaction 3 */ 4const tx = { 5 from: "0xbc28ea04101f03ea7a94c1379bc3ab32e65e62d3", 6 to: "0x0000000000000000000000000000000000000000", 7 nonce: 1, 8 gas: 100000, 9 value: "0x0", 10 data: "0x0" 11}; 12 13/** 14 * Send transaction 15 */ 16const txId = await wallet.sendTransaction(tx);
Sign Personal Message (personal_sign)
1/** 2 * Draft Message Parameters 3 */ 4const msgParams = [ 5 "HYDRO-AUTHENTICATION" //message 6]; 7 8/** 9 * Sign personal message 10 */ 11const signature = await wallet.signPersonalMessage(msgParams);
Send Custom Request
1/** 2 * Draft Custom Request 3 */ 4const customRequest = [ 5 "eth_getTransactionReceipt", //method 6 ["0x452817c981809fb7fab716dc84114b97c9ad2542c72fb9ed2c64d79e1bddb937"] //params 7]; 8 9/** 10 * Send Custom Request 11 */ 12const customResponse = await wallet.sendCustomRequest(customRequest);
Try the examples
There are some examples projects. You can find commands to start these examples in package.json and source code in examples dir.
License
This project is licensed under the Apache 2.0 License - see the LICENSE file for details
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
78 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-h452-7996-h45h
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-xwcq-pm8m-c4vf
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
- Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
- Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
- Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
- Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
- Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
- Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
- Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
- Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-584q-6j8j-r5pm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
- Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-27v7-qhfv-rqq8
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-3w3w-pxmm-2w2j
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Score
1.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More