Skip to content

Commit

Permalink
Update high level API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ericglau committed Aug 23, 2024
1 parent 85e8594 commit ce3bdb4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/modules/ROOT/pages/api-core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ validateUpgradeSafety(
contract?: string,
reference?: string,
opts: ValidateUpgradeSafetyOptions = {},
referenceBuildInfoDirs?: string[],
exclude?: string[],
): Promise<ProjectReport>
----

Expand All @@ -170,6 +172,8 @@ Note that this function does not throw validation errors directly. Instead, you
** `unsafeAllowRenames`
** `unsafeSkipStorageCheck`
** `requireReference` - Can only be used when the `contract` argument is also provided. Not compatible with the `unsafeSkipStorageCheck` option. If specified, requires either the `reference` argument to be provided or the contract to have a `@custom:oz-upgrades-from` annotation.
* `referenceBuildInfoDirs` - Optional paths of additional build info directories from previous versions of the project to use for storage layout comparisons. When using this option, refer to one of these directories using prefix `<dirName>:` before the contract name or fully qualified name in the `reference` param or `@custom:oz-upgrades-from` annotation, where `<dirName>` is the directory short name. Each directory short name must be unique, including compared to the main build info directory.
* `exclude` - Exclude validations for contracts in source file paths that match any of the given glob patterns.

*Returns:*

Expand Down

0 comments on commit ce3bdb4

Please sign in to comment.