Cede.store Provider API

Cede.store exposes its API via a JavaScript object in the web page. This object is called "the Provider". It partially follows the EIP-1193 (opens in a new tab) specification that most DeFi wallets use. This object is injected when the page loads and available as window.cede. More detailed information on how to use our provider is presented below on this page.

Why EIP-1193? Because it's the most popular standard for DeFi wallet interaction. As we work to simplify the integration with cede.store and maintain the same user experience (UX) as other DeFi wallets, we have chosen to follow this specification. However, we do not implement all of its methods, since we offer different features from traditional DeFi wallets. For example, we don't communicate with the blockchain, so we don't have any signing methods.

This API allows websites to request users' CEX accounts, read data from the CEX the user is connected to, read public data from CEX thanks to our infrastructure, and suggest HTTP requests for the user to sign and send those to CEX.

We recommend using our npm package @cedelabs/providers (opens in a new tab) to detect our provider. It provides a strongly typed interface of Provider API and automatic method versioning.

1. Basic usage
2. Read methods
3. Write methods
4. Custom methods

Provider API

Provider state

Cede Provider has 3 state variables:

• isConnected - true means that the provider can serve RPC requests. If false, the dApp page should be reloaded.
• isUnlocked - true means that the extension is unlocked and dApp can call any available method. If false, the dApp should first call "connect" method
• vaultPreviews - Vault Previews object containing vaults and CEX (check connection example)

API calls

To communicate with the extension, use:

provider.request( method: "method", params: { param1: "" })

If you do not use @cedelabs/providers (opens in a new tab) package, use:

window.cede.request( method: "method", params: { param1: "", version: 1 })

You'll find examples in the following pages.

Notifications

To handle notifications, you should subscribe to Cede Provider events like this:

provider.on("event type", () => console.log("your callback"));

Currently, Provider can emit the following event types:

"connect"

• when a communication channel is established between the dApp and cede.store (so we can call RPC methods)

"accountsChanged"

• when a dApp connects to cede.store (opens in a new tab) (user approved a new dApp connection or already known dApps has been connected)
• when there are vault modification (vault added/removed/changed)
• when a vault is connected/disconnected to a dApp

"unlock"

• when a dApp connects to cede.store (opens in a new tab) (user approved a new dApp connection or already known dApps has been connected)
• when a user unlocks the extension (though the popup)

"lock"

• when a user removes a dApps from connected dApps list
• when a user disonnects all the connected vaults
• when a user switches from a demo vault to real vault or vice versa: all connected dApps are removed
• when the extension locks due to the inactivity or because of the user (click on “lock” button)

"exchangesStatusesUpdate"

• when an exchange's server is back online
• when an exchange's server is offline

Errors

When making requests to cede.store extension, you can get the following list of errors. Note that the error codes are not following the JSON-RPC standard for now, but we are working on it.

You can retrieve the errors in the following way:

  import {CedeErrors} from "@cedelabs/providers";