- Smart contract documentation, originally intended for CodeArena: https://github.com/AmbireTech/code4rena
- Latest smart contract source code: https://github.com/AmbireTech/adex-protocol-eth/tree/codearena-fixes
- Security model: https://gist.github.com/Ivshti/fe86f13c3adff3404a1f5ce1e364304c
- Deck: https://docsend.com/view/hqp9xkr2krj6wt8w
- FAQs: https://help.ambire.com/hc/en-us/categories/4404980091538-Ambire-Wallet
- Front-end (this repo) development plan and estimation: https://docs.google.com/spreadsheets/d/1pqtRPcNRW98D97GL3nrdoipD3sWehz2k7zWclzYk-SM
- Original concept: https://github.com/AdExNetwork/aips/issues/69 (note that the feature scope is not up to date)
- UX decisions
NOTE: make sure that you use the wallet-v2 branch of the relayer.
NOTE 2: we test on Polygon, because it's cheap enough and it's a real environment with all the supported protocols - Sushiswap, Uniswap, Aave, and others. Ping #dev-wallet channel on Slack so we can send you some MATIC tokens.
First, clone and run the relayer
git clone https://github.com/AmbireTech/relayer.git -b wallet-v2
cd relayer
npm i
NODE_ENV=development npm start
Then run the Ambire Wallet:
npm i
npm start
In order to enable Relayerless mode (ability to function without being connected to the relayer), you need to set REACT_APP_RELAYER_URL env variable to null as follows:
REACT_APP_RELAYER_URL=Important: to make the Ledger integration work, you need to be accessing Ambire Wallet through HTTPS. The easiest way to do this in a development environment is to use localtunnel: for example, lt --port 3000
To see how to build plugins for Ambire, please read our plugin docs.
- No semicolons
- 2 spaces for identation
- Single quote (') instead of double (")
- Error handling: make sure to catch all errors that may originate in external IO (expected errors) and display them in a human friendly way with
addToast; also, at a top-level, every time you spawn an async operation, make sure you.catchthe entire thing to catch unexpected errors - Camel case
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
- Signer: the signer is an address used to sign transactions and messages. It's normally an EOA (externally owned address) such as a Trezor address, Ledger address, Metamask address, a double-keypair representing an email/passphrase authentication, or even another smart wallet address (eg Gnosis Safe). We use this term to distinct it from "account", which is the actual smart wallet account, which can have one or more signers.
- When adding an account with Trezor, Ledger or a web3 wallet, we create one automatically if it doesn't exist; if we control multiple, we add all those accounts and show a toast notification "this key controls N accounts"
- We also auto-add all accounts FORMERLY controlled by the connected signer
- When trying to sign a transaction/message with an added account, and the signer is not available, we show a toast notification explaining to the user they have to connect the relevant signer; unless it's a HW Wallet, in which case we can just prompt the user to connect it
- When an account is added with a signer, but that signer no longer controls it, we should warn the user: "You are currently not authorized to send transactions from <> on . Please re-add the account with a key that controls it."
- If someone goes through "add account"/"email login" but the given account is already added, we won't attempt to warn them early; the reason for this is 1) for simplicity and 2) cause re-adding an acc will change to the latest used signer (eg former quickacc, readding as trezor-controlled) 3) cause re-adding an account might reset it's state and fix tech issues in the future
{
id, // address (checksummed) of the account itself
signer, // object, either { address } or { quickAccManager, one, two, timelock }
salt, identityFactoryAddr, baseIdentityAddr, bytecode // all hex strings, account identity deploy data; all required
email, // optional: only in case of quick accounts
primaryKeyBackup, // optional, only in case of quick accounts, stringified JSON in a keystore format
}
This is used by the WalletConnect and Gnosis Safe Apps hooks for the queue of signing requests: those could be transactions, personal messages, etc.
{
id, // numeric unique ID of the request
type, // type of the signing request, currently set to the RPC method (eg eth_sendTransaction)
txn, // only set when it's eth_sendTransaction, contains to/data/value/gas
chainId, // chainId the request is for
account, // account address the request is for
}
resolveMany response:
{
success, // boolean
message, // string, optional, if success is false
result, // string or object, optional, if success is true, depending on the request; normally a string, eg eth_sendTransaction would be answered with a hex hash (0x...)
}
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
node scripts/generateContractInfo.js > src/consts/humanizerInfo.json
The contracts used by Ambire Wallet have been audited by:
- CertiK
- CodeArena
- G0 group: audited AdEx Network but the used Identity.sol was carried over to Ambire
Additionally, there's an ongoing Immunefi bug bounty.
- Factory: 0xBf07a0Df119Ca234634588fbDb5625594E2a5BCA
- Base identity: 0x2A2b85EB1054d6f0c6c2E37dA05eD3E5feA684EF
- QuickAccManager: 0xfF3f6D14DF43c112aB98834Ee1F82083E07c26BF
- Batcher: 0x460fad03099f67391d84c9cc0ea7aa2457969cea
- WALLET token: 0x88800092ff476844f74dc2fc427974bbee2794ae
- xWALLET staking: 0x47Cd7E91C3CBaAF266369fe8518345fc4FC12935
- SupplyController: 0xc53af25f831f31ad6256a742b3f0905bc214a430
Those contracts (except Ethereum-specific WALLET, xWALLET and SupplyController) are deployed cross-chain on the same addresses across Ethereum, Polygon, BSC, Fantom, Avalanche, Arbitrum, Moonbeam, Moonriver, Cronos, Metis, Gnosis Chain (formerly xDAI), NEAR Aurora
- Email/password accounts
- Ledger support
- Trezor support
- Can create an account with a Web3 wallet
- Multiple accounts
- Multiple networks: Ethereum, Polygon, Avalanche
- WalletConnect v1
- WalletConnect: multi-dApp support
- Transaction preview: transactions parsed to display meaning
- Transaction batching: add multiple transactions to automatically batch them
- Notifications for pending to sign, ability to click notifications to go directly to the tab
- Deposit page
- Deposit through on-ramps
- Transfer page: send tokens
- Dashboard: display all tokens you own with their $ values
- Dashboard: display all NFTs you own
- Plugin system: iframe-based plugins supported
- Swap: ability to swap tokens through an embedded Sushiswap plugin
- Earn: ability to easily deposit/withdraw to and from Aave
- Security: add/remove authorized signers
- Relayerless mode: ability to function without being connected to the relayer
- Fee payment in stablecoins: auto-detects what tokens you have left after your transaction batch
- Transactions: list all the transaction history
- OTP (Authenticator) support for extra security with email/pass accounts
- Ability to copy the address from the top left
- Ability to remove accounts
- Transaction cancellation and speed-up
- Fix: relayer: better gas estimations to avoid "out of gas", "execution reverted"
- Ability to sign messages
- Swap: approve tokens automatically, removing the need for a separate transaction batch
- Notifications for incoming funds
- Advanced transaction parsing: more types of transactions understood and displayed in human-friendly manner
- Welcome email & onboarding UX improvements
- Permissions (clipboard, notifications) are now requested through a modal
- Security: ability to add additional signers and remove signers
- Attention grabbing: pinned notification in the bottom right if you have requests pending to be signed
- Ability to deploy smart contracts
- Address book: ability to save and label addresses
- Ledger: WebHID support, fixing Ledger with Chrome
- Email verification is now enforced with a modal, because a valid email is required for account recovery
- Binance Smart Chain support added
- Ability to change your password
- Ability to export (backup) and import accounts to/from JSON files
- Styling improvements: responsiveness
- Ability to recover your account in case of losing one of the keys
- OTP (Google Authenticator) support in the Security page
- Notifications for confirmed (mined) transactions
- Cross-chain transfer and swap support
- Improved responsiveness, mobile-friendly UI (not intended as a replacement to the upcoming mobile app)
- Yearn integration: you can now deposit into Yearn vaults through the Earn page
- QR Code on Deposit page
- WALLET token distribution modal
- Link to the Help Center added
- Top right dropdown with helpful links
- Improved parsing of Uniswap V3 transactions following their updated router
- Ability to add custom tokens
- More frequent updating of balances
- Ability to ask for your confirmation email to be resent
- Warn when a WalletConnect connection may be offline
- Cross-chain transfers are now tracked
- Cross-chain: select box can now be easily searched
- Private mode (hide the numbers on the dashboard)
- Earn: add Tesseract, a yield aggregator on Polygon
- NFTs now show up on Polygon
- Ability to remove custom tokens
- Redesigned UI for sending transactions
- Warn users when there's extra transaction costs for deploying their wallet
- Private mode: hide addresses as well
- Fee improvements: ability to set a custom fee
- Fee improvements: ability to select a lower fee if you don't have sufficient funds for the higher settings
- Ability to replace the current transaction
- Ability to queue a new transaction when you have one pending
- $WALLET claiming: can now claim early investor tokens
- Bugfix: fixed parsing Aave repay transactions
- Support for Fantom
- $WALLET: Ability to stake (xWALLET)
- $WALLET: Ability to pay transaction fees in $WALLET
- Grid+ Lattice hardware wallet support
- $WALLET claiming: show APYs
- More token icons
- Improvements to $WALLET staking: better stats
- Ability to hide tokens in the dashboard
- Support UnstoppableDomains as a transaction address
- ADX staking card improvements
- Kriptomat as new on-ramp provider
- Added Hop.exchange LP tokens for wallet rewards
- Provided token prices for Moonbeam network
- Gas prices modal: you can now see the current gas price
- Fee selector: now shows all fee tokens, not only the ones you have
- UX improvement: top button for WALLET rewards now shows pending to be received, instead of claimable
- Critical WalletConnect fix
- Portfolio balances bugfixes
- Added Gnosis Chain
- Drag & Drop ordering for tokens addresses and networks
- Unstoppable Domains support in the Address book
- Error screen in case of an unexpected crash
- Fix bug when sending NFTs
- Can display balances on networks not supported by our providers
- Support NFT on Binance Smart Chain
- Added KCC (KuCoin) Chain
- Attach xWallet metadata in transactions (current APY, shared value, price in USD)
- Added warning notifycation on signing message form when wallet contract still not deployded
- Cached asset prices in memory
- Implement EIP 712
- Fix non clickable address area
- Fix bug when using UD in batch transactions
- Added Avalanche AAVE for wallets rewards
- Added new option for migration assets from Metamask
- Added Arbitrum chain
- Added Optimism Network
- Implement sign messages EIP 712 - https://www.npmjs.com/package/is-valid-signature
- Custom banner improvments
- New tokens added in custom tokens for "balance oracle"
- Fixed: Disable fee selector when proceed to sign step with external signer
- Fixed: the "Undefined" APY in Earn
- xWALLET Pending unbonds gas fees fix
- Change signer assets migration process
- Added Ledger signer assets migration
- Show discount banner only if eligible
- Support balance for custom NFTs for netwroks without thirdparty balance providers
- Added multiplier for CryptoTester NFT
- Added pagination for Collectibles page
- Changed Kriptomat limit to 5k per day
- Added new tokens BSC on for rewards
- Supported hidden networks
- Added Andromeda chain
- Improved humanizer with custom list of eligible tokens
- Added Trezor and Lattice signer assets migration
- Added Transak support for Moonbeam, Moonriver and Optimism chains
- Asset migration improvement to migration with Permit method
- Added chain verification of sign message
- Alphabetically sort of tokens in Transfer page
- Fixed: Support Pancakeswap through WalletConnect
- Improve replacment transaction interface
- Added ENS support
- Improvement sign message page and verification for deployed contract
- Disable deposit option for Tesseract earn
- Fixed: Allow to list more then 8 dapps in dapps connection bar
- Fixed: Notification errors on Chrome browser on Android mobile