Skip to content
This repository has been archived by the owner on Dec 8, 2019. It is now read-only.

Commit

Permalink
formatting, closes #48
Browse files Browse the repository at this point in the history
  • Loading branch information
iamdefinitelyahuman committed Feb 1, 2019
1 parent 04942f4 commit 8b47c10
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/custodian.rst
Expand Up @@ -51,9 +51,9 @@ During an inbound transfer the following method is be called in the custodian co

.. method:: IMiniCustodian.receiveTransfer(address _token, bytes32 _id, uint256 _value)

``_token``: Token addresss being transferred to the the Custodian.
``_id``: Sender ID.
``_value``: Amount being transferred.
* ``_token``: Token addresss being transferred to the the Custodian.
* ``_id``: Sender ID.
* ``_value``: Amount being transferred.

Called from ``IssuingEntity.transferTokens``. Used to update the custodian's balance and investor counts. Revert or return ``false`` to block the transfer.

Expand Down Expand Up @@ -102,23 +102,23 @@ The ``IMiniCustodian`` interface defines a minimal implementation required for c

View function to query the balance of an investor for a specific token.

``_token``: SecurityToken address
``_id``: Investor ID
* ``_token``: SecurityToken address
* ``_id``: Investor ID

While there is no strict requirement for a Custodian to maintain an on-chain record of investor balances, this information is necessary if the custodian is to e.g. allow investors to claim dividends or exercise voting rights based on held balances. As such, balances should always be accurately recorded on-chain unless there is a use case that requires otherwise.

.. method:: IMiniCustodian.isBeneficialOwner(address _issuer, bytes32 _id)

Checks if an investor is on the custodian's list of beneficial owners for this issuer.

``_issuer``: IssuingEntity contract address
``_id``: Investor ID
* ``_issuer``: IssuingEntity contract address
* ``_id``: Investor ID

.. method:: IMiniCustodian.receiveTransfer(address _token, bytes32 _id, uint256 _value)

``_token``: Token addresss being transferred to the the Custodian.
``_id``: Sender ID.
``_value``: Amount being transferred.
* ``_token``: Token addresss being transferred to the the Custodian.
* ``_id``: Sender ID.
* ``_value``: Amount being transferred.

Called from ``IssuingEntity.transferTokens`` when tokens are being sent into the Custodian contract. It should be used to update the custodian's balance and investor counts. Revert or return ``false`` to block the transfer.

Expand Down

0 comments on commit 8b47c10

Please sign in to comment.