【Solidity入門】まず最初にSolidityで覚えるべき基本構文まとめ

# 前提知識

・Blockchain、Ethereum、Smart Contract 等の概念的理解
・基本的なプログラミングスキル


▼Solidity環境構築はこちらを参考にしました！▼
[Ethereum スマートコントラクト入門：geth のインストールから Hello World まで](https://qiita.com/amachino/items/b59ec8e46863ce2ebd4a)


# Solidityとは
スマートコントラクトを開発するために生まれたJavaScriptライクな静的型付け言語。
スマートコントラクトの開発では、現在最も利用されている言語でデファクトスタンダードと言える。

・大文字小文字は区別する
・文（Statement）最後にはセミコロン


# 基本記法

以下は、「Hello World!」と表示させるだけの簡単なプログラム。
このプログラムを例に簡単に説明していきます。

```.js
// 冒頭でsolidityのバージョンを指定する。
pragma solidity ^0.6.7;

// contractという大きな入れ物を定義。ここに関数や変数を指定する。
contract Hello {

    string public productname='Hello World';

    // 関数定義
    function setname (string memory name1) public {
        productname = name1;
    }

    // 関数定義
    function getname () public view returns (string memory) {
        return productname;
    }
}
```
ここでは、バージョン「`0.6.7`」を指定することで,Solidityのバージョン番号が0.6.7未満ではコンパイルせず、`^`で0.6.7以上でも動作しないことを宣言している。




- `contract`でコントラクトを定義

（ Solidityで作成するコントラクトは、ブロックチェーン上のコントラクトアドレスが保持するコードとデータの集合からできている。）

 
```
contract Contract名 {
   //スマート・コントラクトで行う処理をここに記述
} 
```
- `function`で関数定義
 - 戻り値がある場合→明示にデータ型を定義する必要がある
 - 戻り値がない場合→定義なし


ちなみにコメントアウトはJavaScriptと同じで、
`// 一行コメントはこんな感じ`

`/* 
   複数行コメントはこういう感じ
   */ 
`

#  データ型

|     カテゴリ     　　|     定義          |    意味              |
|:-------------------|:------------------|:------------------|
|     値型        |bool 　　　      | 論理型    |
|                  |int                |符号付き整数|
|                  |   uint      |        符合なし整数        |
|                  |   string |        文字列型        |
|                  |      address　　　　　　 |         アドレス専用のデータ型   |
|                  |   bytes |         バイト配列         |
|                  |    enum　　　　　　　　 |       列挙       |
|                  |   function |           関数   |
|     参照型        |     array |      配列（固定・可変）      |
|                  |  structs |           構造体   |
|     その他        |    mapping |           マッピング   |


### 値型
Solidityの値型では、変数に指定した値が直接メモリ領域に確保され、値そのものが変数に代入される。

### 参照型
「値を格納するメモリ上のアドレス」が変数に代入される。

また、参照型は、**データの保存場所(Data location)**　という概念がある。

# データの保存場所(Data location)
### ・memoryとstorage
明示しない場合は、デフォルトのデータ保存場所が使用されるが、明示することでオーバーライドできる。関数の戻り値のデフォルトは`memory`、ローカル変数として宣言した場合は`storage`。

・`memory`の場合は、処理中だけ保持され、終わったら保持されない
・`storage`の場合は、処理後、ブロックチェーンに保持される



下記はstorageとmemoryを使ったサンプルコード。ここの内容が理解できればstorageとmemoryは理解したと言って大丈夫かと思う。

```.js
contract BookFactory {
  struct Book {
    string name;
    string status;
  }
 
  Book[] books;
 
  function getBook(uint _index) public {
    // この場合、コンパイラがstorageかmemoryをつけてと注意してくれる
    // Book book1 = books[_index];
 
    // ブロックチェーンに書き込む場合
    // 要素への参照を渡しているのでブロックチェーンを更新できる
    Book storage book1 = books[_index];
    book1.status = "Read!";
 
    // 値のコピーにはmemoryを使う
    // memoryの値を変更してもブロックチェーンには書き込まれない
    Book memory book2 = books[_index + 1];
    book2.status = "Read!";
 
    // memoryを使ってブロックチェーンに書き込む
    books[_index] = book2;
  }
}
```

### ・第3のデータ位置、calldata
実はまた3個目の場所 `calldata` がある。外部に公開する関数の場合、そのパラメータに渡される値はこれに該当する。ほとんど `memory` と同じ動作になる。違うのは、値の変更は不可なところ。


なお、保存先を明示しない場合にstorageに保存されるか、memoryに一時的に保存されるかの判断は、下記の通り。


#### 強制されるデータの場合
・外部関数のパラメータ（戻り値ではない）：calldata
・状態変数：storage

####  デフォルトデータの場合
・関数のパラメータ（戻り値）：memory
・その他すべてのローカル変数：storage




# 基本構文まとめ


### ・演算
演算は基本的にJSなどと変わらない
加算（足し算）: x + y
減算（引き算）: x - y,
乗算（掛け算）: x * y
除算（割り算）: x / y
剰余（余り）: x % y
累乗：x ** y



### ・構造体
複雑なデータ型を作成できるように構造体が用意されている。

```.js

struct Person {
  uint age;
  string name;
}
```


### ・配列
固定長配列：配列の長さが決まっている

```
User [2] users;
```

可変長配列：配列の長さが決まっていない

```
User [] users;
```

構造体の配列も作れる

```.js
Person[] people;

//publicで宣言することによって、コントラクト内だけでなく、外部からも呼び出しが可能になる。裏を返せば、外部からの攻撃に晒される可能性が高い。
Person[] public people;
```

### ・関数の宣言
ex).stringとuintの２つのパラメータをもつ関数

