https://github.com/limechain/subsembly-core

Core components used by Subsembly
https://github.com/limechain/subsembly-core

Last synced: over 1 year ago
JSON representation

Core components used by Subsembly

• Host: GitHub
• URL: https://github.com/limechain/subsembly-core
• Owner: LimeChain
• License: apache-2.0
• Created: 2020-10-21T12:00:17.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-06-08T09:26:11.000Z (about 5 years ago)
• Last Synced: 2025-02-23T22:06:42.322Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 312 KB
• Stars: 0
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  





[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Unit Tests](https://github.com/LimeChain/subsembly-core/workflows/Unit%20Tests/badge.svg)



This is the core library of [Subsembly framework](https://github.com/LimeChain/subsembly) used for developing Substrate runtimes in AssemblyScript.

## Usage

Install the package:

``` 

yarn add subsembly-core 

```  

or  

``` 

npm install subsembly-core

```  

## Folder Structure

Subsembly-Core project consists of following folders:

```

subsembly

    assembly/

    │

    └───models     <--- Models representing common Subsembly types

    |

    └───modules    <--- Core modules used in Runtime development

    │

    └───utils      <--- Utility functions used in Runtime development

```

## Models

Folder consists of commonly used types in Subsembly, such as, `Header`, `Extrinsic`, `Block`, etc. All the models implement Codec interface from [`as-scale-codec`](https://github.com/limechain/as-scale-codec) and have corresponding SCALE encoding and decoding methods.

## Modules

Folder consists of commonly used modules inside Subsembly runtime. For instance, `Log` class to display messages to the Host.

## Utils

Folder consists of commonly used utility functions in Subsembly. For instance, it includes methods for serialising and deserialising data incoming from the Host.

## Funding 

The project is funded by [Web3 Foundation](https://web3.foundation/) via their [General Grants Program](https://github.com/w3f/General-Grants-Program) 🙏

![WEB3 Badge](./images/web3_badge_black.png)