From cc99d636650d20a35a446d16f2b81d1fa8a2dabd Mon Sep 17 00:00:00 2001 From: Chris Ward Date: Mon, 7 Jan 2019 17:49:34 +0100 Subject: [PATCH] Split interfaces into new file --- docs/contracts.rst | 38 +---------------------------------- docs/contracts/interfaces.rst | 36 +++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 37 deletions(-) create mode 100644 docs/contracts/interfaces.rst diff --git a/docs/contracts.rst b/docs/contracts.rst index 7f7d821a3..2a397f6d5 100644 --- a/docs/contracts.rst +++ b/docs/contracts.rst @@ -534,43 +534,7 @@ converted to ``uint8``. .. include:: contracts/inheritance.rst .. include:: contracts/abstract-contracts.rst - -.. index:: ! contract;interface, ! interface contract - -.. _interfaces: - -********** -Interfaces -********** - -Interfaces are similar to abstract contracts, but they cannot have any functions implemented. There are further restrictions: - -- They cannot inherit other contracts or interfaces. -- All declared functions must be external. -- They cannot declare a constructor. -- They cannot declare state variables. - -Some of these restrictions might be lifted in the future. - -Interfaces are basically limited to what the Contract ABI can represent, and the conversion between the ABI and -an interface should be possible without any information loss. - -Interfaces are denoted by their own keyword: - -:: - - pragma solidity ^0.5.0; - - interface Token { - enum TokenType { Fungible, NonFungible } - struct Coin { string obverse; string reverse; } - function transfer(address recipient, uint amount) external; - } - -Contracts can inherit interfaces as they would inherit other contracts. - -Types defined inside interfaces and other contract-like structures -can be accessed from other contracts: ``Token.TokenType`` or ``Token.Coin``. +.. include:: contracts/interfaces.rst .. index:: ! library, callcode, delegatecall diff --git a/docs/contracts/interfaces.rst b/docs/contracts/interfaces.rst new file mode 100644 index 000000000..b551b5184 --- /dev/null +++ b/docs/contracts/interfaces.rst @@ -0,0 +1,36 @@ +.. index:: ! contract;interface, ! interface contract + +.. _interfaces: + +********** +Interfaces +********** + +Interfaces are similar to abstract contracts, but they cannot have any functions implemented. There are further restrictions: + +- They cannot inherit other contracts or interfaces. +- All declared functions must be external. +- They cannot declare a constructor. +- They cannot declare state variables. + +Some of these restrictions might be lifted in the future. + +Interfaces are basically limited to what the Contract ABI can represent, and the conversion between the ABI and +an interface should be possible without any information loss. + +Interfaces are denoted by their own keyword: + +:: + + pragma solidity ^0.5.0; + + interface Token { + enum TokenType { Fungible, NonFungible } + struct Coin { string obverse; string reverse; } + function transfer(address recipient, uint amount) external; + } + +Contracts can inherit interfaces as they would inherit other contracts. + +Types defined inside interfaces and other contract-like structures +can be accessed from other contracts: ``Token.TokenType`` or ``Token.Coin``.