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.

Sign up for GitHub

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

docs: SRC-14 grammar and example links #99

Merged
merged 3 commits into from
Jun 3, 2024
Merged

docs: SRC-14 grammar and example links #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf24bad
Update src-14.md
K1-R1 May 29, 2024
307aef5
Update src-14.md links
K1-R1 May 29, 2024
d9c30ba
Update README.md
K1-R1 May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ If you don't find what you're looking for, feel free to create an issue and prop
### Contracts

- [SRC-12; Contract Factory](./SRCs/src-12.md) defines the implementation of a standard API for contract factories.
- [SRC-14; Simple Upgradable Proxies](./SRCs/src-14.md) defines the implementation of a standard API for simple upgradable proxies.

### Bridge

Expand Down Expand Up @@ -149,6 +150,16 @@ Example of the SRC-12 implementation where contract deployments contain configur

Example of the SRC-12 implementation where all contract deployments are identical and thus have the same bytecode and root.

#### SRC-14; Simple Upgradable Proxies Standard Examples

##### [Minimal](./examples/src14-simple-proxy/minimal/src/minimal.sw)

Example of a minimal SRC-14 implementation with no access control.

##### [Owned Proxy](./examples/src14-simple-proxy/owned/src/owned.sw)

Example of a SRC-14 implementation that also implements [SRC-5](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-5.md).

> **Note**
> All standards currently use `forc v0.59.0`.

Expand Down
6 changes: 3 additions & 3 deletions SRCs/src-14.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The following proposes a standard for simple upgradable proxies.

## Motivation

We seek to standardize proxy implementation to improve developer experience and enable tooling to automatically deploy or update proxies as needed.
We seek to standardize a proxy implementation to improve developer experience and enable tooling to automatically deploy or update proxies as needed.

## Prior Art

Expand Down Expand Up @@ -71,10 +71,10 @@ abi SRC14 {

## Example Implementation

### [Minimal Proxy](../examples/examples/src14-simple-proxy/owned/src/minimal.sw)
### [Minimal Proxy](../examples/src14-simple-proxy/minimal/src/minimal.sw)

Example of a minimal SRC-14 implementation with no access control.

### [Owned Proxy](../examples/examples/src14-simple-proxy/owned/src/owned.sw)
### [Owned Proxy](../examples/src14-simple-proxy/owned/src/owned.sw)

Example of a SRC-14 implementation that also implements [SRC-5](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-5.md).
Loading