Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save stackdump/2b08914f0430c348094c859ee606f68a to your computer and use it in GitHub Desktop.
Save stackdump/2b08914f0430c348094c859ee606f68a to your computer and use it in GitHub Desktop.
@stackdump
Copy link
Author

Creating an Eve Event Library for On-Chain Events

Objective

This SOP outlines the steps to develop and manage an Eve event library for publishing on-chain events using the GNO interface.

Key Steps


1. Introduction to Eve Event Library [0:00](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=0)

generated-image-at-00:00:00

  • Understand the purpose of the Eve event library for publishing on-chain events.
  • Note that the library is still under development and will be available on GitHub once completed.


2. Component Structure [0:21](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=21)

generated-image-at-00:00:21

  • Recognize that everything in Eve is a component.
  • Familiarize yourself with the GNO interface for rendering content as Markdown, SVG, or JSON.


3. Event Agenda Example [0:30](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=30)

generated-image-at-00:00:30

  • Review the example of an event agenda for GopherCon.
  • Understand the support for injectable content logs and the ability to nest sessions and locations.


4. Realm-Specific APIs [0:55](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=55)

generated-image-at-00:00:55

  • Implement realm-specific APIs for each event owner to manage their data.
  • Ensure that the components package is utilized for code reuse.


5. SVG Rendering [1:23](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=83)

generated-image-at-00:01:23

  • Leverage existing markdown to nest images for SVG rendering.
  • Use data URLs for images to inject SVG into the design.


6. Path-Based Presentation [2:00](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=120)

generated-image-at-00:02:00

  • Support path-based presentation in the event API to examine any part of the event component.
  • Use specific URL formats to access event details.


7. Search Engine Compatibility [2:35](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=155)

generated-image-at-00:02:35

  • Implement schema.org syntax for standard event objects to enhance search engine indexing.
  • Understand that Gnoland may require users to deploy Web3 websites for this functionality.


8. Event Updates and Authorization [3:23](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=203)

generated-image-at-00:03:23

  • Use the authorization API to make changes to deployed events.
  • Ensure that realm APIs are trusted during initialization.


9. Patching System [3:35](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=215)

generated-image-at-00:03:35

  • Create patches for event updates using a structured patching system.
  • Increment the patch level in the main document to track changes.


10. Future Developments [4:35](https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3?t=275)

generated-image-at-00:04:35

  • Stay informed about future topics and developments from the labs group, such as linking Discord identities to on-chain actions.

Cautionary Notes

  • Ensure that all components are properly tested before deployment to avoid issues in production.
  • Be cautious with the authorization API to prevent unauthorized changes to event data.

Tips for Efficiency

  • Regularly review and update the documentation to reflect any changes in the API or event structure.
  • Utilize version control for tracking changes in the event library and patches.

Link to Loom

https://loom.com/share/cba53fa89ae74ea9a7bee25b63287aa3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment