//tips
//smart contract
昨日触れたsafeMathのadd関数の中にpureが使われており、pureの使い方の確認にもなったので記載しておく。関数は状態を読み取ったり変更したりすることはできず、関数に渡された引数しか扱うことができない。viewと異なり、インスタンス変数(storage)の読み込みもできないので、関数の補助を行う機能としては最適なよう。
library SafeMath {
function add(uint256 a, uint256 b) internal pure returns (uint256) {
uint256 c = a + b;
assert(c >= a);
return c;
}
libraryはcontractとは若干異なり、usingを使うことがでる。
これはusing SafeMath for uint256;などを使うことで補助メソッド組み込めるよう。データ型の話もあったが、そこがこのuint256に統合されるのかの確認は後にしておく。
上記にあるように assert(c >= a);を加えることで、オーバーフローを防ぐ。
assertはrequireと同じで引数がfalseの場合、contractの実行を停止し、contractの状態を実行前に戻してから、使用しなかった残りのガスを呼び主にかえす。assertはガスの返却は全くしないので、requireを使った方がよさそう。住み分けとしては、基本的には外部からの入力値をチェックするのに使うのがrequire、内部エラーのテストと不変条件のチェックにはassertを使用するよう。
オーバーフローやアンダーフローを回避するため、コード中で+、-、*そして/を使った箇所を探し、SafeMathのadd、sub、mul、divで置きかえる。
++も使わない方が良かったよう。これは最新バージョンにも適用されることなのかは再度確認が必要。solidity ^0.4.19;の話だが今はsolidity ^0.8あたりが使われているのではないかと思う。
ただ、バージョンは違えどもこのようなリスクがあることは認識しておいて損はない。
先に疑問に思ったuint16とuint32への適用だが、やはりでオーバーフローなどを回避できないので、さらに２つのライブラリSafeMath16、SafeMath32を実装することが必要だった。
Solidityのコミュニティでのコメントアウト方式についても確認。
ただ、//でのコメントアウトだけではなく、natspec というフォーマットに基づいてコメントするのがベースとのこと。
@title、author、@notice(ユーザー に、コントラクトや関数が何を行うか説明)、@dev(開発者向けの詳細)、@paramと@return(関数の各パラメーターが何であり、どんな値を返すのか)
少なくとも@devタグで各関数の働きを説明することは大切なよう。これらも頭に入れながら開発をおこなう。
