Skip to content

Latest commit

 

History

History
108 lines (87 loc) · 3.14 KB

README.md

File metadata and controls

108 lines (87 loc) · 3.14 KB
Raw

eoskit

Blockchain development framework (for eos contract development)

usage

core

  1. Include contract.hpp file and extend the kh::contract
  2. Create an constructor with two parameters, account_name self and account_name code
  3. Override funtion to implement two transfer event handlers:
    on_transcal(const account_name from, const account_name to, eosio::asset token, std::string func, std::vector <std::string> args)
    on_transfer(const account_name from, const account_name to, eosio::asset token, std::string memo)
    in a transcal or transfer event handler, _code and token must be verified.
  4. Implement logic functions:
    1. Functions can be called directly, require authority of then from(it means the user who signed the action).
    2. Functions can be called through transfer receipt, require authority of _self(equal to get_self()).
      and then, the function should be called in the handler on_transcal
    3. Export them with macro EXPORT_ABI
  5. Inline call : In the handler or implemented methods, _inline_action(const char *act, T &&value) can be used to execute an inline action.
    In order to use this method, the correct setting of permissions is necessary.
    check the official guide
  6. External call : the transfer are supported by defualt in kh::contract.
    _transfer_token(const account_name to, const account_name token_code, eosio::asset token, std::string memo)

API

kh::contract

/**
 * send inline action
 * @param act: c style string (*.c_str() for std::string)
 * @param value: params packed by make_tuple
*/
_inline_action(const char *act, T &&value)

/**
 * send token
 * @ref eosio/currency
 */
_transfer_token(const account_name to, const account_name token_code, eosio::asset token, std::string memo)

kh::utils

cast

convert std::string to uint64_t :
kh::utils::bitshift(std::string const &value)

convert symbol to std::string :
kh::utils::symbol_to_string(eosio::asset val)

convert asset to std::string :
kh::utils::asset_to_string(eosio::asset val)

time

kh::utils::time::origin
kh::utils::time::day
kh::utils::time::hour
kh::utils::time::min
kh::utils::time::now()

assert

kh::assert::code_must_be_eosio_token(account_name code)
kh::assert::is_valid_token_of_symbol(eosio::asset token, eosio::symbol_type symbol)
kh::assert::equal(const T &a, const T &b, std::string assertion)
kh::assert::not_equal(const T &a, const T &b, std::string assertion)

kh::helper

counter

deploy

there some entry should be insert to .abi file manually

...
tables[
  ...
  {
      "name": "attributes",
      "type": "field_all_in_one_t",
      "index_type": "i64",
      "key_names": [],
      "key_types": []
  },
  {
      "name": "res.accounts",
      "type": "res",
      "index_type": "i64",
      "key_names": [],
      "key_types": []
  },
  {
      "name": "res.info",
      "type": "res",
      "index_type": "i64",
      "key_names": [],
      "key_types": []
  },
  ...
]
...