Class: AdminData

Properties overview

  • allowChangeAdmin: Bool = Bool;
  • allowChangeBaseUri: Bool = Bool;
  • allowChangeCreator: Bool = Bool;
  • allowChangeName: Bool = Bool;
  • allowChangeRoyalty: Bool = Bool;
  • allowChangeTransferFee: Bool = Bool;
  • canPause: Bool = Bool;
  • isPaused: Bool = Bool;

Methods overview

Defined in: packages/nft/src/admin/advanced.ts:66

Represents pause-related data, containing flags for pause functionality.

Extends

  • {
    allowChangeAdmin: Bool;
    allowChangeBaseUri: Bool;
    allowChangeCreator: Bool;
    allowChangeName: Bool;
    allowChangeRoyalty: Bool;
    allowChangeTransferFee: Bool;
    canPause: Bool;
    isPaused: Bool;
    }

Constructors

new AdminData()

new AdminData(value: {
  allowChangeAdmin: Bool;
  allowChangeBaseUri: Bool;
  allowChangeCreator: Bool;
  allowChangeName: Bool;
  allowChangeRoyalty: Bool;
  allowChangeTransferFee: Bool;
  canPause: Bool;
  isPaused: Bool;
 }): AdminData

Defined in: node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103

Parameters

value
allowChangeAdmin

Bool = Bool

Indicates whether the contract can change the admin.

allowChangeBaseUri

Bool = Bool

Indicates whether the contract can change the base URI.

allowChangeCreator

Bool = Bool

Indicates whether the contract can change the creator.

allowChangeName

Bool = Bool

Indicates whether the contract can change the name.

allowChangeRoyalty

Bool = Bool

Indicates whether the contract can change the royalty fee.

allowChangeTransferFee

Bool = Bool

Indicates whether the contract can change the transfer fee.

canPause

Bool = Bool

Indicates whether the contract can be paused.

isPaused

Bool = Bool

Indicates whether the contract is currently paused.

Returns

AdminData

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).constructor

Properties

allowChangeAdmin

allowChangeAdmin: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:80

Indicates whether the contract can change the admin.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).allowChangeAdmin

allowChangeBaseUri

allowChangeBaseUri: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:76

Indicates whether the contract can change the base URI.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).allowChangeBaseUri

allowChangeCreator

allowChangeCreator: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:78

Indicates whether the contract can change the creator.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).allowChangeCreator

allowChangeName

allowChangeName: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:82

Indicates whether the contract can change the name.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).allowChangeName

allowChangeRoyalty

allowChangeRoyalty: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:72

Indicates whether the contract can change the royalty fee.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).allowChangeRoyalty

allowChangeTransferFee

allowChangeTransferFee: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:74

Indicates whether the contract can change the transfer fee.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).allowChangeTransferFee

canPause

canPause: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:68

Indicates whether the contract can be paused.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).canPause

isPaused

isPaused: Bool = Bool;

Defined in: packages/nft/src/admin/advanced.ts:70

Indicates whether the contract is currently paused.

Inherited from

Struct({
  / Indicates whether the contract can be paused. /
  canPause: Bool,
  / Indicates whether the contract is currently paused. /
  isPaused: Bool,
  / Indicates whether the contract can change the royalty fee. /
  allowChangeRoyalty: Bool,
  / Indicates whether the contract can change the transfer fee. /
  allowChangeTransferFee: Bool,
  / Indicates whether the contract can change the base URI. /
  allowChangeBaseUri: Bool,
  / Indicates whether the contract can change the creator. /
  allowChangeCreator: Bool,
  / Indicates whether the contract can change the admin. /
  allowChangeAdmin: Bool,
  / Indicates whether the contract can change the name. /
  allowChangeName: Bool,
}).isPaused

Methods

pack()

pack(): Field

Defined in: packages/nft/src/admin/advanced.ts:121

Packs the pause data into a Field.

Returns

Field

A Field representing the packed pause data.


isPaused()

static isPaused(field: Field): Bool

Defined in: packages/nft/src/admin/advanced.ts:160

Parameters

field

Field

Returns

Bool


new()

static new(params: {
  allowChangeAdmin: boolean;
  allowChangeBaseUri: boolean;
  allowChangeCreator: boolean;
  allowChangeName: boolean;
  allowChangeRoyalty: boolean;
  allowChangeTransferFee: boolean;
  canPause: boolean;
  isPaused: boolean;
 }): AdminData

Defined in: packages/nft/src/admin/advanced.ts:84

Parameters

params
allowChangeAdmin

boolean

allowChangeBaseUri

boolean

allowChangeCreator

boolean

allowChangeName

boolean

allowChangeRoyalty

boolean

allowChangeTransferFee

boolean

canPause

boolean

isPaused

boolean

Returns

AdminData


unpack()

static unpack(field: Field): AdminData

Defined in: packages/nft/src/admin/advanced.ts:138

Unpacks a Field into PauseData.

Parameters

field

Field

The Field to unpack.

Returns

AdminData

An instance of PauseData.