Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API3 under Oracles section #599

Merged
merged 22 commits into from
Apr 27, 2023

Conversation

vanshwassan
Copy link
Contributor

@vanshwassan vanshwassan commented Mar 23, 2023

Description

Added API3 under the Oracles section.
Basic developer documentation to access API3's first-party oracles and data feeds on Moonbeam.

Checklist

  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@vanshwassan vanshwassan changed the title Api3 update Add API3 under Oracles section Mar 23, 2023
@vanshwassan vanshwassan marked this pull request as draft March 23, 2023 22:56
@eshaben
Copy link
Contributor

eshaben commented Mar 24, 2023

@vanshwassan thank you for creating this PR! looking forward to reviewing it when it is ready 👀

@vanshwassan vanshwassan marked this pull request as ready for review April 18, 2023 05:40
@vanshwassan
Copy link
Contributor Author

vanshwassan commented Apr 18, 2023

Hey @eshaben, ready for review 👍🏻

Fixed broken links
@eshaben eshaben self-requested a review April 19, 2023 05:57
@eshaben
Copy link
Contributor

eshaben commented Apr 19, 2023

Awesome! I'll take a look 👀 . Thanks!

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vanshwassan looks good! 🙂 I just had a couple questions. But once answered, I'll merge this into a local branch and make some changes in formatting for consistency with the rest of our docs. Once we're done on the local branch we'll merge it into master and publish it 🚀

Comment on lines +143 to +153
<!-- ### Types of dAPIs

#### Self-funded dAPIs
Self-funded dAPIs offer developers the opportunity to experience data feeds with
minimal up-front commitment, providing a low-risk option prior to using a
managed dAPIs.

#### Managed dAPIs
Managed dAPIs are sourced from multiple first-party oracles and aggregated using
a median function. Compared to self-funded dAPIs, **managed dAPIs are monetized**,
as API3 requires payment in USDC on Ethereum Mainnet to operate them. -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vanshwassan just wanted to double check on this section, should it be commented out?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this can be commented out 👍🏻

Smart contracts can interact and read values from contracts that are already deployed on the blockchain. By deploying a proxy contract via the API3 Market, a dApp can interact and read values from a dAPI like ETH/USD.

!!! note
If a proxy is already deployed for a self-funded dAPI, the dApp can read the dAPI without having to deploy a proxy contract. They do this by using the address of the already deployed proxy contract which will be visible on the API3 Market.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where exactly would the address of the already deployed proxy be?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a proxy is already deployed, the user just needs to make sure the dAPI is funded and can start using it. It would show on the dAPI page when the user clicks on the Get Proxy button.
image

@eshaben eshaben changed the base branch from master to eshaben/api3 April 27, 2023 19:37
@eshaben eshaben merged commit 65ca72b into moonbeam-foundation:eshaben/api3 Apr 27, 2023
1 check passed
@eshaben eshaben mentioned this pull request Apr 29, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants