-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1413 from onflow/feature/stable-cadence-merge-master
Feature/stable cadence merge master
- Loading branch information
Showing
86 changed files
with
70 additions
and
20,196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,3 @@ | ||
## Flowkit Package Design | ||
Flowkit is a core package used by the CLI commands. It features APIs for interacting with the Flow network | ||
in the context of flow.json configuration values. Flowkit is defined by the [interface here](services.go). | ||
|
||
Flowkit contains multiple subpackages, the most important ones are: | ||
- **config**: parsing and storing of flow.json values, as well as validation, | ||
- **gateway**: implementation of Flow AN methods, uses emulator as well as Go SDK to communicate with ANs, | ||
- **project**: stateful operations on top of flow.json, which allows resolving imports in contracts used in deployments | ||
|
||
It is important we define clear boundaries between flowkit and other CLI packages. If we are in doubt where certain | ||
methods should be implemented we must ask ourselves if the method provides value for any other consumers of the | ||
pacakge or only provides utility for CLI usage, if it's only providing utility for CLI then it should be added inside | ||
the internal package, instead of flowkit. If in doubt better to add things to internal package and then move to flowkit | ||
if such need is identified. | ||
|
||
## Flowkit | ||
|
||
Note: This module has been migrated to github.com/onflow/flowkit. The latest supported version is v1.13.0. Please use the new module github.com/onflow/flowkit instead for any future updates. Version v1.13.0 is equivalent to version v1.13.0 on the new module. |
Oops, something went wrong.