Type Definitions
ApprovalEventCallback(productAccount, brandAccount, appAccount, description, active)
This is a callback function that will be invoked in response to ApprovalEvents
Parameters:
Name | Type | Description |
---|---|---|
productAccount |
string |
product account address. |
brandAccount |
string |
brand account address. |
appAccount |
string |
application account address. |
description |
string |
description |
active |
boolean |
- Source:
TransactionOptions :Object
This object configures gas transaction options to override.
Properties:
Name | Type | Description |
---|---|---|
gasLimit |
gas limit |
|
gasPrice |
gas price |
- Source:
adminEventCallback(address)
This is a callback function that will be invoked in response to adminEvents
Parameters:
Name | Type | Description |
---|---|---|
address |
string |
the address that was added or removed from the admin list (this depends on the type of event that you are listening) |
- Source:
ApprovalEventCallback(productAccount, brandAccount, appAccount, description, active)
This is a callback function that will be invoked in response to ApprovalEvents
Parameters:
Name | Type | Description |
---|---|---|
productAccount |
string |
product account address. |
brandAccount |
string |
brand account address. |
appAccount |
string |
application account address. |
description |
string |
description |
active |
boolean |
- Source:
OwnershipEventCallback(fromAddress, toAddress)
This is a callback function that will be invoked in response to adminEvents
Parameters:
Name | Type | Description |
---|---|---|
fromAddress |
string | |
toAddress |
string |
- Source:
App :Object
Holds app related data
Properties:
Name | Type | Description |
---|---|---|
active |
bool | |
appAccount |
string | |
appName |
string | |
fee |
BigNumber | |
feeAccount |
string |
- Source:
AppData :Object
Holds app related data
Properties:
Name | Type | Description |
---|---|---|
active |
bool | |
_fee |
BigNumber | |
_feeAccount |
string |
- Source:
Brand :Object
Holds app related data
Properties:
Name | Type | Description |
---|---|---|
brandAccount |
string | |
appAccount |
string | |
brandName |
string | |
active |
bool |
- Source:
BrandData :Object
Holds Brand related data
Properties:
Name | Type | Description |
---|---|---|
appAccount |
string | |
appFeeAccount |
string | |
active |
bool |
- Source:
Product :Object
Holds Product related data
Properties:
Name | Type | Description |
---|---|---|
productAccount |
string | |
brandAccount |
string | |
description |
string | |
details |
string | |
year |
BigNumber | |
origin |
string | |
active |
bool |
- Source:
ProductData :Object
Holds Product related data
Properties:
Name | Type | Description |
---|---|---|
brandAccount |
String | |
appAccount |
string | |
appFeeAccount |
string | |
active |
bool |
- Source:
AppEventCallback(appAccount, appName, feeAccount, fee, active)
This is a callback function that will be invoked in response to appEvents
Parameters:
Name | Type | Description |
---|---|---|
appAccount |
string | |
appName |
string | |
feeAccount |
string | |
fee |
int | |
active |
bool |
- Source:
ClientOptions :Object
This object configures how the client will connect and communicate to the Ethereum network. Unless you have good reasons to change the default configurations you don't need to worry with any of these values as the will be automatically resolved contract address in your current network. Under normal circumstances you don't need to pass any of these fields.
Properties:
Name | Type | Description |
---|---|---|
web3Instance |
Object |
the current web3 object, like the one injected by metamask |
acc |
string |
the accounts' address that will execute the transactions |
address |
string |
expects the contract address in your current network, unless you are running your own network you don't need to provide it |
walletPrivateKey |
private key for the wallet. |
|
networkId |
current network Id. |
- Source:
BrandEventCallback(brandAccount, appAccount, active)
This is a callback function that will be invoked in response to BrandEvents
Parameters:
Name | Type | Description |
---|---|---|
brandAccount |
string |
brand account address. |
appAccount |
string |
application account address. |
active |
string |
- Source:
ProductEventCallback(productAccount, brandAccount, appAccount, description, active)
This is a callback function that will be invoked in response to ProductEvents
Parameters:
Name | Type | Description |
---|---|---|
productAccount |
string |
product account address. |
brandAccount |
string |
brand account address. |
appAccount |
string |
application account address. |
description |
string |
description. |
active |
boolean |
- Source:
MarkResult :Object
Properties:
Name | Type | Description |
---|---|---|
appAccount |
String |
application account address. |
brandAccount |
string |
brand account address. |
productAccount |
string |
product account address. |
- Source:
PermissionedEventCallback(marker, brandAccount, permission)
This is a callback function that will be invoked in response to Permissioned event.
Parameters:
Name | Type | Description |
---|---|---|
marker |
string | |
brandAccount |
string |
brand account address. |
permission |
- Source:
MarkedEventCallback(marker, productAccount, appFeeAccount, feeAccount, appFee, fee, itemHash)
This is a callback function that will be invoked in response to Marked event.
Parameters:
Name | Type | Description |
---|---|---|
marker |
string | |
productAccount |
string |
product account address. |
appFeeAccount |
||
feeAccount |
||
appFee |
||
fee |
||
itemHash |
- Source:
AprovalEventCallback(tokenOwner, spender, tokens)
This is a callback function that will be invoked in response to the Approval event.
Parameters:
Name | Type | Description |
---|---|---|
tokenOwner |
token owner |
|
spender |
ethereum address, that has right to spend the approved tokens, this can be a contract address or any other address |
|
tokens |
quantity of tokens |
- Source:
TransferEventCallback(from, to, tokens)
This is a callback function that will be invoked in response to the OwnershipTransferred event
Parameters:
Name | Type | Description |
---|---|---|
from |
the address the transfer goes from |
|
to |
the address the transfer goes to |
|
tokens |
amount transferred |
- Source: