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

Update Oracles Documentation Page #4477

Closed
andrejrakic opened this issue Nov 16, 2021 · 7 comments
Closed

Update Oracles Documentation Page #4477

andrejrakic opened this issue Nov 16, 2021 · 7 comments
Assignees
Labels
content 🖋️ This involves copy additions or edits documentation 📖 Change or add documentation

Comments

@andrejrakic
Copy link
Contributor

In the Oracle Section of the Documentation Page there is no explanation nor example of using Chainlink Keepers. I would like to open a PR and work on this issue.

Product name:
Chainlink Keepers

Product description:
Smart contracts alone can't trigger or initiate their own functions at arbitrary times or under arbitrary conditions. State change will only occur when a transaction is initiated by another account (such as user, oracle, or contract). To resolve this issue, The Chainlink Keeper Network provides options for smart contracts to outsource regular maintenance tasks in a trust minimized & decentralized manner.

How long has it been around?
Open Beta was released in March 2021 and the product itself is live on Mainnet for more than three months, according to official announcement

Where do you think it should go?
In my opinion, it should be in the Oracle Section of the Documentation Page, with other examples of Chainlink services

GitHub URL
https://github.com/smartcontractkit/chainlink

Docs URL
https://docs.chain.link/docs/chainlink-keepers/introduction/

Is the product open source?
Yes, and it is available at https://keepers.chain.link/

@andrejrakic andrejrakic added content 🖋️ This involves copy additions or edits feature ✨ This is enhancing something existing or creating something new labels Nov 16, 2021
@minimalsm
Copy link
Contributor

Hey @andrejrakic thanks for raising this issue 🤝

I'm not familiar with Chainlink keepers but I agree having more information about automating the execution of smart contracts is a great idea!

Open to input here but I'm not sold that the Oracles developer docs is the best place for this to live. Are keepers technically oracles? Do you think this content living alongside smart contracts makes sense?

@minimalsm minimalsm added documentation 📖 Change or add documentation question ❓ Further information is requested and removed feature ✨ This is enhancing something existing or creating something new labels Nov 17, 2021
@andrejrakic
Copy link
Contributor Author

Yes, I am sure that they are oracles. Technically, oracles either provide external data or do external computation/automation. In my opinion, Keepers are an example of the second one.

Glad you opened this discussion! As I see it, after the Oracles section, the second-best place for Keepers is the Smart Contracts section for sure, but I am curious what the community thinks. Maybe @PatrickAlphaC has something to add as an oracle expert.

@PatrickAlphaC
Copy link
Contributor

I echo @andrejrakic's points here! To me this makes a lot of sense!

Perhaps we could point to the keepers page in the smart contracts page too if that is what you'd like, to help users do decentralized event-driven automation.

@minimalsm
Copy link
Contributor

Okay, you've convinced me—I think it living in the Oracles developer docs is good. Finding a home for it in the current smart contract pages probably isn't a bad idea either.

The team are pretty swamped trying to get through our Q4 work and don't have the capacity to take this on yet but feel free to open a PR if you want to expedite this 😊

@andrejrakic @PatrickAlphaC

@andrejrakic
Copy link
Contributor Author

Deal, I will open a PR then 🤝

@minimalsm minimalsm removed the question ❓ Further information is requested label Nov 18, 2021
@samajammin
Copy link
Member

Thanks for raising this issue @andrejrakic!

I agree the Oracles page is a solid spot for this, at least for now until the terminology, resources & projects around keepers continues to expand. It may eventually make sense to have a dedicated page for this topic.

One request here would be to also research & add any other keeper projects that exist in the ecosystem, so it's not too Chainlink-centric. I think describing the concept of keepers in a generic way, then listing the available projects that cover this problem space would be a good way to go to keep things credibly neutral. e.g. I know the Keep3r Network is a popular one within the yearn ecosystem: https://docs.keep3r.network/

@andrejrakic
Copy link
Contributor Author

Thanks for the comment @samajammin that makes sense. I will do some extra research but I must say that I've never used Keep3r Network before. Since I am not an Keep3r expert I propose to open a PR with example for usage of Chainlink Keepers and list Keep3r Network as an alternative

minimalsm added a commit that referenced this issue Dec 17, 2021
Add Keepers to the Documentation [Fixes #4477]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits documentation 📖 Change or add documentation
Projects
None yet
Development

No branches or pull requests

4 participants