Class RadixTransactionBuilder

Hierarchy

RadixTransactionBuilder

Properties

Private BNZERO

BNZERO: BN = new BN(0)

Private DCZERO

DCZERO: Decimal = new Decimal(0)

Private participants

participants: TSMap<string, RadixAccount> = new TSMap()

Private particleGroups

particleGroups: RadixParticleGroup[] = []

Methods

addEncryptedMessage

addEncryptedMessage(from: RadixAccount, applicationId: string, message: string, recipients: RadixAccount[]): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:549
Parameters
- from: RadixAccount
- applicationId: string
- message: string
- recipients: RadixAccount[]
Returns this

addMessageParticle

addMessageParticle(from: RadixAccount, data: string | Buffer, metadata: __type, recipients: RadixAccount[]): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:600
Parameters
- from: RadixAccount
- data: string | Buffer
- metadata: __type
- recipients: RadixAccount[]
Returns this

addTransfer

addTransfer(from: RadixAccount, to: RadixAccount, tokenReference: string | RRI, decimalQuantity: number | string | Decimal, message?: string): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:85
Creates transfer atom

Parameters
- from: RadixAccount
  
  Sender account, needs to have RadixAccountTransferSystem
- to: RadixAccount
  
  Receiver account
- tokenReference: string | RRI
- decimalQuantity: number | string | Decimal
- Optional message: string
Returns this

addUnencryptedMessage

addUnencryptedMessage(from: RadixAccount, applicationId: string, message: string, recipients: RadixAccount[]): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:582
Parameters
- from: RadixAccount
- applicationId: string
- message: string
- recipients: RadixAccount[]
Returns this

addUniqueParticle

addUniqueParticle(account: RadixAccount, unique: string): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:625
Add a particle which enforces that only one such particle can exists per account, enforced on the ledger level

Parameters
- account: RadixAccount
  
  Scope of the uniqueness constraint
- unique: string
  
  The unique id
Returns this

buildAtom

buildAtom(): RadixAtom

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:663
Returns RadixAtom

burnTokens

burnTokens(ownerAccount: RadixAccount, tokenReference: string | RRI, decimalQuantity: string | number | Decimal): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:199
Create an atom to burn a specified amount of tokens The token must be multi-issuance

Parameters
- ownerAccount: RadixAccount
  
  must be the owner and the holder of the tokens to be burned
- tokenReference: string | RRI
- decimalQuantity: string | number | Decimal
Returns this

createToken

createToken(owner: RadixAccount, name: string, symbol: string, description: string, granularity: number | string | Decimal, decimalQuantity: number | string | Decimal, iconUrl: string, permissions: RadixTokenPermissions): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:382
Parameters
- owner: RadixAccount
- name: string
- symbol: string
- description: string
- granularity: number | string | Decimal
- decimalQuantity: number | string | Decimal
- iconUrl: string
- permissions: RadixTokenPermissions
Returns this

createTokenMultiIssuance

createTokenMultiIssuance(owner: RadixAccount, name: string, symbol: string, description: string, granularity?: string | number | Decimal, amount: string | number | Decimal, iconUrl: string): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:482
Parameters
- owner: RadixAccount
- name: string
- symbol: string
- description: string
- Default value granularity: string | number | Decimal = new Decimal('1e-18')
- amount: string | number | Decimal
- iconUrl: string
Returns this

createTokenSingleIssuance

createTokenSingleIssuance(owner: RadixAccount, name: string, symbol: string, description: string, granularity?: string | number | Decimal, amount: string | number | Decimal, iconUrl: string): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:461
Parameters
- owner: RadixAccount
- name: string
- symbol: string
- description: string
- Default value granularity: string | number | Decimal = new Decimal('1e-18')
- amount: string | number | Decimal
- iconUrl: string
Returns this

Private getSubUnitsQuantity

getSubUnitsQuantity(decimalQuantity: Decimal.Value): BN

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:47
Parameters
- decimalQuantity: Decimal.Value
Returns BN

mintTokens

mintTokens(ownerAccount: RadixAccount, tokenReference: string | RRI, decimalQuantity: string | number | Decimal): this

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:305
Create an atom to mint a specified amount of tokens The token must be multi-issuance

Parameters
- ownerAccount: RadixAccount
  
  must be the owner of the token
- tokenReference: string | RRI
- decimalQuantity: string | number | Decimal
Returns this

signAndSubmit

signAndSubmit(signer: RadixSignatureProvider): BehaviorSubject<string>

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:645
Builds the atom, finds a node to submit to, adds network fee, signs the atom and submits

Parameters
- signer: RadixSignatureProvider
Returns BehaviorSubject<string>

a BehaviourSubject that streams the atom status updates

Static createBurnAtom

createBurnAtom(ownerAccount: RadixAccount, tokenReference: string | RRI, decimalQuantity: string | number | Decimal): RadixTransactionBuilder

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:184
Create an atom to burn a specified amount of tokens ownerAccount must be the owner and the holder of the tokens to be burned

Parameters
- ownerAccount: RadixAccount
- tokenReference: string | RRI
- decimalQuantity: string | number | Decimal
Returns RadixTransactionBuilder

Static createMintAtom

createMintAtom(ownerAccount: RadixAccount, tokenReference: string | RRI, decimalQuantity: string | number | Decimal): RadixTransactionBuilder

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:289
Create an atom to mint a specified amount of tokens The token must be multi-issuance

Parameters
- ownerAccount: RadixAccount
  
  must be the owner of the token
- tokenReference: string | RRI
- decimalQuantity: string | number | Decimal
Returns RadixTransactionBuilder

Static createPayloadAtom

createPayloadAtom(from: RadixAccount, recipients: RadixAccount[], applicationId: string, payload: string, encrypted?: boolean): RadixTransactionBuilder

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:507
Creates payload atom

Parameters
- from: RadixAccount
- recipients: RadixAccount[]
  
  Everyone who will receive and be able to decrypt the message
- applicationId: string
- payload: string
- Default value encrypted: boolean = true
Returns RadixTransactionBuilder

Static createRadixMessageAtom

createRadixMessageAtom(from: RadixAccount, to: RadixAccount, message: string): RadixTransactionBuilder

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:537
Creates radix messaging application payload atom

Parameters
- from: RadixAccount
- to: RadixAccount
- message: string
Returns RadixTransactionBuilder

Static createTransferAtom

createTransferAtom(from: RadixAccount, to: RadixAccount, tokenReference: string | RRI, decimalQuantity: number | string | Decimal, message?: string): RadixTransactionBuilder

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:67
Creates transfer atom

Parameters
- from: RadixAccount
  
  Sender account, needs to have RadixAccountTransferSystem
- to: RadixAccount
  
  Receiver account
- tokenReference: string | RRI
  
  TokenClassReference string
- decimalQuantity: number | string | Decimal
- Optional message: string
Returns RadixTransactionBuilder

Static signAndSubmitAtom

signAndSubmitAtom(atom: RadixAtom, connection: RadixNodeConnection, signer: RadixSignatureProvider, participants: RadixAccount[]): BehaviorSubject<string>

- Defined in modules/txbuilder/RadixTransactionBuilder.ts:676
Parameters
- atom: RadixAtom
- connection: RadixNodeConnection
- signer: RadixSignatureProvider
- participants: RadixAccount[]
Returns BehaviorSubject<string>

Generated using TypeDoc