From ce3bdb4ceda929608240032fd1c0d08a2352bb6c Mon Sep 17 00:00:00 2001 From: Eric Lau Date: Fri, 23 Aug 2024 13:36:40 -0400 Subject: [PATCH] Update high level API doc --- docs/modules/ROOT/pages/api-core.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/modules/ROOT/pages/api-core.adoc b/docs/modules/ROOT/pages/api-core.adoc index d89a9f79f..df1e6dc02 100644 --- a/docs/modules/ROOT/pages/api-core.adoc +++ b/docs/modules/ROOT/pages/api-core.adoc @@ -153,6 +153,8 @@ validateUpgradeSafety( contract?: string, reference?: string, opts: ValidateUpgradeSafetyOptions = {}, + referenceBuildInfoDirs?: string[], + exclude?: string[], ): Promise ---- @@ -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 `:` before the contract name or fully qualified name in the `reference` param or `@custom:oz-upgrades-from` annotation, where `` 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:*