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

Tentative schedule
~7/21

I reconstructed the project.
Setupping project took much time than I thought.
part 1

• Setup project(README, tox, pipenv, setup.py, test e.g.)
  • tox
• Change this repository the codechain-sdk-python and make the primitive code as a submodule.
• Implement crypto lib
  • bech32
  • ecdsa
  • schnorr
  • blake
  • ripemd
• Finish to write crypto and primitive part of the SDK spec docs
  part 2
• Complete the primitive lib
  • asset address
  • platform address
  • utility [Do not need to be implemented]
• Investigate keystore lib
• Finish to write keystore part of the SDK spec docs
  part 3
• Implement keystore lib
  • logic
    • pbkdf2
    • hdstorage encoding
    • storage encoding
  • model (~ 11/9)
    • hdkeystorage class (This is put off until use case occurs)
    • keystorage class
  • CCKey class
  • Context(We don't need to implement this layer since we are not going to use this sdk on web browser) ~~(~ 11/16)~~ (~ 11/13)
• Investigate rpc wrapper (This wil be implemented by @foriequal0, but I will write a spec for this) (I will implement this)
• Implement rpc wrapper [proceeding]
  • account
  • chain
  • devel
  • engine
  • mempool
  • net
  • rpc (main class)
    (~ 11/23)
• Rewriting the SDK spec docs until the keystore
• Investigate helper lib
• ~~Finish writing helper part of the SDK spec docs (~ 11/30)~~ (I have tried writing this but it was too time comsuming and it didn't seem that much needed)
  part 4
• Implement RPC wrapper (This should be done before diving into helper lib. I am not sure when @foriequal0 can finish this.)
• Implement helper lib
  • key
    • local key store
    • memory key store
    • remote key store
    • p2pkh
    • p2pkh burn
    • key
  • rpc
    • account
    • chain
    • devel
    • engine
    • network
    • node
    • rpc
  • core
    • transactions
      • asset mint output
      • asset out point
      • asset transfer input
      • asset transfer output
      • change asset scheme
      • create shard
      • custom
      • increase asset supply
      • mint asset
      • order
      • order on transfer
      • pay
      • remove
      • set regular key
      • set shard owner
      • set shard user
      • store
      • transfer asset
      • unwrap ccc
      • wrap ccc
    • asset
    • asset scheme
    • block
    • invoice
    • script
    • signed transaction
    • text
    • transaction
  • utils
  • tests
  • examples

I decided to include sending mintAsset and transferAsset transactions only in the SDK alpha version. Bold things are needed.

Now, the keystoreManager class makes persistent keystore.db as default. We need to add an option for making it volatile.

To achieve this, we need to increase the python version to 3.8.

Json.stringify in sdk-js is different from str(object) in python. As a result, metadata in assetscheme can be different when the assetscheme is minted from sdk-js and sdk-python. It might not be a problem in each SDK's functionality but it can ruin a consistency between SDKs.

I think there is a mismatch between codechain core and python-sdk implementation.

https://github.com/CodeChain-io/codechain-sdk-python/blob/master/codechain/primitives/HexString.py#L65

I think 0x prefix is not added in this code.
Is 0x prefix added as the spec says?

Currently, it takes and gives raw dict when you make a request and get a response.
However it is not desirable since we have some types that do not correspond 1:1 to JSON objects such as big integers and hash types.
We need to convert between our primitive types and JSON types.

CCKey class should retain both keystore manager(asset, platform) and HD keystore manager. However, we didn't implement HD keystore manager since there seems no use-case until now.

It isn't maintained and has a vulnerability
pycrypto/pycrypto#285