diff --git a/.gitbook/assets/Group 2145.png b/.gitbook/assets/Group 2145.png new file mode 100644 index 0000000..95ca7b3 Binary files /dev/null and b/.gitbook/assets/Group 2145.png differ diff --git a/.gitbook/assets/Group 2149.png b/.gitbook/assets/Group 2149.png new file mode 100644 index 0000000..8764691 Binary files /dev/null and b/.gitbook/assets/Group 2149.png differ diff --git a/.gitbook/assets/Group 2150.png b/.gitbook/assets/Group 2150.png new file mode 100644 index 0000000..225aac8 Binary files /dev/null and b/.gitbook/assets/Group 2150.png differ diff --git a/.gitbook/assets/Group 27.png b/.gitbook/assets/Group 27.png new file mode 100644 index 0000000..3f5893b Binary files /dev/null and b/.gitbook/assets/Group 27.png differ diff --git a/.gitbook/assets/Group 28.png b/.gitbook/assets/Group 28.png new file mode 100644 index 0000000..2596f93 Binary files /dev/null and b/.gitbook/assets/Group 28.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.10.31 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.10.31 PM.png new file mode 100644 index 0000000..380c86f Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.10.31 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.21.06 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.21.06 PM.png new file mode 100644 index 0000000..e185d76 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.21.06 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.27.17 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.27.17 PM.png new file mode 100644 index 0000000..adf1443 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.27.17 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.30.08 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.30.08 PM.png new file mode 100644 index 0000000..d189165 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.30.08 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.38.24 PM (1).png b/.gitbook/assets/Screenshot 2023-05-30 at 8.38.24 PM (1).png new file mode 100644 index 0000000..725fb6a Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.38.24 PM (1).png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.38.24 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.38.24 PM.png new file mode 100644 index 0000000..725fb6a Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.38.24 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.47.04 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.47.04 PM.png new file mode 100644 index 0000000..b070c34 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.47.04 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.48.11 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.48.11 PM.png new file mode 100644 index 0000000..195515f Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.48.11 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.49.19 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.49.19 PM.png new file mode 100644 index 0000000..54dd289 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.49.19 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.53.59 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.53.59 PM.png new file mode 100644 index 0000000..866f1d9 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.53.59 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 8.57.42 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 8.57.42 PM.png new file mode 100644 index 0000000..a3a560c Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 8.57.42 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 9.05.49 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 9.05.49 PM.png new file mode 100644 index 0000000..e6523f9 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 9.05.49 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-30 at 9.07.24 PM.png b/.gitbook/assets/Screenshot 2023-05-30 at 9.07.24 PM.png new file mode 100644 index 0000000..d4f7dbf Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-30 at 9.07.24 PM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-31 at 10.33.32 AM.png b/.gitbook/assets/Screenshot 2023-05-31 at 10.33.32 AM.png new file mode 100644 index 0000000..efff6c4 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-31 at 10.33.32 AM.png differ diff --git a/.gitbook/assets/Screenshot 2023-05-31 at 10.36.35 AM.png b/.gitbook/assets/Screenshot 2023-05-31 at 10.36.35 AM.png new file mode 100644 index 0000000..a28a328 Binary files /dev/null and b/.gitbook/assets/Screenshot 2023-05-31 at 10.36.35 AM.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 87e735c..cdcbc7f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -252,6 +252,7 @@ * [API (JSON RPC)](flipside-api/get-started/rest-api.md) * [SDKs](flipside-api/sdks.md) * [Community Showcase](flipside-api/community-showcase.md) +* [ShroomDK Migration Guide](flipside-api/shroomdk-migration-guide.md) * [Have Questions?](flipside-api/have-questions.md) ## Contribute to Our Data diff --git a/flipside-api/shroomdk-migration-guide.md b/flipside-api/shroomdk-migration-guide.md new file mode 100644 index 0000000..6eecae6 --- /dev/null +++ b/flipside-api/shroomdk-migration-guide.md @@ -0,0 +1,60 @@ +# ShroomDK Migration Guide + +## Migration Guide: ShroomDK to API v2 + +As we continue to innovate, we're transitioning from our legacy API/SDK, ShroomDK, to our new and improved API v2. This upgraded API enables users to execute complex SQL queries on Flipside's Blockchain Data Sets and provides enhanced scalability and performance. + +For additional details and guidance, visit our [API Documentation](https://docs.flipsidecrypto.com/flipside-api/getting-started). + +If you need to generate new API keys or want to monitor your usage, visit your [account page](https://flipsidecrypto.xyz/account/api-keys). + +### **Migrating to API v2: Key Steps** + +Here are the key steps for migrating to API v2: + +1. [Updating SDKs ](shroomdk-migration-guide.md#1.-updating-sdks) +2. [Modifying API Endpoint URLs ](shroomdk-migration-guide.md#2.-modifying-api-endpoint-urls) +3. [Handling Changes in JSON Responses](shroomdk-migration-guide.md#3.-handling-changes-in-json-responses) + +#### 1. Updating SDKs + +For Python or JavaScript SDK users, please update to the latest versions: + +{% tabs %} +{% tab title="Python" %} +``` +pip install flipside +``` + +Then, create a new Flipside instance with your API key and the new API endpoint: + +```python +flipside = Flipside("", "https://api-v2.flipsidecrypto.xyz") +``` +{% endtab %} + +{% tab title="JavaScript" %} +``` +npm install @flipsidecrypto/sdk +``` + +Subsequently, instantiate a new Flipside object using your API key and the new API endpoint: + +```javascript +const flipside = new Flipside("", "https://api-v2.flipsidecrypto.xyz"); +``` +{% endtab %} +{% endtabs %} + +The updated SDKs will automatically target the new API v2 endpoints. + +#### 2. Modifying API Endpoint URLs + +If you're directly accessing the API, replace all ShroomDK API URLs in your codebase with the new v2 API URL: `https://api-v2.flipsidecrypto.xyz`. + +#### 3. Handling Changes in JSON Responses + +API v2 introduces changes to JSON responses. Adjust your response handling code to match these new specifications. Detailed information on the new JSON responses is available on our [API documentation page](https://api-docs.flipsidecrypto.xyz/). + +After making these changes, be sure to thoroughly test your applications to confirm smooth functionality with API v2. For any issues encountered during the migration, please reach out to our support team.\ +\ diff --git a/our-app/getting-around-the-app/README.md b/our-app/getting-around-the-app/README.md index e8aa098..f669e7c 100644 --- a/our-app/getting-around-the-app/README.md +++ b/our-app/getting-around-the-app/README.md @@ -1,18 +1,20 @@ --- -description: Our data app is the easiest place to get started working with blockchain data. +description: >- + Our data Studio is the easiest place to get started working with blockchain + data. --- # Getting Around the App -With a little bit of SQL knowledge, the Flipside data app makes it incredibly easy to access the best blockchain data in the world. To get started, we recommend stepping through our [walkthrough](../getting-started.md) — it's designed to get you up to speed on the basics of the app as quickly as possible. +With a little bit of SQL knowledge, the Flipside Studio makes it incredibly easy to access the best blockchain data in the world. To get started, we recommend stepping through our [walkthrough](../getting-started.md) — it's designed to get you up to speed on the basics of the app as quickly as possible. The app has a few basic components, here's how they fit together: * [**Discover**](discover.md) — the homepage of the app, and the best way to keep your finger on the pulse of what's happening in crypto data. Here you can see what dashboards are trending for different chains and projects, fav ones you like, keyword search for specific topics, and see which analysts are consistently topping the charts. -* [**My Work**](my-work.md) — where the work lives: get here by clicking on the folder icon in the main nav. Keyword search to open any work you've done in the past. Group files by creating collections and nesting collections. Organize by using features like multi-select and drag & drop. -* [**Query Editor**](query-editor.md) — where the work happens: get here by creating a query, or opening one you've started before. Run SQL queries, get results, visualize them, and publish them on a dashboard, all from one place in the app. Seamlessly switch between any of your queries and dashboards with our tabs system, and use the Data Explorer to preview data tables, and add table names directly to your queries. +* [**My Work**](my-work.md) — where the work lives: get here by clicking on the folder icon in the side nav. Keyword search to open any work you've done in the past. Group files by creating collections and nesting collections. Organize by using features like multi-select and drag & drop. +* [**Query Editor**](query-editor.md) — where the work happens: get here by navigating to the Studio in the top nav. Run SQL queries, get results, visualize them, and publish them on a dashboard, all from one place in the app. Seamlessly switch between any of your queries and dashboards with our tabs system, and use the Data Explorer to preview data tables, and add table names directly to your queries. * [**Dashboard Editor**](dashboard-editor.md) — where you share your findings with the world: add charts, results tables, text and images to your dashboards, send them to your friends with our copy link feature, or tweet the link directly from the dashboard. Organize your findings with dashboard tabs, and let people customize or update your dashboard with parameters. -* [**Profiles**](profiles.md) — your profile is the place where people can find all your best work, search and filter it, and see how to get get in touch with you if that's something you want! Update your avatar and background image, and add social contact details for Twitter, Telegram and Discord. +* [**Profiles**](profiles.md) — your profile is the place where people can find all your best work, search and filter it, and see how to get get in touch with you if that's something you want! Update your avatar and background image, and add social contact details for Twitter, Telegram, and Discord. We're adding more documentation for the app over time — if you have questions or suggestions for things to add, please let us know in [Discord](https://discord.gg/ZmU3jQuu6W). diff --git a/our-app/getting-around-the-app/dashboard-editor.md b/our-app/getting-around-the-app/dashboard-editor.md index 11ff5f2..4ac5b4f 100644 --- a/our-app/getting-around-the-app/dashboard-editor.md +++ b/our-app/getting-around-the-app/dashboard-editor.md @@ -12,8 +12,6 @@ This section will cover: * [How to add content to a dashboard?](dashboard-editor.md#building-a-dashboard) * [How to publish a dashboard?](dashboard-editor.md#publishing-a-dashboard) - - ### Overview of Dashboard Components Before we go over how to populate a dashboard, we'll go over the different components of a dashboard. @@ -71,12 +69,3 @@ Once you complete a dashboard, publish it to make it publicly accessible! You ca Don't worry: if you made a mistake in your dashboard, you can easily make changes, then click the the Update button >> Publish Updates to make those changes live.\ \ You can also Unpublish here, which will make your dashboard disappear — people visiting the link will see a 404 error until you publish it again. - - - -\ - - - - -\ diff --git a/our-app/getting-around-the-app/discover.md b/our-app/getting-around-the-app/discover.md index 23ab9ad..fa21306 100644 --- a/our-app/getting-around-the-app/discover.md +++ b/our-app/getting-around-the-app/discover.md @@ -36,7 +36,7 @@ That's a bit of 🧪 a l c h e m y ✨ that will stay a secret. But we can tell There are 100K+ dashboards on Flipside 🤯 Here's how to find the ones you're interested in! -

