Contract supporting migration staging path #14
Conversation
sisyphusSmiling
changed the title
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #14 +/- ##
==========================================
+ Coverage 74.30% 82.22% +7.91%
==========================================
Files 1 2 +1
Lines 144 225 +81
==========================================
+ Hits 107 185 +78
- Misses 37 40 +3 ☔ View full report in Codecov by Sentry. |
sisyphusSmiling
force-pushed
the
migration-staging
branch
from
b1024b3
to
4be1303
Compare
Co-authored-by: Joshua Hannan <joshua.hannan@flowfoundation.org>
| /// Event emitted when a contract's code is staged | ||
| /// status == true - insert | staged == false - replace | staged == nil - remove | ||
| /// NOTE: Does not guarantee that the contract code is valid Cadence | ||
| access(all) event StagingStatusUpdated( |
| /// Stages the contract code for the given contract name at the host address. If the contract is already staged, | ||
| /// the code will be replaced. | ||
| /// | ||
| access(all) fun stageContract(host: &Host, name: String, code: String) { |
There was a problem hiding this comment.
Should this guard against using a host that is not saved? Or is it not possible to get a ref to a host with it not beeing saved?
There was a problem hiding this comment.
Correct, the Host must be saved as host.address() panics if owner == nil
| address: Address, | ||
| codeHash: [UInt8], | ||
| contract: String, | ||
| status: Bool? |
There was a problem hiding this comment.
personally i think a string that just uses the words "insert", "replace", "remove" is better here then this.
There was a problem hiding this comment.
Good point! Updated to action field with values `"stage", "replace", and "unstage"
…tusUpdated event & .stageContract()
| } | ||
|
|
||
| execute { | ||
| self.admin.setStagingCutoff(atHeight: cutoff) |
There was a problem hiding this comment.
See above
| self.admin.setStagingCutoff(atHeight: cutoff) | |
| self.admin.setStagingCutoff(at: cutoff) |
Co-authored-by: Bastian Müller <bastian@turbolent.com>
Co-authored-by: Bastian Müller <bastian@turbolent.com>
Co-authored-by: Bastian Müller <bastian@turbolent.com>
Closes: #13
The basic interface to stage a contract is the same as deploying a contract - name + code. See the
stage_contract&unstage_contracttransactions.To stage a contract, the developer first saves a
Hostresource in their account which they pass as a reference along with the contract name and code they wish to stage. TheHostreference simply serves as proof of authority that the caller has access to the contract-hosting account, which in the simplest case would be the signer of the staging transaction, though conceivably this could be delegated to some other account via Capability - possibly helpful for some multisig contract hosts.Within the
MigrationContractStagingcontract account, code is saved on a contract-basis as aContractUpdatestruct within aCapsuleresource and stored at a the derived path. TheCapsulesimply serves as a dedicated repository for staged contract code.Included in the contact are methods for querying staging status and retrieval of staged code. This enables platforms like Flowview, Flowdiver, ContractBrowser, etc. to display the staging status of contracts on any given account.
To support ongoing staging progress across the network, the single
StagingStatusUpdatedevent is emitted any time a contract is staged (status == "stage"), staged code is replaced (status == "replace"), or a contract is unstaged (status == "unstage").