```.js
function eatApples(string _impressions, uint _amount) {
//関数内の引数には、型指定をした後に「_hoge」のように頭にアンダースコア（_）を入力。
}

//関数を呼び出すときはこのように。
eatApples("yammy!", 10);
```

・関数はデフォルトでpublicとなっているためprivateにしたい場合は追記する
その際に関数を_（アンダースコア）から始めるようにする

### ・view関数とpure関数

```.js
function sayHello() public view returns (string) {
//view関数ではアプリ内のデータは読み取り専用になる。
}
function _greet(string _str) private pure returns (string) {
//pure関数ではアプリ内のデータそのものにアクセスできない。
```


### ・イベント
イベントとは、ブロックチェーンに何かが生じたときに、コントラクトとフロントエンドを接続するもの。

```.js
// イベントの宣言
event IntegersAdded(uint x, uint y, uint result);

function add(uint _x, uint _y) public {
  uint result = _x + _y;
  // 関数が呼ばれたことをアプリに伝えるためにイベントを発生させる：
  IntegersAdded(_x, _y, result);
  return result;
}
```


### ・マッピング（mapping）

Mappings（マッピング） データを格納する時に使う、配列のような機能。

```.js
// 金融系のアプリの場合、ユーザーのアカウントの残高にuintを格納する
mapping (address => uint) public accountBalance;
// もしくは、ユーザーIdを基にユーザー名を参照・格納するために使用する
mapping (uint => string) userIdToName;
```
マッピングは本質的にはデータの保管と参照のためのキーバリューストア。最初の例で言えば、キーは`address` で、バリュー（値）は`uint`。２番目の例だと、キーは `uint` で、バリューは `string`。


### ・msg.sender　
全ての関数で利用できるグローバル変数の１つ。関数を呼び出したユーザーのaddressを参照できる。

```.js
function getApple(uint _myApple) public {
  // mappingにデータを格納する。
  favoriteApple[msg.sender] = _myApple;
}
```

### ・require

require 条件を満たさない場合はエラーを投げて実行を止める。

```.js
function sayName(string _name) public returns (string) {
  // _nameが"Test"と同じかどうか比較する。真でなければエラーを吐いて終了させる。
  // Solidityはネイティブで文字列比較ができないため、文字列の比較をする際はkeccak256 を使ってハッシュ同士を比較する方法を使う。
  require(keccak256(_name) == keccak256("Test"));
  return "Hi!";
}
// sayName("Test")でこの関数を呼び出せた時のみ、"Hi!"と返ってくる。
```

### ・継承
contractの継承。クラスの継承とイメージは近い

```
contract 新しいコントラクト is 継承されるコントラクト {    
}
```

### ・import
別のファイルからの呼び出しを行いたい場合に利用

```.js
import "./hoge.sol";
// 同じ階層から呼び出す時は、ファイル名の冒頭に「./」をつける
```


### ・Interface
他人のコントラクトから関数を宣言することができる。
使うときは関数宣言の最後に;(セミコロン)を使う。（括弧などは利用しない）

```.js
contract KittyInterface  {
    function getKitty(uint256 _id) external view returns (

    bool isGestating,
    bool isReady,
    uint256 cooldownIndex,
    uint256 nextActionAt,
    uint256 siringWithId,
    uint256 birthTime,
    uint256 matronId,
    uint256 sireId,
    uint256 generation,
    uint256 genes
    );       
}
```
### ・条件分岐（if-else文）
JavaScriptの条件分岐（if-else文）の記述方法と類似した構成になる。

