Class TokenManagementTransactionsFactory

Use this class to create token management transactions like issuing ESDTs, creating NFTs, setting roles, etc.

Index

Constructors

Properties

argSerializer config falseAsString trueAsString

Methods

Constructors

constructor

new TokenManagementTransactionsFactory(options): TokenManagementTransactionsFactory
Parameters
- options: {
  config: Config;
  }
  - config: Config
Returns TokenManagementTransactionsFactory
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:40

Properties

`Private` `Readonly` argSerializer

argSerializer: ArgSerializer

`Private` `Readonly` config

config: Config

`Private` `Readonly` falseAsString

falseAsString: string

`Private` `Readonly` trueAsString

trueAsString: string

Methods

`Private` boolToString

boolToString(value): string
Parameters
- value: boolean
Returns string
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:647

createTransactionForAddingQuantity

createTransactionForAddingQuantity(options): Transaction
Parameters
- options: {
      quantityToAdd: bigint;
      sender: IAddress;
      tokenIdentifier: string;
      tokenNonce: bigint;
  }
  - quantityToAdd: bigint
  - sender: IAddress
  - tokenIdentifier: string
  - tokenNonce: bigint
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:588

createTransactionForBurningQuantity

createTransactionForBurningQuantity(options): Transaction
Parameters
- options: {
      quantityToBurn: bigint;
      sender: IAddress;
      tokenIdentifier: string;
      tokenNonce: bigint;
  }
  - quantityToBurn: bigint
  - sender: IAddress
  - tokenIdentifier: string
  - tokenNonce: bigint
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:613

createTransactionForCreatingNFT

createTransactionForCreatingNFT(options): Transaction
Parameters
- options: {
      attributes: Uint8Array;
      hash: string;
      initialQuantity: bigint;
      name: string;
      royalties: number;
      sender: IAddress;
      tokenIdentifier: string;
      uris: string[];
  }
  - attributes: Uint8Array
  - hash: string
  - initialQuantity: bigint
  - name: string
  - royalties: number
  - sender: IAddress
  - tokenIdentifier: string
  - uris: string[]
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:390

createTransactionForFreezing

