Giters

a10000005588 / emotoScript

web3 for emoto project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Emobile Project Contract Script

Development Setting

  1. Do npm install first. To install packages for project.

  2. Using testrpc to build a test ethereum blockchain. such as... ganche-cli

  3. Setting testing account In /data/config.js setting your account address 、privateKey、 contracts address..

  4. Then, in the emobileScript, run script with... ./node_modules/.bin/babel-node test.js

Project API Information

Provide the API for emobile frontend:

https://xd.adobe.com/spec/e801fb67-7a04-4539-9ddf-a9d57bafcd04/#screen/9cee957f-3e26-4721-8b4b-84d7c96ba46d/%E6%88%91%E7%9A%84%E9%92%B1%E5%8C%85

API Spec for emobile App.

It's API spec for emobile web app.

Base URL:

127.0.0.1:3000

Usage

Emobile API

data collection for emobiles.

link

  • GET: /
GET:  /api/emoto                                  // 列出所有 emoto 資訊
GET:  /api/emoto/:hash                            // 以 hash 取得 emoto 資訊
GET:  /api/emoto/:hash/calculateServiceFee        // 計算用戶搭車行駛費用

Driver API

data collection for emobiles.

link

  • GET: /
GET:  /api/driver                   // 列出所有driver資訊
GET:  /api/driver/:hash             // 列出對應hash的driver資訊
POST:  /api/driver/:hash/payment/user/:userHash     // 給予費用並且給予driver評價

# Emobile API

# getAllEmoto

列出所有 emoto 資訊.

URL : /api/emoto

Method : GET

Auth required : NO

Permissions required : None

Data constraints

(None)

Data example:

(None)

Success Response

Condition : If everything is OK and server available.

Content example

[{
    "method": "getAllEmotoInformation",
    "emotoAddress": "0x83af6976832d90e5693a9b5a7b29fac4a28de801",
    "plate": "ACX-9999",
    "driverName": "王小明",
    "driverAddress": "0x83af6976832d90e5693a9b5a7b29fac4a28de801",
    "isLock": false,
 ** "mileage": 20  (km),
    "createDate": "2018-01-01",
]}, {
    "method": "getAllEmotoInformation",
    "emotoAddress": "0xe635dead34fdd0c8c1eaa621647084732b4b23db",
    "plate": "BBS-9999",
    "driverName": "汪大東",
    "driverAddress": "0x65d09d72e2ca19b7fad0a5d6cec6909e3b379214",
    "isLock": false,
 ** "mileage": 39  (km),
    "createDate": "2018-01-01",
},...
]

Error Responses

Condition : If fields has wrong format or miss fields.

Content example :

{
    "result": false,
    "message": "",
}

Or

Condition : If server unavailable.

Code : 500 Internal Server Error

Content example

{
    "errors": "Internal Server Error."
}

# getEmoto

以 hash 取得 emobile 資訊.

URL : /api/emoto/:hash

Method : GET

Auth required : NO

Permissions required : None

URL constraints

 "hash": byte64

URL example:

/api/emoto/0x83af6976832d90e5693a9b5a7b29fac4a28de801

Data constraints

(None)

Data example:

(None)

Success Response

Condition : If everything is OK and server available.

Content example

{
    "method": "getEmotoInformation",
    "emotoAddress": "0x83af6976832d90e5693a9b5a7b29fac4a28de801",
    "plate": "ACX-9999",
    "driverName": "王小明",
    "driverAddress": "0x83af6976832d90e5693a9b5a7b29fac4a28de801",
    "isLock": false,
 ** "mileage": 20  (km),
    "createDate": "2018-01-01",
}

Error Responses

Condition : If fields has wrong format or miss fields.

Content example :

{
    "result": false,
    "message": "",
}

Or

Condition : If server unavailable.

Code : 500 Internal Server Error

Content example

{
    "errors": "Internal Server Error."
}

# calculateServiceFee

計算用戶搭車行駛費用 assume 1 km per 0.01 ether.

URL : /api/emoto/:hash/caculateFee

Method : POST

Auth required : NO

Permissions required : None

URL constraints

 "hash": byte64

URL example:

/api/emoto/0x83af6976832d90e5693a9b5a7b29fac4a28de801/calcuateServiceFee

Data constraints

{
    "emotoType": string,
    "createDate": date,
    "longitude": float, //經度
    "latitude": float, //緯度
    "distance": float, // km
}

Data example:

{
    "emotoType": "gogoro2",
    "createDate": "2018-01-01",
    "longitude": 121.525, //經度
    "latitude": 25.0392, //緯度
    "distance": 1.5 , //本次搭乘里程數
}

Success Response

Condition : If everything is OK and server available.

Content example

{
    "method": "calcuateServiceFee",
    "emotoAddress": "0x83af6976832d90e5693a9b5a7b29fac4a28de801",
    "plate": "ACX-9999",
    "driverName": "王小明",
    "driverAddress": "0x66ef6976832d90e5693a9b5a7b29fac4a28de801",
 ** "mileage": 1.5  (km),
    "fee": 0.05 , (ether)
}

Error Responses

Condition : If fields has wrong format or miss fields.

Content example :

{
    "result": false,
    "message": "something wrong",
}

Or

Condition : If server unavailable.

Code : 500 Internal Server Error

Content example

{
    "errors": "Internal Server Error."
}

# Driver API

# getAllDriver

列出所有司機資訊.

URL : /api/driver

Method : GET

Auth required : NO

Permissions required : None

URL constraints

(None)

URL example:

/api/driver

Data constraints

(None)

Data example:

(None)

Success Response

Condition : If everything is OK and server available.

Content example

[{
  "method": "getAllDriverInformation",
  "driverName": "王大陸",
  "creadit": 5,
  "driverAddress": "0xc159e38b17d5aa46dc7fc61778222a8c485f6b81",
  "mobileAddress": "0x149da1ece68b906947416cbb34aa778dfa15e56c",

},{
  "method": "getAllDriverInformation",
  "driverName": "王二陸",
  "creadit": 10,
  "driverAddress": "0x85cbae24f7ebd6537128f5d51f29c3d60dea8e07",
  "mobileAddress": "0x149da1ec1128b906947416cbb34aa778dfa15e56c",
}]

Error Responses

Condition : If fields has wrong format or miss fields.

Content example :

{
    "result": false,
    "message": "",
}

Or

Condition : If server unavailable.

Code : 500 Internal Server Error

Content example

{
    "errors": "Internal Server Error."
}

# getDriver

列出該hash的司機資訊.

URL : /api/driver/:hash

Method : GET

Auth required : NO

Permissions required : None

URL constraints

{
  "hash": bytes64
}

URL example:

/api/driver/0xc159e38b17d5aa46dc7fc61778222a8c485f6b81

Data constraints

(None)

Data example:

(None)

Success Response

Condition : If everything is OK and server available.

Content example

{
  "method": "getDriverInformation",
  "driverName": "�毛小聖",
  "creadit": 5,
  "driverAddress": "0xc159e38b17d5aa46dc7fc61778222a8c485f6b81",
  "mobileAddress": "0x149da1ece68b906947416cbb34aa778dfa15e56c",
  "phone": "09-12345678"
}

Error Responses

Condition : If fields has wrong format or miss fields.

Content example :

{
    "result": false,
    "message": "",
}

Or

Condition : If server unavailable.

Code : 500 Internal Server Error

Content example

{
    "errors": "Internal Server Error."
}

# createPayment

給予費用並且給予driver評價.

URL : /api/driver/:hash/payment/user/:userHash

Method : POST

Auth required : NO

Permissions required : None

URL constraints

{
    "hash": bytes64
}

URL example:

/api/driver/0xc159e38b17d5aa46dc7fc61778222a8c485f6b81/payment/user/0x4444e38b17d5aa46dc7fc61778222a8c485f6b81

Data constraints

{
    "driverName": string,
    "userName": string,
    "fee": float,
    "credit" : int
}

Data example:

{
    "driverAddress": "0xc159e38b17d5aa46dc7fc61778222a8c485f6b81",
    "driverName": "王大陸",
    "userName": "王小明",
    "userAddress": "0x0a68808f5803882e69e66804c75172c873a09f24",
    "fee": 0.15,
    "credit" : 5
}

Success Response

Condition : If everything is OK and server available.

Content example

{
    "method": "createPayment",
    "driverName": "�王大陸",
    "userName": "王小明",
    "userAddress": "0x0a68808f5803882e69e66804c75172c873a09f24",
    "credit": 4.3,
    "driverAddress": "0xc159e38b17d5aa46dc7fc61778222a8c485f6b81",
    "mobileAddress": "0x149da1ece68b906947416cbb34aa778dfa15e56c",
    "transactionReceipt": "0x4bc88c0931fcad30620ced2b049bb3a682991faa62b4e30f32668dc3501c2eeb"
}

Error Responses

Condition : If fields has wrong format or miss fields.

Content example :

{
    "result": false,
    "message": "",
}

Or

Condition : If server unavailable.

Code : 500 Internal Server Error

Content example

{
    "errors": "Internal Server Error."
}

About

web3 for emoto project

Languages

Language:JavaScript 100.0%