Skip to main content

Class: Upgrade

Command to upgrade an already published package

BCS

The BCS serialized form for this type is defined by the following ABNF:

upgrade = (vector bytes)        ; move modules
(vector object-id)    ; dependencies
object-id             ; package-id of the package
argument              ; upgrade ticket

Extends​

  • UniffiAbstractObject

Implements​

Constructors​

Constructor​

new Upgrade(
   modules, 
   dependencies, 
   package_, 
   ticket
): Upgrade;

Parameters​

modules​

ArrayBuffer[]

dependencies​

ObjectIdLike[]

package_​

ObjectIdLike

ticket​

ArgumentLike

Returns​

Upgrade

Overrides​

UniffiAbstractObject.constructor

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "Upgrade" = "Upgrade";

Methods​

dependencies()​

dependencies(): ObjectIdLike[];

Set of packages that the to-be published package depends on

Returns​

ObjectIdLike[]

Implementation of​

UpgradeLike.dependencies

equals()​

equals(other): boolean;

Parameters​

other​

Upgrade

Returns​

boolean

modules()​

modules(): ArrayBuffer[];

The serialized move modules

Returns​

ArrayBuffer[]

Implementation of​

UpgradeLike.modules

package_()​

package_(): ObjectIdLike;

Package id of the package to upgrade

Returns​

ObjectIdLike

Implementation of​

UpgradeLike.package_

ticket()​

ticket(): ArgumentLike;

Ticket authorizing the upgrade

Returns​

ArgumentLike

Implementation of​

UpgradeLike.ticket

toDebugString()​

toDebugString(): string;

Returns​

string

toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string

uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

instanceOf()​

static instanceOf(obj_): obj_ is Upgrade;

Parameters​

obj_​

any

Returns​

obj_ is Upgrade