Interface for the Polymath Security Token Registry contract (ISecurityTokenRegistry.sol)
View Source: contracts/interfaces/ISecurityTokenRegistry.sol
ISecurityTokenRegistry
Events
Functions
generateSecurityToken
Deploys an instance of a new Security Token of version 2.0 and records it to the registry
Arguments
Name | Type | Description |
_name | string | is the name of the token |
_ticker | string | is the ticker symbol of the security token |
_tokenDetails | string | is the off-chain details of the token |
_divisible | bool | is whether or not the token is divisible |
generateNewSecurityToken
Deploys an instance of a new Security Token and records it to the registry
Arguments
Name | Type | Description |
_name | string | is the name of the token |
_ticker | string | is the ticker symbol of the security token |
_tokenDetails | string | is the off-chain details of the token |
_divisible | bool | is whether or not the token is divisible |
_treasuryWallet | address | Ethereum address which will holds the STs. |
_protocolVersion | uint256 | Version of securityToken contract |
_protocolVersion
is the packed value of uin8[3] array (it will be calculated offchain)if _protocolVersion == 0 then latest version of securityToken will be generated |
refreshSecurityToken
Deploys an instance of a new Security Token and replaces the old one in the registry This can be used to upgrade from version 2.0 of ST to 3.0 or in case something goes wrong with earlier ST
Arguments
Name | Type | Description |
_name | string | is the name of the token |
_ticker | string | is the ticker symbol of the security token |
_tokenDetails | string | is the off-chain details of the token |
_divisible | bool | is whether or not the token is divisible |
_treasuryWallet | address |
modifySecurityToken
Adds a new custom Security Token and saves it to the registry. (Token should follow the ISecurityToken interface)
Arguments
Name | Type | Description |
_name | string | Name of the token |
_ticker | string | Ticker of the security token |
_owner | address | Owner of the token |
_securityToken | address | Address of the securityToken |
_tokenDetails | string | Off-chain details of the token |
_deployedAt | uint256 | Timestamp at which security token comes deployed on the ethereum blockchain |
modifyExistingSecurityToken
Adds a new custom Security Token and saves it to the registry. (Token should follow the ISecurityToken interface)
Arguments
Name | Type | Description |
_ticker | string | is the ticker symbol of the security token |
_owner | address | is the owner of the token |
_securityToken | address | is the address of the securityToken |
_tokenDetails | string | is the off-chain details of the token |
_deployedAt | uint256 | is the timestamp at which the security token is deployed |
modifyExistingTicker
Modifies the ticker details. Only Polymath has the ability to do so.
Arguments
Name | Type | Description |
_owner | address | is the owner of the token |
_ticker | string | is the token ticker |
_registrationDate | uint256 | is the date at which ticker is registered |
_expiryDate | uint256 | is the expiry date for the ticker |
_status | bool | is the token deployment status |
registerTicker
Registers the token ticker for its particular owner
Arguments
Name | Type | Description |
_owner | address | Address of the owner of the token |
_ticker | string | Token ticker |
_tokenName | string | Name of the token |
registerNewTicker
Registers the token ticker to the selected owner
Arguments
Name | Type | Description |
_owner | address | is address of the owner of the token |
_ticker | string | is unique token ticker |
isSecurityToken
Check that Security Token is registered
Returns
bool
Arguments
Name | Type | Description |
_securityToken | address | Address of the Scurity token |
transferOwnership
Allows the current owner to transfer control of the contract to a newOwner.
Arguments
Name | Type | Description |
_newOwner | address | The address to transfer ownership to. |
getSecurityTokenAddress
Get security token address by ticker name
Returns
address
Arguments
Name | Type | Description |
_ticker | string | Symbol of the Scurity token |
getSecurityTokenData
Returns the security token data by address
Returns
string is the ticker of the security Token.
Arguments
Name | Type | Description |
_securityToken | address | is the address of the security token. |
getSTFactoryAddress
Get the current STFactory Address
Arguments
Name | Type | Description |
getSTFactoryAddressOfVersion
Returns the STFactory Address of a particular version
Arguments
Name | Type | Description |
_protocolVersion | uint256 | Packed protocol version |
getLatestProtocolVersion
Get Protocol version
Arguments
Name | Type | Description |
getTickersByOwner
Used to get the ticker list as per the owner
Arguments
Name | Type | Description |
_owner | address | Address which owns the list of tickers |
getTokensByOwner
Returns the list of tokens owned by the selected address
Arguments
Name | Type | Description |
_owner | address | is the address which owns the list of tickers |
getTokens
Returns the list of all tokens
Arguments
Name | Type | Description |
getTickerDetails
Returns the owner and timestamp for a given ticker
Returns
address
Arguments
Name | Type | Description |
_ticker | string | ticker |
modifyTicker
Modifies the ticker details. Only polymath account has the ability to do so. Only allowed to modify the tickers which are not yet deployed
Arguments
Name | Type | Description |
_owner | address | Owner of the token |
_ticker | string | Token ticker |
_tokenName | string | Name of the token |
_registrationDate | uint256 | Date on which ticker get registered |
_expiryDate | uint256 | Expiry date of the ticker |
_status | bool | Token deployed status |
removeTicker
Removes the ticker details and associated ownership & security token mapping
Arguments
Name | Type | Description |
_ticker | string | Token ticker |
transferTickerOwnership
Transfers the ownership of the ticker
Arguments
Name | Type | Description |
_newOwner | address | |
_ticker | string |
changeExpiryLimit
Changes the expiry time for the token ticker
Arguments
Name | Type | Description |
_newExpiry | uint256 | New time period for token ticker expiry |
changeTickerRegistrationFee
Sets the ticker registration fee in USD tokens. Only Polymath.
Arguments
Name | Type | Description |
_tickerRegFee | uint256 | is the registration fee in USD tokens (base 18 decimals) |
changeSecurityLaunchFee
Sets the ticker registration fee in USD tokens. Only Polymath.
Arguments
Name | Type | Description |
_stLaunchFee | uint256 | is the registration fee in USD tokens (base 18 decimals) |
changeFeesAmountAndCurrency
Sets the ticker registration and ST launch fee amount and currency
Arguments
Name | Type | Description |
_tickerRegFee | uint256 | is the ticker registration fee (base 18 decimals) |
_stLaunchFee | uint256 | is the st generation fee (base 18 decimals) |
_isFeeInPoly | bool | defines if the fee is in poly or usd |
setProtocolFactory
Changes the SecurityToken contract for a particular factory version
Arguments
Name | Type | Description |
_STFactoryAddress | address | is the address of the proxy. |
_major | uint8 | Major version of the proxy. |
_minor | uint8 | Minor version of the proxy. |
_patch | uint8 | Patch version of the proxy |
removeProtocolFactory
Removes a STFactory
Arguments
Name | Type | Description |
_major | uint8 | Major version of the proxy. |
_minor | uint8 | Minor version of the proxy. |
_patch | uint8 | Patch version of the proxy |
setLatestVersion
Changes the default protocol version
Arguments
Name | Type | Description |
_major | uint8 | Major version of the proxy. |
_minor | uint8 | Minor version of the proxy. |
_patch | uint8 | Patch version of the proxy |
updatePolyTokenAddress
Changes the PolyToken address. Only Polymath.
Arguments
Name | Type | Description |
_newAddress | address | is the address of the polytoken. |
updateFromRegistry
Used to update the polyToken contract address
Arguments
Name | Type | Description |
getSecurityTokenLaunchFee
Gets the security token launch fee
Returns
Fee amount
Arguments
Name | Type | Description |
getTickerRegistrationFee
Gets the ticker registration fee
Returns
Fee amount
Arguments
Name | Type | Description |
setGetterRegistry
Set the getter contract address
Arguments
Name | Type | Description |
_getterContract | address | Address of the contract |
getFees
Returns the usd & poly fee for a particular feetype
Arguments
Name | Type | Description |
_feeType | bytes32 | Key corresponding to fee type |
getTokensByDelegate
Returns the list of tokens to which the delegate has some access
Arguments
Name | Type | Description |
_delegate | address | is the address for the delegate |
getExpiryLimit
Gets the expiry limit
Returns
Expiry limit
Arguments
Name | Type | Description |
getTickerStatus
Gets the status of the ticker
Returns
bool
Arguments
Name | Type | Description |
_ticker | string | Ticker whose status need to determine |
getIsFeeInPoly
Gets the fee currency
Returns
true = poly, false = usd
Arguments
Name | Type | Description |
getTickerOwner
Gets the owner of the ticker
Returns
address Address of the owner
Arguments
Name | Type | Description |
_ticker | string | Ticker whose owner need to determine |
isPaused
Checks whether the registry is paused or not
Returns
bool
Arguments
Name | Type | Description |
pause
Called by the owner to pause, triggers stopped state
Arguments
Name | Type | Description |
unpause
Called by the owner to unpause, returns to normal state
Arguments
Name | Type | Description |
reclaimERC20
Reclaims all ERC20Basic compatible tokens
Arguments
Name | Type | Description |
_tokenContract | address | is the address of the token contract |
owner
Gets the owner of the contract
Returns
address owner
Arguments
Name | Type | Description |
tickerAvailable
Checks if the entered ticker is registered and has not expired
Returns
bool
Arguments
Name | Type | Description |
_ticker | string | is the token ticker |
Last updated