TokenIOMerchant.md

• Ownable
  • allowOwnership
  • owner
  • transferOwnership
  • LogOwnershipTransferred
  • LogAllowOwnership
• SafeMath
• TokenIOLib
  • Approval
  • Deposit
  • Withdraw
  • Transfer
  • KYCApproval
  • AccountStatus
  • FxSwap
  • AccountForward
  • NewAuthority
• TokenIOMerchant
  • allowOwnership
  • setParams
  • calculateFees
  • owner
  • pay
  • getFeeParams
  • transferOwnership
  • LogOwnershipTransferred
  • LogAllowOwnership
• TokenIOStorage
  • deleteAddress
  • getAddress
  • deleteBool
  • setBytes
  • setInt
  • allowOwnership
  • deleteBytes
  • owner
  • setString
  • getBool
  • deleteInt
  • getString
  • setBool
  • getUint
  • getBytes
  • setAddress
  • getInt
  • setUint
  • deleteUint
  • transferOwnership
  • deleteString
  • LogOwnershipTransferred
  • LogAllowOwnership

Ownable

function allowOwnership

Ownable.allowOwnership(allowedAddress) nonpayable 4bbc142c

Allows interface contracts to access contract methods (e.g. Storage contract)

Inputs

type	name	description
address	allowedAddress	The address of new owner

Outputs

type	name	description
bool	success	Returns true when successfully allowed ownership

function owner

Ownable.owner() view 666e1b39

Inputs

type	name	description
address		undefined

function transferOwnership

Ownable.transferOwnership(newOwner) nonpayable f2fde38b

Allows the current owner to transfer control of the contract to a newOwner.

Inputs

type	name	description
address	newOwner	The address to transfer ownership to.

Outputs

type	name	description
bool	success	Returns true when successfully transferred ownership

event LogOwnershipTransferred

Ownable.LogOwnershipTransferred(previousOwner, newOwner) db6d05f3

Arguments

type	name	description
address	previousOwner	indexed
address	newOwner	indexed

event LogAllowOwnership

Ownable.LogAllowOwnership(allowedAddress) 5c65eb6a

Arguments

type	name	description
address	allowedAddress	indexed

---

SafeMath

---

TokenIOLib

event Approval

TokenIOLib.Approval(owner, spender, amount) 8c5be1e5

Arguments

type	name	description
address	owner	indexed
address	spender	indexed
uint256	amount	not indexed

event Deposit

TokenIOLib.Deposit(currency, account, amount, issuerFirm) b20a3585

Arguments

type	name	description
string	currency	not indexed
address	account	indexed
uint256	amount	not indexed
string	issuerFirm	not indexed

event Withdraw

TokenIOLib.Withdraw(currency, account, amount, issuerFirm) be0071d3

Arguments

type	name	description
string	currency	not indexed
address	account	indexed
uint256	amount	not indexed
string	issuerFirm	not indexed

event Transfer

TokenIOLib.Transfer(currency, from, to, amount, data) 6f3dcde0

Arguments

type	name	description
string	currency	not indexed
address	from	indexed
address	to	indexed
uint256	amount	not indexed
bytes	data	not indexed

event KYCApproval

TokenIOLib.KYCApproval(account, status, issuerFirm) ab56f145

Arguments

type	name	description
address	account	indexed
bool	status	not indexed
string	issuerFirm	not indexed

event AccountStatus

TokenIOLib.AccountStatus(account, status, issuerFirm) 1d711093

Arguments

type	name	description
address	account	indexed
bool	status	not indexed
string	issuerFirm	not indexed

event FxSwap

TokenIOLib.FxSwap(tokenASymbol, tokenBSymbol, tokenAValue, tokenBValue, expiration, transactionHash) 8afc838d

Arguments

type	name	description
string	tokenASymbol	not indexed
string	tokenBSymbol	not indexed
uint256	tokenAValue	not indexed
uint256	tokenBValue	not indexed
uint256	expiration	not indexed
bytes32	transactionHash	not indexed

event AccountForward

TokenIOLib.AccountForward(originalAccount, forwardedAccount) 940b3d9c

Arguments

type	name	description
address	originalAccount	indexed
address	forwardedAccount	indexed

event NewAuthority

TokenIOLib.NewAuthority(authority, issuerFirm) c05f995c

Arguments

type	name	description
address	authority	indexed
string	issuerFirm	not indexed

---

TokenIOMerchant

function allowOwnership

TokenIOMerchant.allowOwnership(allowedAddress) nonpayable 4bbc142c

Allows interface contracts to access contract methods (e.g. Storage contract)

Inputs

type	name	description
address	allowedAddress	The address of new owner

Outputs

type	name	description
bool	success	Returns true when successfully allowed ownership

function setParams

TokenIOMerchant.setParams(feeContract) nonpayable 4e49acac

Sets Merchant globals and fee paramters

Inputs

type	name	description
address	feeContract	Address of fee contract

Outputs

type	name	description
bool	success	Returns true if successfully called from another contract

function calculateFees

TokenIOMerchant.calculateFees(amount) view 52238fdd

Calculates fee of a given transfer amount

Inputs

type	name	description
uint256	amount	Amount to calculcate fee value

Outputs

type	name	description
uint256	fees	Returns the calculated transaction fees based on the fee contract parameters

function owner

TokenIOMerchant.owner() view 666e1b39

Inputs

type	name	description
address		undefined

function pay

TokenIOMerchant.pay(currency, merchant, amount, merchantPaysFees, data) nonpayable 6db31c25