```
if (条件式a) { //条件式aがtrueならば命令aを実行
  命令a;
} else if(条件式b) { //条件式bがtrueならば命令bを実行
  命令b;
} else { //すべての条件式がfalseの時命令cを実行
  命令c;
}
```
solidityでは条件演算子は「`? : `」を使って記述することが出来る。

```
条件式 ? 条件がtrueの場合に行なう処理 : 条件がfalseの場合に行なう処理
```

### ・繰り返し処理（while文・do-while文・for文）

```
while(条件式a) { //条件式aが満たされている場合、繰り返し処理が続く。
  命令a;
}


do { //少なくとも1度は必ず処理が実行される
命令b;
} while(条件式b); //ここで条件式の検証が行われる


for (初期値;条件式;増減式) {
　　繰り返し処理
}
```



# 関数とステート変数のアクセス範囲定義
・`external`・・・コントラクトのインタフェースであり、他のコントラクトやトランザクションから呼び出せる。内部で直接に呼び出せない。 f()はだめで this.f() はOK

・`public`・・・コントラクトのインタフェースであり、内部か、メッセージ経由で呼び出せる。パブリックなステート変数の場合、自動的にgetter関数が生成される

・`internal`・・・現在のコントラクトまたは派生コントラクトから呼び出せる

・`private`・・・現在のコントラクトのみ呼び出せ、派生コントラクトから呼び出せない


# 単位とグローバル値
・1 ether == 10^8 wei
・時刻単位： 1 hour == 60 minutes

### ブロックチェーン周りのよく使うもの抜粋
・block.gaslimit (uint): 当該ブロックの gas limit
・block.number (uint): 当該ブロックの番号
・block.timestamp (uint): 当該ブロックのタイムスタンプ、秒数
・msg.sender (address): 当該呼び出しの呼び出し元アドレス
・now (uint): block.timestamp と同じ
・tx.gasprice (uint): 当該トランザクションの gas price


