polar icon indicating copy to clipboard operation
polar copied to clipboard

Feature Request: External API

Open rbndg opened this issue 2 years ago • 4 comments

Would be very nice if Polar had an API that can be used to create networks, create nodes, take them down. Basically the features that are now possible via the GUI for managing the network, not for interacting with the actual nodes.

These will be used for integration testing

rbndg avatar Jan 05 '23 13:01 rbndg

Thanks for the feedback. I've received a similar request some time ago. I think the right approach would be to split all of the docker & compose logic out to it's own NPM package which other apps can use to automate spinning up new networks. I like the idea, but this is a pretty big lift and not something I'd personally use, so I can't commit to working on it. I'll leave this issue open in case someone else would be interested in working on this.

jamaljsr avatar Jan 05 '23 14:01 jamaljsr

I can see potential in this and have wanted the same feature as well. I really like that polar build's robust compose files. I'm new to the codebase, and as @jamaljsr said, it's a big lift. I think this is something I would like to do after the Taro integration is complete if there aren't any pressing issues. I can't commit to it as I think it is something that is beyond my ability, but I'll investigate the idea in the future.

amovfx avatar Jan 06 '23 16:01 amovfx

@jamaljsr I will like to begin this. Since it is a huge deal I can't promise that I will complete it but I will definitely put in my all should I attempt it ?

Muniru0 avatar Mar 01 '24 14:03 Muniru0

Hey @Muniru0, I would not suggest starting development on this until we have a deep dive discussion on exactly how to implement it. We have to draw a line between what code will live in the SDK versus what will remain in the Polar app. This is not a decision I'd want to make lightly because it will have pretty big consequences going forward.

Given the scale of this project, I don't recommend tackling this as a first time contributor. It would be better to tackle some smaller issues first to become more familiar with the codebase.

jamaljsr avatar Mar 01 '24 17:03 jamaljsr