Pay method for merchant interface

Inputs

type	name	description
string	currency	Currency symbol of the token (e.g. USDx, JYPx, GBPx)
address	merchant	Ethereum address of merchant
uint256	amount	Amount of currency to send to merchant
bool	merchantPaysFees	Provide option for merchant to pay the transaction fees
bytes	data	Optional data to be included when paying the merchant (e.g. item receipt)

Outputs

type	name	description
bool	success	Returns true if successfully called from another contract

function getFeeParams

TokenIOMerchant.getFeeParams() view be6fc181

Gets fee parameters

Outputs

type	name	description
uint256	bps	Fee amount as a mesuare of basis points
uint256	min	Minimum fee amount
uint256	max	Maximum fee amount
uint256	flat	Flat fee amount
address	feeAccount	undefined

function transferOwnership

TokenIOMerchant.transferOwnership(newOwner) nonpayable f2fde38b

Allows the current owner to transfer control of the contract to a newOwner.

Inputs

type	name	description
address	newOwner	The address to transfer ownership to.

Outputs

type	name	description
bool	success	Returns true when successfully transferred ownership

event LogOwnershipTransferred

TokenIOMerchant.LogOwnershipTransferred(previousOwner, newOwner) db6d05f3

Arguments

type	name	description
address	previousOwner	indexed
address	newOwner	indexed

event LogAllowOwnership

TokenIOMerchant.LogAllowOwnership(allowedAddress) 5c65eb6a

Arguments

type	name	description
address	allowedAddress	indexed

---

TokenIOStorage

Ryan Tate [email protected], Sean Pollock [email protected]

function deleteAddress

TokenIOStorage.deleteAddress(_key) nonpayable 0e14a376

Delete value for Address associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function getAddress

TokenIOStorage.getAddress(_key) view 21f8a721

Get value for Address associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
address	_value	Returns the Address value associated with the id key

function deleteBool

TokenIOStorage.deleteBool(_key) nonpayable 2c62ff2d

Delete value for Bool associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function setBytes

TokenIOStorage.setBytes(_key, _value) nonpayable 2e28d084

Set value for Bytes associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage
bytes	_value	The Bytes value to be set

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function setInt

TokenIOStorage.setInt(_key, _value) nonpayable 3e49bed0

Set value for Int associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage
int256	_value	The Int value to be set

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function allowOwnership

TokenIOStorage.allowOwnership(allowedAddress) nonpayable 4bbc142c

Allows interface contracts to access contract methods (e.g. Storage contract)

Inputs

type	name	description
address	allowedAddress	The address of new owner

Outputs

type	name	description
bool	success	Returns true when successfully allowed ownership

function deleteBytes

TokenIOStorage.deleteBytes(_key) nonpayable 616b59f6

Delete value for Bytes associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function owner

TokenIOStorage.owner() view 666e1b39

Inputs

type	name	description
address		undefined

function setString

TokenIOStorage.setString(_key, _value) nonpayable 6e899550

Set value for String associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage
string	_value	The String value to be set

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function getBool

TokenIOStorage.getBool(_key) view 7ae1cfca

Get value for Bool associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	_value	Returns the Bool value associated with the id key

function deleteInt

TokenIOStorage.deleteInt(_key) nonpayable 8c160095

Delete value for Int associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function getString

TokenIOStorage.getString(_key) view 986e791a

Get value for String associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
string	_value	Returns the String value associated with the id key

function setBool

TokenIOStorage.setBool(_key, _value) nonpayable abfdcced

Set value for Bool associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage
bool	_value	The Bool value to be set

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function getUint

TokenIOStorage.getUint(_key) view bd02d0f5

Get value for Uint associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
uint256	_value	Returns the Uint value associated with the id key

function getBytes

TokenIOStorage.getBytes(_key) view c031a180

Get value for Bytes associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bytes	_value	Returns the Bytes value associated with the id key

function setAddress

TokenIOStorage.setAddress(_key, _value) nonpayable ca446dd9

Set value for Address associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage
address	_value	The Address value to be set

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function getInt

TokenIOStorage.getInt(_key) view dc97d962

Get value for Int associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
int256	_value	Returns the Int value associated with the id key

function setUint

TokenIOStorage.setUint(_key, _value) nonpayable e2a4853a

Set value for Uint associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage
uint256	_value	The Uint value to be set

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function deleteUint

TokenIOStorage.deleteUint(_key) nonpayable e2b202bf

Delete value for Uint associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

function transferOwnership

TokenIOStorage.transferOwnership(newOwner) nonpayable f2fde38b

Allows the current owner to transfer control of the contract to a newOwner.

Inputs

type	name	description
address	newOwner	The address to transfer ownership to.

Outputs

type	name	description
bool	success	Returns true when successfully transferred ownership

function deleteString

TokenIOStorage.deleteString(_key) nonpayable f6bb3cc4

Delete value for String associated with bytes32 id key

Inputs

type	name	description
bytes32	_key	Pointer identifier for value in storage

Outputs

type	name	description
bool	success	Returns true when successfully called from another contract

event LogOwnershipTransferred

TokenIOStorage.LogOwnershipTransferred(previousOwner, newOwner) db6d05f3

Arguments

type	name	description
address	previousOwner	indexed
address	newOwner	indexed

event LogAllowOwnership

TokenIOStorage.LogAllowOwnership(allowedAddress) 5c65eb6a

Arguments

type	name	description
address	allowedAddress	indexed

---