Skip to main content

☝️ Quickstart

note

Running Slinky? First step is to join our Discord

Summary of Steps​

Estimated Time: 10 mins

In this walkthrough, we'll be going through the 5 steps to set up Slinky.

  1. Install the binary of a support chain application.
  2. Install the slinky binary.
  3. Configure your slinky sidecar process.
  4. Run the slinky sidecar.
  5. Start the chain application.

1. Install the Chain Binary ✅​

🚨 Please visit the chain's validator-specific instructions to install and configure the node binary for the desired chain.

For the purposes of this guide we'll use testappd as our example application binary, but it will be the same for any chain!

2. Install the slinky binary ✅​

You can install the slinky binary either by building from source or by downloading a pre-built binary.

  • Install the latest binary from the releases page
  • Build from source by cloning the repo and running make install
git clone git@github.com:skip-mev/slinky.git
cd slinky
make install

Slinky should now be in your path. Check to make sure with:

which slinky

3. Configure your Slinky Sidecar Process ✅​

The Slinky releases contain an additional binary, slinky-config which can be used to generate the proper config files for a given chain. It also contains pre-generated configs which have correct defaults for a corresponding chain and Slinky version.

  • The provided releases include various preconfigured config files. Both oracle.json, and market.json files can be used for configuring your sidecar process.
  • Alternatively, the repository contains the most up-to-date version of the config file here

Please see our chain config page for reference about a particular integration.

danger
Make sure your config matches your version and chain!

The config file in the Slinky repository is regenerated every time a change is made to the sidecar. As such, it may contain additional config options that are not yet supported by earlier versions of the sidecar. Please use the config file from the release if you are unsure.

Config files for the sidecar are generally chain-specific. Prefer to use the config file provided for the chain you're running.

4. Run the Slinky Sidecar ✅​

You can run the slinky sidecar by running the following command:

slinky --oracle-config-path oracle.json

You can verify whether prices are being retrieved by running the following command:

curl 'http://localhost:8080/slinky/oracle/v1/prices' | jq .

You should see output similar to the following:

{
  "prices": {
    "ATOM/USD": "920650000",
    "BITCOIN/USD": "3980283250000",
    "DYDX/USD": "273682500",
    "ETHEREUM/BITCOIN": "5842000",
    "ETHEREUM/USD": "232550500000",
    "POLKADOT/USD": "638800000",
    "SOLANA/USD": "8430350000"
  },
  "timestamp": "2024-01-23T01:15:09.776890Z"
}

5. Start the chain application ✅​

Starting the chain application should be no different than starting the application without the sidecar.

testappd start

Troubleshooting​

If you are having issues running the oracle sidecar, please see the Troubleshooting section for more information.