Skip to main content

Class: UpgradeCap

A typed view of an on-chain 0x2::package::UpgradeCap object.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

id()​

id(): ObjectIdLike;

The object's ID.

Returns​

ObjectIdLike

Implementation of​

UpgradeCapLike.id


package_()​

package_(): ObjectIdLike;

ID of the package that can be upgraded.

Returns​

ObjectIdLike

Implementation of​

UpgradeCapLike.package_


policy()​

policy(): number;

What kind of upgrades are allowed.

Returns​

number

Implementation of​

UpgradeCapLike.policy


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

version()​

version(): bigint;

Number of upgrades applied to the original package.

Returns​

bigint

Implementation of​

UpgradeCapLike.version


instanceOf()​

static instanceOf(obj_): obj_ is UpgradeCap;

Parameters​

obj_​

any

Returns​

obj_ is UpgradeCap


tryFromBcs()​

static tryFromBcs(bytes): UpgradeCapLike;

Decode from BCS bytes, without validating the on-chain type tag.

Parameters​

bytes​

ArrayBuffer

Returns​

UpgradeCapLike


tryFromObject()​

static tryFromObject(object): UpgradeCapLike;

Decode from an on-chain object, validating its Move type tag.

Parameters​

object​

ObjectLike

Returns​

UpgradeCapLike