findoranetwork / abcf Goto Github PK

Currently, we need some work.

Need todo

Complete storage layer bs3.

• #2
• #8
• Document: add document. @malefooo
• Test: add some test on this. @malefooo

Complete function of abcf.

• #20 (aka entry)
  • #25
  • #30
• #14 (aka manager)
  • #15
  • #32
  • #23
  • #31
  • #18
  • #33
  • Add macro to generate manager code. @tiannian
• #7
• #3
• #28
• Document: add document. @malefooo
• Test: add unit test on this. @malefooo
• #9

Make framework stable

• change minicbor to ciborium @malefooo 1day.
• add sled support for bs3 @malefooo 1day.
• #37
• simple usage for module @tiannian 1day.

Future work

• Function: wasm module.
• Examples and Demos, see #27 .

Issues

• #10
• #11
• Fix no store delacre.
• Fix generic support on store.

Design Document

https://www.notion.so/findora/Modularization-in-Design-263050607c5d4db2b93d0bf8e9109541

Add optimizations for abcf.

TODO

• #30
• Auto declare storage.
• Define merkle algo for special field.
• add module call macros.
• Impl manager's new in trait without in bare code.
• Add Call in macros.
• Extend CallEntry as inner EventBus.
• Add multi-thread support.
• Add returnable support for module call.

• #30
• #75
• #73
• #74
• Declare store used macros

Define new trait named Module

pub trait Context {
  type Store: bs3::Store;
  type Digest: digest::Digest;

  // Trigger event;
  fn emmit(&mut self, event: impl Event);
  // Spwan a new async work.
  fn spwan<R>(&mut self, handler: impl core::future::Future<Output = R>) -> R;
  // Get block info.
  fn block(&self) -> &Block;
  // Get Consensus info.
  fn consensus(&self) -> &Consensus;
  // Get Governance info.
  fn governance(&self) -> &Governance;
}

pub trait ContextMut: Context {
  fn consensus_mut(&mut self) -> &mut Consensus;
  fn governance_mut(&mut self) -> &mut Governance;
}

When you declare a module:

#[abcf::module]
pub struct MockModule<C: Context> {
  ctx: C,

  #[metadata(
    name = "mock",
    version = 0,
    impl_version,
    target_height = 0,
  )]
  metadata: abcf::Metadata,

  #[storage(merkle="AppendOnlyMerkle")]
  storage_value: Value<u32, C>,

  #[dependence]
  utxo: UtxoModule<C>,
}

When you create a module, please use code like this:

let backend = SledBackend::open_db("target/data/mock");

let mut mock = MockModule::new::<_, Sha3_256>(&backend);

mock.genesis_storage_value(Value::new(123));

let mockv1 = MockModuleV1::new<_, Sha3_256>(&backend);

Convert the ABCI interface result in Result. And use Result to generate the error log.

Due to the ABCI application will process data in any type, so we need to remove JSON dependence in ABCI.