createTransactionForFreezing(options): Transaction
Parameters
- options: {
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:456

createTransactionForIssuingFungible

createTransactionForIssuingFungible(options): Transaction
Parameters
- options: {
      canAddSpecialRoles: boolean;
      canChangeOwner: boolean;
      canFreeze: boolean;
      canPause: boolean;
      canUpgrade: boolean;
      canWipe: boolean;
      initialSupply: bigint;
      numDecimals: bigint;
      sender: IAddress;
      tokenName: string;
      tokenTicker: string;
  }
  - canAddSpecialRoles: boolean
  - canChangeOwner: boolean
  - canFreeze: boolean
  - canPause: boolean
  - canUpgrade: boolean
  - canWipe: boolean
  - initialSupply: bigint
  - numDecimals: bigint
  - sender: IAddress
  - tokenName: string
  - tokenTicker: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:47

createTransactionForIssuingNonFungible

createTransactionForIssuingNonFungible(options): Transaction
Parameters
- options: {
      canAddSpecialRoles: boolean;
      canChangeOwner: boolean;
      canFreeze: boolean;
      canPause: boolean;
      canTransferNFTCreateRole: boolean;
      canUpgrade: boolean;
      canWipe: boolean;
      sender: IAddress;
      tokenName: string;
      tokenTicker: string;
  }
  - canAddSpecialRoles: boolean
  - canChangeOwner: boolean
  - canFreeze: boolean
  - canPause: boolean
  - canTransferNFTCreateRole: boolean
  - canUpgrade: boolean
  - canWipe: boolean
  - sender: IAddress
  - tokenName: string
  - tokenTicker: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:140

createTransactionForIssuingSemiFungible

createTransactionForIssuingSemiFungible(options): Transaction
Parameters
- options: {
      canAddSpecialRoles: boolean;
      canChangeOwner: boolean;
      canFreeze: boolean;
      canPause: boolean;
      canTransferNFTCreateRole: boolean;
      canUpgrade: boolean;
      canWipe: boolean;
      sender: IAddress;
      tokenName: string;
      tokenTicker: string;
  }
  - canAddSpecialRoles: boolean
  - canChangeOwner: boolean
  - canFreeze: boolean
  - canPause: boolean
  - canTransferNFTCreateRole: boolean
  - canUpgrade: boolean
  - canWipe: boolean
  - sender: IAddress
  - tokenName: string
  - tokenTicker: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:94

createTransactionForLocalBurning

createTransactionForLocalBurning(options): Transaction
Parameters
- options: {
      sender: IAddress;
      supplyToBurn: bigint;
      tokenIdentifier: string;
  }
  - sender: IAddress
  - supplyToBurn: bigint
  - tokenIdentifier: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:540

createTransactionForLocalMint

createTransactionForLocalMint(options): Transaction
Parameters
- options: {
      sender: IAddress;
      supplyToMint: bigint;
      tokenIdentifier: string;
  }
  - sender: IAddress
  - supplyToMint: bigint
  - tokenIdentifier: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:517

createTransactionForPausing

createTransactionForPausing(options): Transaction
Parameters
- options: {
  sender: IAddress;
  tokenIdentifier: string;
  }
  - sender: IAddress
  - tokenIdentifier: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:427

createTransactionForRegisteringAndSettingRoles

createTransactionForRegisteringAndSettingRoles(options): Transaction
Parameters
- options: {
      numDecimals: bigint;
      sender: IAddress;
      tokenName: string;
      tokenTicker: string;
      tokenType: RegisterAndSetAllRolesTokenType;
  }
  - numDecimals: bigint
  - sender: IAddress
  - tokenName: string
  - tokenTicker: string
  - tokenType: RegisterAndSetAllRolesTokenType
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:234

createTransactionForRegisteringMetaESDT

createTransactionForRegisteringMetaESDT(options): Transaction
Parameters
- options: {
      canAddSpecialRoles: boolean;
      canChangeOwner: boolean;
      canFreeze: boolean;
      canPause: boolean;
      canTransferNFTCreateRole: boolean;
      canUpgrade: boolean;
      canWipe: boolean;
      numDecimals: bigint;
      sender: IAddress;
      tokenName: string;
      tokenTicker: string;
  }
  - canAddSpecialRoles: boolean
  - canChangeOwner: boolean
  - canFreeze: boolean
  - canPause: boolean
  - canTransferNFTCreateRole: boolean
  - canUpgrade: boolean
  - canWipe: boolean
  - numDecimals: bigint
  - sender: IAddress
  - tokenName: string
  - tokenTicker: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:186

createTransactionForSettingBurnRoleGlobally

createTransactionForSettingBurnRoleGlobally(options): Transaction
Parameters
- options: {
  sender: IAddress;
  tokenIdentifier: string;
  }
  - sender: IAddress
  - tokenIdentifier: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:264

createTransactionForSettingSpecialRoleOnFungibleToken

createTransactionForSettingSpecialRoleOnFungibleToken(options): Transaction
Parameters
- options: {
      addRoleLocalBurn: boolean;
      addRoleLocalMint: boolean;
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - addRoleLocalBurn: boolean
  - addRoleLocalMint: boolean
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:296

createTransactionForSettingSpecialRoleOnMetaESDT

createTransactionForSettingSpecialRoleOnMetaESDT(options): Transaction
Parameters
- options: {
      addRoleESDTTransferRole: boolean;
      addRoleNFTAddQuantity: boolean;
      addRoleNFTBurn: boolean;
      addRoleNFTCreate: boolean;
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - addRoleESDTTransferRole: boolean
  - addRoleNFTAddQuantity: boolean
  - addRoleNFTBurn: boolean
  - addRoleNFTCreate: boolean
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:348

createTransactionForSettingSpecialRoleOnNonFungibleToken

createTransactionForSettingSpecialRoleOnNonFungibleToken(options): Transaction
Parameters
- options: {
      addRoleESDTTransferRole: boolean;
      addRoleNFTAddURI: boolean;
      addRoleNFTBurn: boolean;
      addRoleNFTCreate: boolean;
      addRoleNFTUpdateAttributes: boolean;
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - addRoleESDTTransferRole: boolean
  - addRoleNFTAddURI: boolean
  - addRoleNFTBurn: boolean
  - addRoleNFTCreate: boolean
  - addRoleNFTUpdateAttributes: boolean
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:360

createTransactionForSettingSpecialRoleOnSemiFungibleToken

createTransactionForSettingSpecialRoleOnSemiFungibleToken(options): Transaction
Parameters
- options: {
      addRoleESDTTransferRole: boolean;
      addRoleNFTAddQuantity: boolean;
      addRoleNFTBurn: boolean;
      addRoleNFTCreate: boolean;
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - addRoleESDTTransferRole: boolean
  - addRoleNFTAddQuantity: boolean
  - addRoleNFTBurn: boolean
  - addRoleNFTCreate: boolean
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:320

createTransactionForUnfreezing

createTransactionForUnfreezing(options): Transaction
Parameters
- options: {
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:475

createTransactionForUnpausing

createTransactionForUnpausing(options): Transaction
Parameters
- options: {
  sender: IAddress;
  tokenIdentifier: string;
  }
  - sender: IAddress
  - tokenIdentifier: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:440

createTransactionForUnsettingBurnRoleGlobally

createTransactionForUnsettingBurnRoleGlobally(options): Transaction
Parameters
- options: {
  sender: IAddress;
  tokenIdentifier: string;
  }
  - sender: IAddress
  - tokenIdentifier: string
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:280

createTransactionForUpdatingAttributes

createTransactionForUpdatingAttributes(options): Transaction
Parameters
- options: {
      attributes: Uint8Array;
      sender: IAddress;
      tokenIdentifier: string;
      tokenNonce: bigint;
  }
  - attributes: Uint8Array
  - sender: IAddress
  - tokenIdentifier: string
  - tokenNonce: bigint
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:563

createTransactionForWiping

createTransactionForWiping(options): Transaction
Parameters
- options: {
      sender: IAddress;
      tokenIdentifier: string;
      user: IAddress;
  }
  - sender: IAddress
  - tokenIdentifier: string
  - user: IAddress
Returns Transaction
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:498

`Private` notifyAboutUnsettingBurnRoleGlobally

notifyAboutUnsettingBurnRoleGlobally(): void
Returns void
- Defined in src/transactionsFactories/tokenManagementTransactionsFactory.ts:638

Class TokenManagementTransactionsFactory

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: Config

Returns TokenManagementTransactionsFactory

Properties

Private Readonly argSerializer

Private Readonly config

Private Readonly falseAsString

Private Readonly trueAsString

Methods

Private boolToString

Parameters

Returns string

createTransactionForAddingQuantity

Parameters

quantityToAdd: bigint

sender: IAddress

tokenIdentifier: string

tokenNonce: bigint

Returns Transaction

createTransactionForBurningQuantity

Parameters

quantityToBurn: bigint

sender: IAddress

tokenIdentifier: string

tokenNonce: bigint

Returns Transaction

createTransactionForCreatingNFT

Parameters

attributes: Uint8Array

hash: string

initialQuantity: bigint

name: string

royalties: number

sender: IAddress

tokenIdentifier: string

uris: string[]

Returns Transaction

createTransactionForFreezing

Parameters

sender: IAddress

tokenIdentifier: string

user: IAddress

Returns Transaction

createTransactionForIssuingFungible

Parameters

canAddSpecialRoles: boolean

canChangeOwner: boolean

canFreeze: boolean

canPause: boolean

canUpgrade: boolean

canWipe: boolean

initialSupply: bigint

numDecimals: bigint

sender: IAddress

tokenName: string

tokenTicker: string

Returns Transaction

createTransactionForIssuingNonFungible

Parameters

canAddSpecialRoles: boolean

canChangeOwner: boolean

canFreeze: boolean

canPause: boolean

canTransferNFTCreateRole: boolean

canUpgrade: boolean

canWipe: boolean

sender: IAddress

tokenName: string

tokenTicker: string

Returns Transaction

createTransactionForIssuingSemiFungible

Parameters

canAddSpecialRoles: boolean

`Private` `Readonly` argSerializer

`Private` `Readonly` config

`Private` `Readonly` falseAsString

`Private` `Readonly` trueAsString

`Private` boolToString