# 参考
▼圧倒的におすすめする著書
・<a target="_blank" href="https://www.amazon.co.jp/%25EF%25BC%25B3%25EF%25BD%258F%25EF%25BD%258C%25EF%25BD%2589%25EF%25BD%2584%25EF%25BD%2589%25EF%25BD%2594%25EF%25BD%2599%25E3%2583%2597%25E3%2583%25AD%25E3%2582%25B0%25E3%2583%25A9%25E3%2583%259F%25E3%2583%25B3%25E3%2582%25B0-%25E3%2583%2596%25E3%2583%25AD%25E3%2583%2583%25E3%2582%25AF%25E3%2583%2581%25E3%2582%25A7%25E3%2583%25BC%25E3%2583%25B3%25E3%2583%25BB%25E3%2582%25B9%25E3%2583%259E%25E3%2583%25BC%25E3%2583%2588%25E3%2582%25B3%25E3%2583%25B3%25E3%2583%2588%25E3%2583%25A9%25E3%2582%25AF%25E3%2583%2588%25E9%2596%258B%25E7%2599%25BA%25E5%2585%25A5%25E9%2596%2580-%25EF%25BC%25AB%25EF%25BC%25B3%25E6%2583%2585%25E5%25A0%25B1%25E7%25A7%2591%25E5%25AD%25A6%25E5%25B0%2582%25E9%2596%2580%25E6%259B%25B8-%25EF%25BC%25B2%25EF%25BD%2589%25EF%25BD%2594%25EF%25BD%2585%25EF%25BD%2593%25EF%25BD%2588%25EF%25BC%25AD%25EF%25BD%258F%25EF%25BD%2584%25EF%25BD%2589-ebook/dp/B0836T6LXX/ref=sr_1_4?__mk_ja_JP=%25E3%2582%25AB%25E3%2582%25BF%25E3%2582%25AB%25E3%2583%258A&amp;crid=1IN7WSK73L1R3&amp;keywords=solidity&amp;qid=1675943783&amp;sprefix=solidity%252Caps%252C277&amp;sr=8-4&_encoding=UTF8&tag=sho11hei12-22&linkCode=ur2&linkId=dbe77bc2964e8285fb7e04d12e1a9aad&camp=247&creative=1211">【Solidity】ブロックチェーン・スマートコントラクト開発入門</a>
・<a target="_blank" href="https://www.amazon.co.jp/%25E3%2583%2596%25E3%2583%25AD%25E3%2583%2583%25E3%2582%25AF%25E3%2583%2581%25E3%2582%25A7%25E3%2583%25BC%25E3%2583%25B3-dapp%25EF%25BC%2586%25E3%2582%25B2%25E3%2583%25BC%25E3%2583%25A0%25E9%2596%258B%25E7%2599%25BA%25E5%2585%25A5%25E9%2596%2580-Solidity%25E3%2581%25AB%25E3%2582%2588%25E3%2582%258B%25E3%2582%25A4%25E3%2583%25BC%25E3%2582%25B5%25E3%2583%25AA%25E3%2582%25A2%25E3%2583%25A0%25E5%2588%2586%25E6%2595%25A3%25E3%2582%25A2%25E3%2583%2597%25E3%2583%25AA%25E3%2583%2597%25E3%2583%25AD%25E3%2582%25B0%25E3%2583%25A9%25E3%2583%259F%25E3%2583%25B3%25E3%2582%25B0-Kedar-Iyer-ebook/dp/B07MXGY6XM/ref=sr_1_5?__mk_ja_JP=%25E3%2582%25AB%25E3%2582%25BF%25E3%2582%25AB%25E3%2583%258A&amp;crid=1IN7WSK73L1R3&amp;keywords=solidity&amp;qid=1675943783&amp;sprefix=solidity%252Caps%252C277&amp;sr=8-5&_encoding=UTF8&tag=sho11hei12-22&linkCode=ur2&linkId=d0ad5ef982b8dad6c7f4b3f941f944ae&camp=247&creative=1211">ブロックチェーン dapp＆ゲーム開発入門</a>
・<a target="_blank" href="https://www.amazon.co.jp/Ethereum%25EF%25BC%258BSolidity%25E5%2585%25A5%25E9%2596%2580-Web3-0%25E3%2582%2592%25E5%2588%2587%25E3%2582%258A%25E6%258B%2593%25E3%2581%258F%25E3%2583%2596%25E3%2583%25AD%25E3%2583%2583%25E3%2582%25AF%25E3%2583%2581%25E3%2582%25A7%25E3%2583%25BC%25E3%2583%25B3%25E3%2581%25AE%25E6%2580%259D%25E6%2583%25B3%25E3%2581%25A8%25E6%258A%2580%25E8%25A1%2593-impress-top-gear%25E3%2582%25B7%25E3%2583%25AA%25E3%2583%25BC%25E3%2582%25BA-ebook/dp/B07NNFLQ4D/ref=sr_1_1_sspa?__mk_ja_JP=%25E3%2582%25AB%25E3%2582%25BF%25E3%2582%25AB%25E3%2583%258A&amp;crid=1IN7WSK73L1R3&amp;keywords=solidity&amp;qid=1675943783&amp;sprefix=solidity%252Caps%252C277&amp;sr=8-1-spons&amp;psc=1&amp;spLa=ZW5jcnlwdGVkUXVhbGlmaWVyPUEzN0ZNTlBSWE1SSkpRJmVuY3J5cHRlZElkPUEwMDMwOTY5SUZMQkFIVlA1UlpSJmVuY3J5cHRlZEFkSWQ9QVhYVlQ3UVYwOVdaNiZ3aWRnZXROYW1lPXNwX2F0ZiZhY3Rpb249Y2xpY2tSZWRpcmVjdCZkb05vdExvZ0NsaWNrPXRydWU=&_encoding=UTF8&tag=sho11hei12-22&linkCode=ur2&linkId=80c6fb57f24a8b58eb339a7395177e7b&camp=247&creative=1211">Ethereum＋Solidity入門 Web3.0を切り拓く</a>

▼Qiita記事
・[スマートコントラクト開発の基本](https://qiita.com/YosukeAramaki/items/bfeb29b5a627bb2bb320)
・[何も分からないところからスタートするSolidity学習](https://qiita.com/shotashimura/items/0aeef9e722d33969afab)
・[Solidity 言語仕様　基本編](https://qiita.com/blueplanet/items/ecd3f4d5552e07e9ef2c)
・[Solidityの条件分岐（if-elseb文）、繰り返し処理（while文等）、イベントを紹介
](https://blockmania.jp/ethereum/320/)



# 最後に
以上、Solidityの基礎を簡単にまとめてみました。


「[CryptZombies](https://cryptozombies.io/jp/)」と呼ばれる、ゾンビバトルゲームでSolidityの基礎を無料で学べます。実際に使ってみましょう。

少しでも参考になれば、LGTMお願いします！