@web3-onboard/cede-store
TypeScript icon, indicating that this package has built-in type declarations

2.3.1 • Public • Published

@web3-onboard/cede-store

CEX module for connecting cede.store through web3-onboard. Check out the cede.store Wallet Developer Docs for more information.

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

npm i @web3-onboard/cede-store

Usage

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. Mobile and Ledger storage are coming soon. We can compare Vaults with the Keyring concept 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 streamed in real time through 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)

// 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
  }
})

Package Sidebar

Install

npm i @web3-onboard/cede-store

Weekly Downloads

168

Version

2.3.1

License

MIT

Unpacked Size

13 kB

Total Files

8

Last publish

Collaborators

  • aaronbarnard1
  • cmeisl