migrate content to format for new docs site
Squashed commit of the following:
commit fcf35eb806100de300bd9803ce3150dde1ecc424
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 17 17:16:04 2019 -0300
remove all docsite dependency
commit eeaee9a9d43d70704f6ab17b5126ddbd52b93a50
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 17 17:15:23 2019 -0300
update solidity-docgen
commit f021ff951829ea0c155186749819403c6b76e803
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 17 17:05:06 2019 -0300
update docsite script for new setup
commit ff887699d381cfbbe3acf1f1c0de8e22b58480f3
Merge: c938aa1d 84f85a41
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 17 16:46:46 2019 -0300
Merge branch 'master' into antora
commit c938aa1d9ed05ac83a34e2cebd8353f8331ad6d6
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jul 16 18:24:29 2019 -0300
make component name shorter
commit 5bbd6931e02cbbd8864c82655ad0f390ceead5f3
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 20:16:17 2019 -0300
add all info to docs templates
commit 39682c4515d7cf0f0368ed557f50d2709174208a
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 20:13:49 2019 -0300
fix npm docsite script
commit 7ae46bd4a0437abf66150d54d05adf46e3de2cab
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 18:48:05 2019 -0300
convert inline docs to asciidoc
commit cfdfd3dee4b4bf582fde22c8cb6e17a603d6e0c8
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 17:34:52 2019 -0300
add missing contract names in readmes
commit 15b6a2f9bfb546cf1d3bf4f104278b118bf1b3f4
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 17:16:47 2019 -0300
fix script path
commit 80d82b909f9460d1450d401f00b3f309da506b29
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 17:13:53 2019 -0300
update version of solidity-docgen
commit a870b6c607b9c2d0012f8a60a4ed1a1c8b7e8ebd
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 17:03:53 2019 -0300
add nav generation of api ref
commit 069cff4a25b83752650b54b86d85608c2f547e5e
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Wed Jul 10 16:32:14 2019 -0300
initial migration to asciidoc and new docgen version
commit 55216eed0a6551da913c8d1da4b2a0d0d3faa1a8
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 20:39:35 2019 -0300
add basic api doc example
commit 0cbe50ce2173b6d1d9a698329d91220f58822a53
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 19:31:31 2019 -0300
add sidebars
commit 256fc942845307258ac9dc25aace48117fa10f79
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 15:22:38 2019 -0300
add page titles
commit f4d0effa70e1fc0662729863e8ee72a8821bc458
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 15:19:41 2019 -0300
add contracts index file
commit b73b06359979f7d933df7f2b283c50cb1c31b2a0
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 15:14:52 2019 -0300
fix header levels
commit fb57d9b820f09a1b7c04eed1a205be0e45866cac
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 15:11:47 2019 -0300
switch format to preferred asciidoctor format
commit 032181d8804137332c71534753929d080a31a71f
Author: Francisco Giordano <frangio.1@gmail.com>
Date: Tue Jun 25 15:05:38 2019 -0300
initialize antora component and convert docs to asciidoc
This commit is contained in:
@ -12,7 +12,7 @@ import "../math/SafeMath.sol";
|
||||
* an amount proportional to the percentage of total shares they were assigned.
|
||||
*
|
||||
* `PaymentSplitter` follows a _pull payment_ model. This means that payments are not automatically forwarded to the
|
||||
* accounts but kept in this contract, and the actual transfer is triggered as a separate step by calling the `release`
|
||||
* accounts but kept in this contract, and the actual transfer is triggered as a separate step by calling the {release}
|
||||
* function.
|
||||
*/
|
||||
contract PaymentSplitter {
|
||||
@ -47,13 +47,13 @@ contract PaymentSplitter {
|
||||
}
|
||||
|
||||
/**
|
||||
* @dev The Ether received will be logged with `PaymentReceived` events. Note that these events are not fully
|
||||
* @dev The Ether received will be logged with {PaymentReceived} events. Note that these events are not fully
|
||||
* reliable: it's possible for a contract to receive Ether without triggering this function. This only affects the
|
||||
* reliability of the events, and not the actual splitting of Ether.
|
||||
*
|
||||
* To learn more about this see the Solidity documentation for [fallback functions].
|
||||
*
|
||||
* [fallback functions]: https://solidity.readthedocs.io/en/latest/contracts.html#fallback-function
|
||||
* To learn more about this see the Solidity documentation for
|
||||
* https://solidity.readthedocs.io/en/latest/contracts.html#fallback-function[fallback
|
||||
* functions].
|
||||
*/
|
||||
function () external payable {
|
||||
emit PaymentReceived(msg.sender, msg.value);
|
||||
|
||||
@ -5,7 +5,7 @@ import "./escrow/Escrow.sol";
|
||||
/**
|
||||
* @title PullPayment
|
||||
* @dev Base contract supporting async send for pull payments. Inherit from this
|
||||
* contract and use _asyncTransfer instead of send or transfer.
|
||||
* contract and use {_asyncTransfer} instead of send or transfer.
|
||||
*/
|
||||
contract PullPayment {
|
||||
Escrow private _escrow;
|
||||
|
||||
17
contracts/payment/README.adoc
Normal file
17
contracts/payment/README.adoc
Normal file
@ -0,0 +1,17 @@
|
||||
= Payment
|
||||
|
||||
NOTE: This page is incomplete. We're working to improve it for the next release. Stay tuned!
|
||||
|
||||
== Utilities
|
||||
|
||||
{{PaymentSplitter}}
|
||||
|
||||
{{PullPayment}}
|
||||
|
||||
== Escrow
|
||||
|
||||
{{Escrow}}
|
||||
|
||||
{{ConditionalEscrow}}
|
||||
|
||||
{{RefundEscrow}}
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
sections:
|
||||
- title: Payment Utilities
|
||||
contracts:
|
||||
- PaymentSplitter
|
||||
- PullPayment
|
||||
- subdirectory: escrow
|
||||
---
|
||||
|
||||
> This page is incomplete. We're working to improve it for the next release. Stay tuned!
|
||||
@ -5,7 +5,7 @@ import "./Escrow.sol";
|
||||
/**
|
||||
* @title ConditionalEscrow
|
||||
* @dev Base abstract escrow to only allow withdrawal if a condition is met.
|
||||
* @dev Intended usage: See Escrow.sol. Same usage guidelines apply here.
|
||||
* @dev Intended usage: See {Escrow}. Same usage guidelines apply here.
|
||||
*/
|
||||
contract ConditionalEscrow is Escrow {
|
||||
/**
|
||||
|
||||
@ -7,10 +7,11 @@ import "../../ownership/Secondary.sol";
|
||||
* @title Escrow
|
||||
* @dev Base escrow contract, holds funds designated for a payee until they
|
||||
* withdraw them.
|
||||
* @dev Intended usage: This contract (and derived escrow contracts) should be a
|
||||
*
|
||||
* Intended usage: This contract (and derived escrow contracts) should be a
|
||||
* standalone contract, that only interacts with the contract that instantiated
|
||||
* it. That way, it is guaranteed that all Ether will be handled according to
|
||||
* the Escrow rules, and there is no need to check for payable functions or
|
||||
* the `Escrow` rules, and there is no need to check for payable functions or
|
||||
* transfers in the inheritance tree. The contract that uses the escrow as its
|
||||
* payment method should be its primary, and provide public methods redirecting
|
||||
* to the escrow's deposit and withdraw.
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
---
|
||||
title: Escrows
|
||||
sections:
|
||||
- contracts:
|
||||
- Escrow
|
||||
- ConditionalEscrow
|
||||
- RefundEscrow
|
||||
---
|
||||
@ -6,12 +6,12 @@ import "./ConditionalEscrow.sol";
|
||||
* @title RefundEscrow
|
||||
* @dev Escrow that holds funds for a beneficiary, deposited from multiple
|
||||
* parties.
|
||||
* @dev Intended usage: See Escrow.sol. Same usage guidelines apply here.
|
||||
* @dev Intended usage: See {Escrow}. Same usage guidelines apply here.
|
||||
* @dev The primary account (that is, the contract that instantiates this
|
||||
* contract) may deposit, close the deposit period, and allow for either
|
||||
* withdrawal by the beneficiary, or refunds to the depositors. All interactions
|
||||
* with RefundEscrow will be made through the primary contract. See the
|
||||
* RefundableCrowdsale contract for an example of RefundEscrow’s use.
|
||||
* with `RefundEscrow` will be made through the primary contract. See the
|
||||
* `RefundableCrowdsale` contract for an example of `RefundEscrow`’s use.
|
||||
*/
|
||||
contract RefundEscrow is ConditionalEscrow {
|
||||
enum State { Active, Refunding, Closed }
|
||||
|
||||
Reference in New Issue
Block a user