Skip to content

Commit

Permalink
Merge pull request #99 from FuelLabs/K1-R1/SRC-14-README-patch
Browse files Browse the repository at this point in the history
docs: SRC-14 grammar and example links
  • Loading branch information
K1-R1 authored Jun 3, 2024
2 parents 40d6dba + d9c30ba commit 27c4f18
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
11 changes: 11 additions & 0 deletions README.md
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.60.0`.
Expand Down
6 changes: 3 additions & 3 deletions SRCs/src-14.md
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).

0 comments on commit 27c4f18

Please sign in to comment.