The codechain-sdk-go from codechain-io

Update README

Usages are expired.
Since #7 was resolved by #11, the usages are almost fixed.

Handle RPC Error properly

Currently, if RPC error occurs, the error message just gives
unexpected end of JSON input
Because the error format provided by the rpc server is as follows:

{
  code: -32032,
  message: 'Not Enough Balance',
  data: 'InsufficientBalance { address: Address(~~), balance: ~, cost: ~ }'
}

unexpected end of JSON input comes from line 75.
(body has the error message in byte slice)

codechain-sdk-go/rpc/base.go

Lines 64 to 77 in 6ad3e76

 resp, err := client.httpClient.Do(req) 

 if err != nil { 

 return err 

 } 

 defer resp.Body.Close() 

 body, readerr := ioutil.ReadAll(resp.Body) 

 if readerr != nil { 

 return readerr 

 } 

 var outerResult Result 

 if err := json.Unmarshal(body, &outerResult); err != nil { 

 return err 

 }

Assign types to interface{}

There are a lot if interface{} types in rpc functions.

Implement primitive types and assign thos to interface{}

Test serialize/deserialize code

Block or Transaction type is sophisticated. We should test them.

Hold pointer value if the object is nullable

Some elements of objects are nullable.
But current implementation has not considered this.

Since golang does not support nullable structs in default,
If the object is nullable, hold pointer value instead of the exact value.

We should check all the structs that are implemented.

Implement large integers

Look for other large integer packages
Investigate go-ethereum
Decide the data structure of U64, U128, U256 and implement them
Implement methods

Change strings to []byte

Current implementation uses string a lot to follow the types of codechain-rpc-js, codechain-primitives-js.

But Golang encourages to use byte slice rather than string for many reasons.

So most of the string types in this repository should be changed to []byte

Use custom JSON marshal instead of object duplication

Currently, some of the Transaction-related objects have two forms, which implement normal type and for marshaling.

codechain-sdk-go/core/transaction/signedTransaction.go

Lines 11 to 17 in 6ad3e76

 type SignedTransactionJSON struct { 

 BlockNumber int `json:"blockNumber,omitempty"` 

 BlockHash string `json:"blockHash,omitempty"` 

 TransactionIndex int `json:"transactionIndex,omitempty"` 

 Sig string `json:"sig"` 

 Hash string `json:"hash"` 

 }

codechain-sdk-go/core/transaction/signedTransaction.go

Lines 19 to 25 in 6ad3e76

 type SignedTransaction struct { 

 Unsigned TransactionInterface 

 BlockNumber *int 

 BlockHash *primitives.H256 

 TransactionIndex *int 

 signature []byte 

 }

This implementation is from codechain-sdk-js.
But since golang can implement custom marshaling function (link1) (link2), I think duplication of the objects is unnecessary.

Parsing error while `go get -u codechain-rpc-go`

It seems to be that go get propery clones this repository. But repository path in my computer(MacOS) has not preserved some uppercase(CodeChain-io): /Users/daehyun/go/src/github.com/codechain-io/codechain-rpc-go

Below is command execution logs.

$ go get -u github.com/codechain-io/codechain-rpc-go
go: finding github.com/codechain-io/codechain-rpc-go latest
go get: github.com/codechain-io/[email protected]: parsing go.mod:
	module declares its path as: github.com/CodeChain-io/codechain-rpc-go
	        but was required as: github.com/codechain-io/codechain-rpc-go

My go version: go version go1.13.1 darwin/amd64

Transactions in Block do not parse properly

When I called chain.GetBlockByNumber(2242299) to the Corgi network, there are only the initial values for each types in every Transaction field from the parsed Block struct. Actual values could be found in Explorer.

Screenshot

Use smaller rlp package

We are importing the whole Go Ethereum code to use the RLP code.
We should import only the RLP code.

Make rpc directory

The current root directory is too messy.
go files that have rpc package could be moved to /rpc directory.

I'll do this after [WIP]'s are done to avoid conflict.

Run lint using Github Actions

Use shorter alias for package names

Some package names are too long. (e.g. primitives)
It hurts code readability while importing and using the package that has a long name.

Use alias for long package name like prims for primitives

Reuse http.Client.

Currently http.Client is created every RPC execution.
But golang recommends reusing the http.Client
https://golang.org/pkg/net/http/#Client

Replace hard-coded json tags to customized-marshaller

Almost all field names in JSON format are same with the deserialized Go types. So I want to propose to implement custom Marshaller changing PascalCase to camelCase
Implementors can consult the following : https://gist.github.com/Rican7/39a3dc10c1499384ca91

Implementations left to Release alpha version.

This is reduced version of #40. (could be more reduced)
MintAsset, TransferAsset, Pay transactions are planned to be available in the alpha version.
I'll set the day by day schedule until Monday(11/18).

#46 (comment)

Make rpcClient.call unmarshall result automatically

See https://github.com/ethereum/go-ethereum/blob/b1c3010bf2c334241a8cb01eab110e5f1cd88f71/ethclient/ethclient.go#L165

Add README.md

Implement crypto package

Hash

256bit blake hash
160bit blake hash
128bit blake hash
160bit RIPEMD hash

Ecdsa

Generate ECDSA private key
Get a public key fro private key
Get ECDSA signature for a message from a private key
Check if a signature on a message is correct using public key
Get a public key from the message and ECDSA signature

Bech32

Encoding
Decoding

Update golang version to 1.13

codechain-sdk-go/go.mod

Line 3 in 6ad3e76

go 1.12

https://golang.org/doc/go1.13

In September 2019, golang version 1.13 has been released officially.
I think there are no breaking changes. However, they had discontinued the support for previous versions for some architecture.

Implement SDK core

core

go test fails with unexpected end of JSON input

go test in root directory of 689f8eb fails with

unexpected end of JSON input

Not sure, I think modularizing rpc have occurred this issue.

So fix the *_test.go files.

Move some tests to example

Some of the tests are more like example codes now.
Create example directory to the root and move some tests there.

The structure ./example could be like below

example
| - Pay
| | - main.go
|
| - TransferAsset
| | - pay.go

	resp, err := client.httpClient.Do(req)
	if err != nil {
	return err
	}
	defer resp.Body.Close()

	body, readerr := ioutil.ReadAll(resp.Body)
	if readerr != nil {
	return readerr
	}
	var outerResult Result
	if err := json.Unmarshal(body, &outerResult); err != nil {
	return err
	}

	type SignedTransactionJSON struct {
	BlockNumber int `json:"blockNumber,omitempty"`
	BlockHash string `json:"blockHash,omitempty"`
	TransactionIndex int `json:"transactionIndex,omitempty"`
	Sig string `json:"sig"`
	Hash string `json:"hash"`
	}

	type SignedTransaction struct {
	Unsigned TransactionInterface
	BlockNumber *int
	BlockHash *primitives.H256
	TransactionIndex *int
	signature []byte
	}

codechain-io / codechain-sdk-go Goto Github PK

codechain-sdk-go's People

Contributors

Stargazers

Watchers

Forkers

codechain-sdk-go's Issues

Screenshot

Recommend Projects

Recommend Topics

Recommend Org