-
Notifications
You must be signed in to change notification settings - Fork 530
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
555 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
187 changes: 144 additions & 43 deletions
187
.../lib/components/svg/networks-group.svelte → ...c/lib/components/svg/networks-graphic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # cede.store | ||
|
|
||
| ## Wallet module for connecting cede.store Wallet SDK to web3-onboard | ||
|
|
||
| cede.store is a non-custodial browser extension designed to store CEX (centralized exchange) API keys and to sign CEX requests from the client-side. It allows users to manage their cryptos in their CEX through a unified interface. | ||
|
|
||
| Any dApp can integrate cede.store in order to track and/or manage a user's CEX assets. In this way, we offer the dApp a way to monitor and manage a user's CEX assets while remaining non-custodial and maintaining the same user experience as any DeFi browser wallet. | ||
|
|
||
| See [cede.store Wallet Developer Docs](https://docs.cede.store) | ||
|
|
||
| :::admonition type=warning | ||
| As cede.store is not a traditional 1193 wallet behavior is a little different from other wallets that connect through web3-onboard in that there is no on-chain user address to interact with and there isn't a specific chain associated. With this behavior dapp devs will need to handle accordingly and differently from traditional 1193 wallets. The dapp dev can expect the connect account to not be shown as a hex value (or at all) and the chain to always be `0x0` when a user connects with cede.store for that specific wallet account. | ||
| ::: | ||
|
|
||
| ### Install | ||
|
|
||
| <Tabs values={['yarn', 'npm']}> | ||
| <TabPanel value="yarn"> | ||
|
|
||
| ```sh copy | ||
| yarn add @web3-onboard/cede-store | ||
| ``` | ||
|
|
||
| </TabPanel> | ||
| <TabPanel value="npm"> | ||
|
|
||
| ```sh copy | ||
| npm install @web3-onboard/cede-store | ||
| ``` | ||
|
|
||
| </TabPanel> | ||
| </Tabs> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```typescript | ||
| import Onboard from '@web3-onboard/core' | ||
| import cedeStoreWalletModule from '@web3-onboard/cede-store' | ||
|
|
||
| const cedeStoreWallet = cedeStoreWalletModule() | ||
|
|
||
| const onboard = Onboard({ | ||
| // ... other Onboard options | ||
| wallets: [ | ||
| cedeStoreWallet | ||
| //... other wallets | ||
| ] | ||
| }) | ||
|
|
||
| const connectedWallets = await onboard.connectWallet() | ||
| console.log(connectedWallets) | ||
| ``` | ||
|
|
||
| ## Vault management | ||
|
|
||
| Vaults allow creating bundles of CEX accounts. The extension connects with CEX through CEX API keys and everything is stored in the Local Storage of the browser, on a mobile or on a Ledger (more coming soon...). We can compare Vaults with the [Keyring concept](https://www.wispwisp.com/index.php/2020/12/25/how-metamask-stores-your-wallet-secret/) of Metamask. | ||
|
|
||
| A user can have multiple vaults with different CEX accounts inside. | ||
| This system allows the user to give a dApp custom access to his accounts depending on the degree of trust he has in the dApp in question. | ||
|
|
||
| Let's say the user has three vaults: a main one with full access (track, trade, withdraw) to all his CEX, one just for tracking and one just for trading. | ||
| If the user does not know the reputation of the dApp he is using, the most logical solution would be to give access | ||
| only to the tracking vault so the dApp will not be able to initiate trade requests. | ||
|
|
||
| ## CEX connection | ||
|
|
||
| All requests are divided into two categories: | ||
|
|
||
| - private requests | ||
| - public requests | ||
|
|
||
| All public data, such as prices, volumes, historical data are collected from different exchanges and provided with our API. | ||
|
|
||
| All private requests, such as user balances, trades, open positions are coming from cede.store (from the user's machine). | ||
|
|
||
| You can access both public and private data through the extension's API. cede.store handles all exchanges requests, as well as API keys secure storage. | ||
|
|
||
| ## Example of a workflow (fetch user's balances and transactions) | ||
|
|
||
| ```typescript | ||
| // get available vaults and accounts | ||
| const { vaultPreview } = provider.getVaultPreviews() | ||
| console.log(vaultPreview) | ||
|
|
||
| // Fetch user's balances from Binance and Coinbase | ||
| const vaultId = vaultPreview[0].id | ||
| await provider.request({ | ||
| method: 'balances', | ||
| params: { | ||
| vaultId, | ||
| accountNames: ['Binance 1', 'Coinbase 1'] | ||
| } | ||
| }) | ||
|
|
||
| // Fetch user's transactions | ||
| await provider.request({ | ||
| method: 'transactions', | ||
| params: { | ||
| vaultId | ||
| } | ||
| }) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # @web3-onboard/cede-store | ||
|
|
||
| ## Wallet module for connecting cede.store Wallet SDK to web3-onboard | ||
|
|
||
| cede.store is a non-custodial browser extension designed to store CEX (centralized exchange) API keys and to sign CEX requests from the client-side. It allows users to manage their cryptos in their CEX through a unified interface. | ||
|
|
||
| Any dApp can integrate cede.store in order to track and/or manage a user's CEX assets. In this way, we offer the dApp a way to monitor and manage a user's CEX assets while remaining non-custodial and maintaining the same user experience as any DeFi browser wallet. | ||
|
|
||
| As cede.store is not a traditional 1193 wallet behavior is a little different from other wallets that connect through web3-onboard in that there is no on-chain user address to interact with and there isn't a specific chain associated. With this behavior dapp devs will need to handle accordingly and differently from traditional 1193 wallets. The dapp dev can expect the connect account to not be shown as a hex value (or at all) and the chain to always be `0x0` when a user connects with cede.store for that specific wallet account. | ||
|
|
||
| See [cede.store Wallet Developer Docs](https://docs.cede.store) | ||
|
|
||
| ### Install | ||
|
|
||
| `npm i @web3-onboard/cede-store` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```typescript | ||
| import Onboard from '@web3-onboard/core' | ||
| import cedeStoreWalletModule from '@web3-onboard/cede-store' | ||
|
|
||
| const cedeStoreWallet = cedeStoreWalletModule() | ||
|
|
||
| const onboard = Onboard({ | ||
| // ... other Onboard options | ||
| wallets: [ | ||
| cedeStoreWallet | ||
| //... other wallets | ||
| ] | ||
| }) | ||
|
|
||
| const connectedWallets = await onboard.connectWallet() | ||
| console.log(connectedWallets) | ||
| ``` | ||
|
|
||
| ## Vault management | ||
|
|
||
| Vaults allow creating bundles of CEX accounts. The extension connects with CEX through CEX API keys and everything is stored in the Local Storage of the browser, on a mobile or on a Ledger (more coming soon...). We can compare Vaults with the [Keyring concept](https://www.wispwisp.com/index.php/2020/12/25/how-metamask-stores-your-wallet-secret/) of Metamask. | ||
|
|
||
| A user can have multiple vaults with different CEX accounts inside. | ||
| This system allows the user to give a dApp custom access to his accounts depending on the degree of trust he has in the dApp in question. | ||
|
|
||
| Let's say the user has three vaults: a main one with full access (track, trade, withdraw) to all his CEX, one just for tracking and one just for trading. | ||
| If the user does not know the reputation of the dApp he is using, the most logical solution would be to give access | ||
| only to the tracking vault so the dApp will not be able to initiate trade requests. | ||
|
|
||
| ## CEX connection | ||
|
|
||
| All requests are divided into two categories: | ||
|
|
||
| - private requests | ||
| - public requests | ||
|
|
||
| All public data, such as prices, volumes, historical data are collected from different exchanges and | ||
| provided with our API. | ||
|
|
||
| All private requests, such as user balances, trades, open positions are coming from cede.store (from the user's machine). | ||
|
|
||
| You can access both public and private data through the extension's API. cede.store handles all exchanges requests, as well as API keys secure storage. | ||
|
|
||
| ## Example of a workflow (fetch user's balances and transactions) | ||
|
|
||
| ```typescript | ||
| // get available vaults and accounts | ||
| const { vaultPreview } = provider.getVaultPreviews() | ||
| console.log(vaultPreview) | ||
|
|
||
| // Fetch user's balances from Binance and Coinbase | ||
| const vaultId = vaultPreview[0].id | ||
| await provider.request({ | ||
| method: 'balances', | ||
| params: { | ||
| vaultId, | ||
| accountNames: ['Binance 1', 'Coinbase 1'] | ||
| } | ||
| }) | ||
|
|
||
| // Fetch user's transactions | ||
| await provider.request({ | ||
| method: 'transactions', | ||
| params: { | ||
| vaultId | ||
| } | ||
| }) | ||
| ``` |
Oops, something went wrong.
d7d89f8There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
web3-onboard-docs – ./
web3-onboard-docs-blocknative.vercel.app
web3-onboard-docs-git-docs-blocknative.vercel.app
web3-onboard-beta.vercel.app