OpenST Payments

Class: BrandedToken

lib/contract_interact/branded_token~ BrandedToken

new BrandedToken(brandedTokenAddress, chainId)

Constructor to create object of BrandedToken
Parameters:
Name Type Description
brandedTokenAddress string Branded token address
chainId number chainId

Members

brandedTokenAddress

branded token address

chainId

chain id

Methods

approveByBudgetHolder(airdropBudgetHolderAddress, airdropBudgetHolderPassphrase, airdropContractAddress, amount, gasPrice, options)

Approve amount to budget holder
Parameters:
Name Type Description
airdropBudgetHolderAddress string address of airdropBudgetHolder
airdropBudgetHolderPassphrase string Passphrase of airdropBudgetHolder
airdropContractAddress string airdrop contract address
amount BigNumber amount in wei
gasPrice BigNumber gas price
options object for params like returnType, tag.
Returns:
Type
promise.<result>

creditBalance(owner, amount)

Credit balance in cache
Parameters:
Name Type Description
owner string Account address
amount BigNumber amount to be credited
Returns:
Type
promise.<result>

debitBalance(owner, bigAmount)

Debit balance in cache
Parameters:
Name Type Description
owner string Account address
bigAmount BigNumber amount to be debited
Returns:
Type
promise.<result>

getBalanceOf(owner)

Fetch Balance For a given address
Parameters:
Name Type Description
owner string address for which balance is to be fetched
Returns:
Type
promise.<result>

transferToAirdropBudgetHolder(senderAddress, senderPassphrase, airdropBudgetHolderAddress, amount, gasPrice, options)

Transfer amount to budget holder
Parameters:
Name Type Description
senderAddress string address of sender
senderPassphrase string passphrase of sender
airdropBudgetHolderAddress string recipient address
amount BigNumber amount in wei
gasPrice BigNumber gas price
options object for params like returnType, tag.
Returns:
Type
promise.<result>