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 deployment pattern recommendations #313

Merged
merged 1 commit into from
May 29, 2024

Conversation

aefhm
Copy link
Contributor

@aefhm aefhm commented May 13, 2024

Description

Add technical notes on proxies.

Relates to oasisprotocol/docs#818.

@aefhm aefhm self-assigned this May 13, 2024
@aefhm aefhm added p:1 Priority: high client docs Documentation labels May 13, 2024
Copy link

netlify bot commented May 13, 2024

Deploy Preview for oasisprotocol-sapphire-paratime canceled.

Name Link
🔨 Latest commit f7a4bf6
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-sapphire-paratime/deploys/66575b7983ecf10007e2b1bb

docs/proxies.md Outdated Show resolved Hide resolved
docs/proxies.md Outdated Show resolved Hide resolved
docs/proxies.md Outdated Show resolved Hide resolved
@aefhm aefhm force-pushed the xz/add-harrys-proxy-recommendations branch 2 times, most recently from 7abfd04 to 7b499ab Compare May 22, 2024 21:33
@aefhm aefhm added the javascript Pull requests that update JavaScript code label May 22, 2024
@aefhm aefhm requested a review from matevz May 22, 2024 22:23
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Do you think we should rather rename the chapter to upgradable.md? I can't get rid of a feeling that the chapter is about setting up oracles or paymasters or proxy nodes at first glance when I see the "Proxies" title. The "Upgradable Contracts" is the title I think it rings the right bell for firstcomers.

@aefhm
Copy link
Contributor Author

aefhm commented May 28, 2024

Do you think we should rather rename the chapter to upgradable.md? I can't get rid of a feeling that the chapter is about setting up oracles or paymasters or proxy nodes at first glance when I see the "Proxies" title. The "Upgradable Contracts" is the title I think it rings the right bell for firstcomers.

I kind of want to 🤔. I hear you on the notion of proxy nodes. My concern with "Upgradeable Contracts" would be that the deterministic deploys are "Clones" so to speak with regards to OpenZeppelin terminology. Perhaps "Deployment Customization" or "Upgradable and Deterministic Contracts" can unify both sections? Or how about "Deployment Patterns?"

@aefhm aefhm force-pushed the xz/add-harrys-proxy-recommendations branch from cd7694a to 3b41816 Compare May 28, 2024 23:27
@aefhm aefhm requested a review from matevz May 28, 2024 23:27
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Excellent!

@aefhm aefhm force-pushed the xz/add-harrys-proxy-recommendations branch from 3b41816 to 26a3200 Compare May 29, 2024 16:41
@aefhm aefhm changed the title Add proxy recommendations Add deployment pattern recommendations May 29, 2024
@aefhm aefhm enabled auto-merge May 29, 2024 16:44
@aefhm aefhm force-pushed the xz/add-harrys-proxy-recommendations branch from 26a3200 to f7a4bf6 Compare May 29, 2024 16:44
@aefhm aefhm merged commit 8a9f6b6 into main May 29, 2024
14 of 15 checks passed
@aefhm aefhm deleted the xz/add-harrys-proxy-recommendations branch May 29, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client docs Documentation javascript Pull requests that update JavaScript code p:1 Priority: high
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants