https://github.com/iotexproject/iotex-proto
Protobuf definition for IoTeX transactions, blocks, chain and APIs!
https://github.com/iotexproject/iotex-proto
Last synced: about 1 year ago
JSON representation
Protobuf definition for IoTeX transactions, blocks, chain and APIs!
- Host: GitHub
- URL: https://github.com/iotexproject/iotex-proto
- Owner: iotexproject
- License: apache-2.0
- Created: 2019-05-03T20:45:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T22:32:16.000Z (over 1 year ago)
- Last Synced: 2025-05-08T22:08:51.854Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 1.04 MB
- Stars: 11
- Watchers: 10
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# iotex-proto
Protobuf and utility package for IoTeX blockchain transaction and gRPC API
- `\proto` includes protobuf definition for all core data objects and gRPC API used by IoTeX blockchain
- `\golang` includes the generated protobuf files for go language
# Getting Started
## Installing
### Install protoc
Install the Google protocol buffers compiler `protoc` v3.12.0 or above from https://github.com/protocolbuffers/protobuf/releases
Install protoc-gen-go
```
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
```
Enable go mod. Install grpc-gateway https://github.com/grpc-ecosystem/grpc-gateway. Basically this is what you need:
```
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
```
### Install mockgen
Install golang mock generator `mockgen` v1.4.4 or above to generate mock files.
```
go get -u github.com/golang/mock/mockgen
```
## Compiling
```
make gen
```
This generates the protobuf files and put into \golang directory
## Sign IoTeX blockchain transaction
secp256k1 ECDSA algorithm is used by IoTeX blockchain to sign and verify transaction. The signature of an IoTeX transaction is computed as the secp256k1 signature of hash of raw transaction
```
signature = secp256k1.Sign(hash of raw transaction)
```
The signature is in 65-byte [R, S, V] format where the last byte V is the recovery id for public key recovery
The following guide used sender address `io1mwekae7qqwlr23220k5n9z3fmjxz72tuchra3m` and recipient address `io187wzp08vnhjjpkydnr97qlh8kh0dpkkytfam8j` as example. Replace your actual address and recipient address when creating and signing the transaction
### Create raw transaction
1. construct a message Transfer as defined in `\proto\type\action.proto`, amount is in unit of 10^-18 IOTX token
For example, to transfer 1.2 IOTX token, set amount = “1200000000000000000”
Set recipient = "io187wzp08vnhjjpkydnr97qlh8kh0dpkkytfam8j"
payload = hex-bytes of message you want to attach to transaction, can be nil/NULL
2. construct a message ActionCore as defined in `\proto\type\action.proto`, with action = transfer message in 1
Set version = 1, gasLimit = 10000, gasPrice = 1000000000000, that is 0.000001 IOTX
For nonce, issue a gRPC request GetAccount(GetAccountRequest) as defined in `\proto\api\api.proto` use the value of "pendingNonce" field in the reply
### Sign raw transaction
1. serialize the ActionCore message using protobuf
```
bytes = proto.Serialize(ActionCore message above)
```
2. hash of raw transaction is computed as the 32-byte Keccak256 hash of the bytes
```
hash = Keccak256(bytes)
```
3. sign the hash using sender's private key
```
sig = secp256k1.Sign(hash)
```
### Send signed transaction to IoTeX blockchain
1. construct a message Action as defined in \proto\type\action.proto
Set action = ActionCore above, senderPubKey = bytes representation of sender's public key, signature = sig above
2. issue a gRPC request SendAction(SendActionRequest) to IoTeX blockchain endpoint
### Go example
The examples folder contains a few [examples](golang/examples) demonstrating functionality.
To run an example, navigate to it's directory, then go run the file. For example:
```
$ cd golang/examples/transfer
$ go run main.go
```