Ways to browse dashboards on Flipside.

+

Ways to browse dashboards on Flipside.

* **Search for a topic:** if you have a topic in mind (like: "impermanent loss osmosis"), type it into the search bar to see all the relevant dashboards. * **Find an analyst:** if you have someone in mind, you can search for them from the ["Analyst View"](discover.md#analyst-view) @@ -50,11 +50,11 @@ To search for an analyst, all you have to do is turn the toggle in the hero sect From [this view](https://flipsidecrypto.xyz/analysts), you can type an analyst's name into the search bar to find their profile, or explore different analyst profiles by going down the page. -
+
Once you find the analyst you're looking for, you can click on their profile to find their top dashboards, and potentially a few ways to get in touch with them. This is a great way to connect with other analysts in the space so make sure you build out your own [profile](profiles.md) too! -
+
diff --git a/our-app/getting-around-the-app/my-work.md b/our-app/getting-around-the-app/my-work.md index 5cb65bf..e2ca134 100644 --- a/our-app/getting-around-the-app/my-work.md +++ b/our-app/getting-around-the-app/my-work.md @@ -20,7 +20,7 @@ The list of files under "My Work" can grow very quickly as you create test queri -
+
@@ -28,10 +28,9 @@ The list of files under "My Work" can grow very quickly as you create test queri As the list of files grows in my work, here are some tips and tricks to help you stay organized. We will go over the images below from left to right. -
+
1. **File Types:** To start, there are 3 types of objects that you can create under my work: _collections_, _queries_, and _dashboards_. 2. **Collections:** To organize files by topic, you can create collections! To do that, click the "+" button and give your collection a name. Collections will always live on the top of "My Work". 3. **Drag and Drop:** To move a file you have created, simply drag and drop that file to the desired location in the files tree. 4. **Multi-Select:** To move multiple files at once, ctrl+shift (cmd+shift on mac) and click to select the files you want to move, then drag and drop them to the desired location in the file tree. - diff --git a/our-app/getting-around-the-app/profiles.md b/our-app/getting-around-the-app/profiles.md index b45956e..fbeeba2 100644 --- a/our-app/getting-around-the-app/profiles.md +++ b/our-app/getting-around-the-app/profiles.md @@ -10,13 +10,11 @@ This section will cover: * [How to update my profile?](profiles.md#building-your-profile) - - ### Building a Profile From this example profile page, we can see the analyst's social accounts as well as all of their published dashboard. -
+
If you'd like to connect with other analysts and crypto enthusiasts in the space, we encourage you to build out your profile page too. To edit your profile, click on your avatar image in the bottom left corner of the screen and select "Edit Profile". diff --git a/our-app/getting-around-the-app/query-editor.md b/our-app/getting-around-the-app/query-editor.md index fa67ef4..13edba9 100644 --- a/our-app/getting-around-the-app/query-editor.md +++ b/our-app/getting-around-the-app/query-editor.md @@ -13,13 +13,11 @@ This section will cover: * [How to get started with the results panel? ](query-editor.md#the-results-panel) * [How to get started with the charts panel?](query-editor.md#the-charts-panel) - - ### Overview of the Editor The editor is composed of three main panels - query, results, and charts. To the left of these panels, you have access to My Work or the Data Explorer. To the top, you can see all the queries and dashboards you've opened in tabs. -

Work interface.

+

Work interface.

**Configure your Interface.** diff --git a/our-app/getting-started.md b/our-app/getting-started.md index 7446cba..909bd63 100644 --- a/our-app/getting-started.md +++ b/our-app/getting-started.md @@ -1,5 +1,5 @@ --- -description: How to get started querying data with the Flipside data app. +description: How to get started querying data with the Flipside Studio. --- # Getting Started @@ -8,25 +8,25 @@ description: How to get started querying data with the Flipside data app. To get started, create an account on our app — you can sign up using an email address, ETH address, or your discord account. -

The account sign-up link is in the bottom left-hand corner of the page.

+

The account sign-up link is in the bottom left-hand corner of the page.

+ -### ### Step 2: **Create a new query.** -You can create a new query by clicking the big blue "+ Create New" button in the main navigation panel, then selecting "Query." +Navigate to the "**Studio"** from the top nav, then you can create a new query by clicking the big blue "+" button in the side bar, then selecting "Query". -

Easiest way to create a new query is to click the big blue button.

+

Easiest way to create a new query is to click the big blue button.

You can also create new queries in a few other ways: * from My Work, with the + button. -* if you have the Editor open, from the query tab bar with the + button there. +* from the query tab bar with the + button there. * by entering [flipside.new](https://flipside.new) into your browser's URL bar. -Doing this will drop you into the Editor part of the app, with your new query open: +Doing this will drop you into the Studio, with your new query open: -

Brand new query, ready for SQL.

+

Brand new query, ready for SQL.

A few things to note here: @@ -43,11 +43,16 @@ From the side menu, navigate to the Data Explorer to see all the databases, sche Pro tips for data exploration: * **Column details:** click on the table name to see a list of it's columns, and a data type for each. +* **Table details:** hover over a table name to see the table description and access direct link to documentation. * **Table preview**: see sample data without writing any SQL by clicking the Preview icon. * **Add to query**: enter any table name into your SQL with a single mouse click. * **View docs:** hover over a database name and click the "book" icon to go direct to docs. -

The data explorer is the easiest way to find tables, check out their contents, and add them to your query.

+
+ +

The data explorer is the easiest way to find tables, check out their contents, and add them to your query.

+ +
@@ -75,7 +80,7 @@ To run your query, you can hit the big blue "play" button in the top right-hand After a few moments, you should see your results appear in the Results Panel — you've got data! -

Your screen should look something like this at this point.

+

Your screen should look something like this at this point.

### @@ -89,7 +94,7 @@ Let's take a look at what the table above is telling us! Click **"Add Chart"** o Your screen should look something like this: -

You've got a chart!

+

You've got a chart!

### @@ -121,7 +126,7 @@ Make any other changes you see fit: Once you're happy with your dashboard, hit the publish button on the top right corner — after a short delay, you should see a confirmation like this: -

Your dashboard publish confirmation shows you a preview of how your dashboard will appear when shared on the web.

+

Your dashboard publish confirmation shows you a preview of how your dashboard will appear when shared on the web.

### @@ -129,7 +134,7 @@ Once you're happy with your dashboard, hit the publish button on the top right c Now that your dashboard is published, you can find it in Discover: -

Click that Discover link!

+

Click that Discover link!

There are a few ways to find your dashboard in discover, here's the easiest one: @@ -147,4 +152,3 @@ Congrats — you've published! * **Edit your profile** — add contact information, customize your avatar and background image. * **Get inspired** — go back to Discover and scope out the trending work: filter by a project you're interested in, and see what the best analysts in crypto are making on Flipside. Oh, and if you see something you like, be sure to hit that ❤️ button — "likes" impact the rankings and you'll help more people see good work by voting for things you enjoy. * **Check out bounties** — there are a few [Flipside bounties](http://localhost:5000/s/q3ZsciVeKRUUcuezp6ax/rpc/data-types/sqlstatement) left, but the new stuff is mostly at [MetricsDAO](https://metricsdao.xyz/) — check it out, accept a challenge, submit your work, and get paid! -