ubiquibot / .github

0 stars 1 forks source link

Define Interactions #11

Open chris-chris opened 6 months ago

chris-chris commented 6 months ago

Resolves #4

For each component, define how it interacts with others. This includes:

Data Flow: How data is passed between components. Dependencies: Components that rely on others to function. Event Triggers: Events in one component that trigger actions in another.

chris-chris commented 6 months ago

@pavlovcik @gentlementlegen Only ubiquity/ubiquibot-kerneluses cloudflare KV, right? I searched the cloudflare kv keyword in the organization.

chris-chris commented 6 months ago

@snibug plz check

chris-chris commented 6 months ago

WIP UbiquityDAO Interaction drawio (2)

chris-chris commented 6 months ago

@pavlovcik I organized github repos into several groups. I connected each service to DB and API. Feel free to give me some feedback

chris-chris commented 6 months ago

Here's draw.io diagram https://drive.google.com/file/d/1PoFGrKjxVKtjhDB8fbV0BKPfirvgIhUt/view?usp=sharing

chris-chris commented 6 months ago

added event triggers and symbol definitions UbiquityDAO Interaction drawio (3)

chris-chris commented 6 months ago

update UbiquityDAO Interaction drawio (6)

chris-chris commented 6 months ago

Please give me some feedback so that I can proceed to the next task.

gentlementlegen commented 5 months ago

@chris-chris Thank you for the graph, very helpful to see things clearly. If you can update audit.ubq.fi with a proper description, and also link Supabase to comment-incentives, permit-generation, conversation-rewards and comment-incentives as it is used there to retrieve user's wallets.

Also what format do you intend to share this diagram? Maybe the URL you shared should also be included in the document.

0x4007 commented 5 months ago

Also what format do you intend to share this diagram? Maybe the URL you shared should also be included in the document.

Hey Chris I think you went too far ahead because diagramming should come at a later step

The reason for this is because it is extra work for you to redo drawing parts if they are incorrect. For example, you have pay.ubq.fi under "token solidity" but really our only custom smart contracts are for @ubiquity/ubiquity-dollar

In pay.ubq.fi technically there is a permit generation tool (using Uniswap's contract) but its for debugging/development purposes only. The UI simply parses JSON encoded permit data, which is meant to be generated elsewhere (by the bot, posted on GitHub)

Anyways there is plenty of more small adjustments we still will need to make before diagramming I think!

Given that you already have something diagramming related, it could also be really helpful if we were able to directly edit it with our adjustments!


I can see you're working on multiple tasks at the same time related to this project. In this case what I've normally seen is that contributors who are interested to be involved will be working on some codebase somewhere in the background in parallel, for example, fixing some problem at the pay.ubq.fi codebase and then pushing forward on this documentation stuff as we are able to provide feedback/input.

chris-chris commented 5 months ago

@0x4007 Thank you for the feedback! 👍 Indeed, organizing the data flow in writing makes sense sequentially. While writing, I got confused about defining the relationships, so I started to draw. I drew the diagram quickly, not just for the output, but also to help myself understand the system. I find that drawing helps me organize my thoughts more effectively.

I'll check the codes in @ubiquity/ubiquity-dollar and pay.ubq.fi.

0x4007 commented 5 months ago

Also what format do you intend to share this diagram? Maybe the URL you shared should also be included in the document.

it could also be really helpful if we were able to directly edit it with our adjustments!

Can you share the URL so we can edit it?

chris-chris commented 5 months ago

Here's draw.io diagram

https://drive.google.com/file/d/1PoFGrKjxVKtjhDB8fbV0BKPfirvgIhUt/view?usp=sharing

@0x4007 @gentlementlegen Here it is 😀

0x4007 commented 5 months ago

Here's draw.io diagram https://drive.google.com/file/d/1PoFGrKjxVKtjhDB8fbV0BKPfirvgIhUt/view?usp=sharing

@0x4007 @gentlementlegen Here it is 😀

Looks like read only access, can't make adjustments.

gentlementlegen commented 5 months ago

Same here, it is on read-only access. However it makes sense that not anyone can modify this document. Maybe it should be moved in the Ubiquity Google Drive to restrict access to collaborators.

chris-chris commented 5 months ago

@gentlementlegen @0x4007 https://drive.google.com/file/d/1PoFGrKjxVKtjhDB8fbV0BKPfirvgIhUt/view?usp=sharing I changed it to an editable link. How can I upload the file to Ubiquity Google Drive?

0x4007 commented 5 months ago

@gentlementlegen @0x4007

https://drive.google.com/file/d/1PoFGrKjxVKtjhDB8fbV0BKPfirvgIhUt/view?usp=sharing

I changed it to an editable link.

How can I upload the file to Ubiquity Google Drive?

Telegram message me your Google drive email and I'll add you to the folder!

rndquu commented 4 months ago

@chris-chris Is it possible to edit this diagram https://drive.google.com/file/d/1PoFGrKjxVKtjhDB8fbV0BKPfirvgIhUt/view ?

I tried to open that document via draw.io google app but got this error:

Screenshot 2024-06-04 at 18 27 48