Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/LimeChain/as-scale-codec

AssemblyScript implementation of the SCALE codec used in the Parity Substrate framework.
https://github.com/LimeChain/as-scale-codec
Last synced: about 1 month ago
JSON representation
AssemblyScript implementation of the SCALE codec used in the Parity Substrate framework.
Host: GitHub
URL: https://github.com/LimeChain/as-scale-codec
Owner: LimeChain
License: apache-2.0
Created: 2020-05-04T06:45:41.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-07-12T06:12:11.000Z (over 1 year ago)
Last Synced: 2024-04-11T22:17:09.819Z (8 months ago)
Language: TypeScript
Homepage:
Size: 333 KB
Stars: 18
Watchers: 7
Forks: 6
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

awesome-substrate - AssemblyScript - Maintained by LimeChain. (SCALE Codec)
awesome-substrate - AssemblyScript - Maintained by LimeChain. (SCALE Codec)
README

        
AssemblyScript SCALE Codec


[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

![Tests](https://github.com/LimeChain/as-scale-codec/workflows/Tests/badge.svg)

[![npm version](https://img.shields.io/npm/v/as-scale-codec?color=light-green&label=npm%20package)](https://img.shields.io/npm/v/as-scale-codec?color=light-green&label=npm%20package)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/LimeChain/as-scale-codec)

**as-scale-codec** is AssemblyScript implementation of Polkadot SCALE Codec. The codec is used as a communication mechanism between Polkadot Hosts and Polkadot Runtimes.

More detailed information about the SCALE codec specification can be found [here](https://substrate.dev/docs/en/knowledgebase/advanced/codec).

This AssemblyScript implementation of the codec is funded by [Web3 Foundation](https://web3.foundation/) via their [Open Grants Program](https://github.com/w3f/Open-Grants-Program)! :pray:

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

# Supported types

The following table shows the status of the types and their arrays:

|       Type        |       Support      | Array Support | 

|----------------------|:--------------------:|:------:|

| `Fixed width number` | ✅ | ✅ |

| `Compact Int`        | ✅ |✅ |

| `Big Integer` | :small_orange_diamond: *Limited Support* | :small_orange_diamond: *Limited Support* |

| `Byte` |✅ |✅ | 

| `Bool` | ✅| ✅|

| `Hash` |✅ | :heavy_minus_sign: |

| `String` | ✅|✅ | 

| `Map` |✅| :heavy_minus_sign: | 

The following table shows the status of the fixed width numbers:

| Тype | `8` | `16` | `32` | `64` | `128` | `256` | 

|--|:--:|:--:|:--:|:--:|:--:|:--:|

| `int` | ✅ | ✅| ✅|✅ | :heavy_minus_sign:|  :heavy_minus_sign:|

| `uint` | ✅ | ✅| ✅|✅ |✅ |:heavy_minus_sign:|

## Special Types

- **Compact Int** - [Documentation](https://substrate.dev/docs/en/knowledgebase/advanced/codec#compactgeneral-integers)

## **Getting Started**  

*You can find more information on AssemblyScript and how to get started with it in the AssemblyScript docs -> [https://www.assemblyscript.org/introduction.html](https://www.assemblyscript.org/introduction.html)*

1. In your AssemblyScript project execute:

    ```bash

    npm install as-scale-codec

    ```

2. Once you have the library installed in your AssemblyScript project you can use it in your `assembly` files by importing the files from `as-scale-codec`.

 

Detailed examples of the exported by the library types are listed below:

  

## Types

### Encoding

Every type has а **toU8a** function. It encodes type value into an array of bytes

```jsx

import { Bool, Byte, ScaleString, Hash, CompactInt } from "as-scale-codec"

import { Int8, Int16, Int32, Int64 } from "as-scale-codec"

import { UInt8, UInt16, UInt32, UInt64, UInt128 } from "as-scale-codec"

// ScaleMap

const scaleMap = new ScaleMap();

scaleMap.set(new Int32(1), new Bool(false));

scaleMap.toU8a() // => [4, 1, 0, 0, 0, 0];

// Bool

const scaleBool = new Bool(true);

scaleBool.toU8a() // => [0x01]

// Byte

const scaleByte = new Byte(0x01);

scaleByte.toU8a() // => [0x01]

// String

const scaleString = new ScaleString("a");

scaleString.toU8a() // => [0x04, 0x61] 

// Hash

const scaleHash = new Hash([0xff, 0x00, 0xab]);

scaleHash.toU8a() // => [0xff, 0x00, 0xab, 0x00, ... 0x00] (32 bytes long)

// Compact Int

const scaleCompactInt = new CompactInt(1);

scaleCompactInt.toU8a() // => [0x04]

// Int

const scaleInt8 = new Int8(-1);

scaleInt8.toU8a() // => [0xff]

const scaleInt16 = new Int16(-1);

scaleInt16.toU8a() // => [0xff, 0xff]

const scaleInt32 = new Int32(-1);

scaleInt32.toU8a() // => [0xff, 0xff, 0xff, 0xff]

const scaleInt64 = new Int64(-1);

scaleInt64.toU8a() // => [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff]

// UInt

const scaleUInt8 = new UInt8(1);

scaleUInt8.toU8a() // => [0x01]

const scaleUInt16 = new UInt16(1);

scaleUInt16.toU8a() // => [0x01, 0x00]

const scaleUInt32 = new UInt32(1);

scaleUInt32.toU8a() // => [0x01, 0x00, 0x00, 0x00]

const scaleUInt64 = new UInt64(1);

scaleUInt64.toU8a() // => [0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]

const scaleUInt128 = new UInt128(u128.fromU64(18446744073709551615));

scaleUInt128.toU8a() // => [0x13, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff]

```

### Decoding

Every type has a **static** function **fromU8a**. It decodes an array of bytes to the desired type

```jsx

import { ScaleMap, Bool, Byte, ScaleString, Hash, CompactInt } from "as-scale-codec"

import { Int8, Int16, Int32, Int64 } from "as-scale-codec"

import { UInt8, UInt16, UInt32, UInt64, UInt128 } from "as-scale-codec"

// Bool

Bool.fromU8a([0x01]); // => new Bool(true)

// Byte

Byte.fromU8a([0x01]); // => new Byte(0x01)

// String

Byte.fromU8a([0x04, 0x61]); // => new ScaleString('a')

// Hash

Hash.fromU8a([0xff, 0x00, 0xab]); 

// => [0xff, 0x00, 0xab, 0x00, ... 0x00] (32 bytes long)

ScaleMap.fromU8a([4, 1, 0, 0, 0, 0]);

// => const scaleMap = new ScaleMap()

// => scaleMap.set(new Int32(1), new Bool(false))

// Compact Int

CompactInt.fromU8a([0x04]); // => new CompactInt(1)

// Int

Int8.fromU8a([0xff]); // => new Int8(-1)

Int16.fromU8a([0xff, 0xff]); // => new Int16(-1)

Int32.fromU8a([0xff, 0xff, 0xff, 0xff]); // => new Int32(-1)

Int64.fromU8a([0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff]); // => new Int64(-1)

// UInt

UInt8.fromU8a([0x01]); // => new UInt8(1)

UInt16.fromU8a([0x01, 0x00]); // => new UInt16(1)

UInt32.fromU8a([0x01, 0x00, 0x00, 0x00]); // => new UInt32(1)

UInt64.fromU8a([0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]); // => new UInt64(1)

UInt128.fromU8a([0x33, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff]);

// => 340282366920938463444927863358058659840

```

## Arrays

### Encoding

Every array has **toU8a** function. It encodes the array values into an array of SCALE encoded bytes.

```jsx

import { BoolArray, ByteArray, IntArray, StringArray } from "as-scale-codec"

// Bool Array

const boolArray = new BoolArray([true, false, true]);

boolArray.toU8a(); // => [0x0c, 0x01, 0x00, 0x01]

// Byte Array

const byteArray = new ByteArray([0x01, 0x01, 0x01]);

byteArray.toU8a(); // => [0x0c, 0x01, 0x01, 0x01]

// Int Array

const intArray = new IntArray([16384, 2, 3, 4]);

intArray.toU8a() // => [0x10, 0x02, 0x00, 0x01, 0x00, 0x08, 0x0c, 0x10]

// String Array

const stringArray = new StringArray(["hello", "world"]);

stringArray.toU8a() // => [0x08, 0x14, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x14, 0x77, 0x6f, 0x72, 0x6c, 0x64]

```

### Decoding

Every array has a **static** function **fromU8a**. It decodes an array of SCALE encoded bytes and creates an array instance of the desired type.

```jsx

import { BoolArray, ByteArray, IntArray, StringArray } from "as-scale-codec"

// Bool Array

BoolArray.fromU8a([0x0c, 0x01, 0x00, 0x01]); 

// => new BoolArray([true, false, true])

// Byte Array

ByteArray.fromU8a([0x0c, 0x01, 0x01, 0x01])

// => new ByteArray([0x01, 0x01, 0x01])

// Int Array

IntArray.fromU8a([0x10, 0x02, 0x00, 0x01, 0x00, 0x08, 0x0c, 0x10])

// => new IntArray([16384, 2, 3, 4])

// String Array

StringArray.fromU8a([0x08, 0x14, 0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x14, 0x77, 0x6f, 0x72, 0x6c, 0x64])

// => new StringArray(["hello", "world"])

```

# BytesReader

If you have an array of arbitrary SCALE encoded bytes that you need to decode, `BytesReader` class is a preferred way to do it:

```jsx

import { BytesReader } from 'as-scale-codec';

// Arbitrary SCALE encoded bytes

const bytes: u8[] = [

    0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,

    69, 0, 0, 0,

    110, 125, 239, 2,

    56, 97, 115, 45, 115, 99, 97, 108, 101, 45, 99, 111, 100, 101, 99,

    128, 1, 10, 0, 0, 0, 2, 2, 1, 123, 33, 3, 1, 35, 34, 5, 8, 22, 52, 1, 0, 0, 0, 1, 1, 1, 56, 21, 142, 13, 13, 1,

    0

];

// Instantiate BytesReader instance with SCALE encoded bytes

const bytesReader = new BytesReader(bytes);

// Read Int64

bytesReader.readInto();

// => new Int(-1)

// Read UInt32

bytesReader.readInto();

// => new UInt32(69)

// Read CompactInt

bytesReader.readInto();

// => new CompactInt(12312411)

// Read ScaleString

bytesReader.readInto();

// => new ScaleString("as-scale-codec")

// Read Hash

bytesReader.readInto();

// => new Hash([128, 1, 10, 0, 0, 0, 2, 2, 1, 123, 33, 3, 1, 35, 34, 5, 8, 22, 52, 1, 0, 0, 0, 1, 1, 1, 56, 21, 142, 13, 13, 1])

// Read Bool

bytesReader.readInto();

// => new Bool(false)

// If you have single SCALE encoded type, you can use static decodeInto() function of BytesReader

const uInt64Bytes: u8[] = [1, 0, 0, 0, 0, 0, 0];

// Read UInt64

BytesReader.decodeInto(uInt64Bytes);

// => new UInt64(1)

const hashBytes: u8[] = [0xff, 0x00, 0xab];

// Read Hash

BytesReader.decodeInto(hashBytes);

// new Hash([0xff, 0x00, 0xab])

const mapBytes: u8[] = [2, 1, 0, 1, 0, 0, 0, 3, 0, 3, 0, 0, 0];

// Read ScaleMap

BytesReader.decodeInto>(mapBytes);

// => const scaleMap = new ScaleMap();

// => scaleMap.set(new UInt16(1), new UInt32(1))

// => scaleMap.set(new UInt16(3), new UInt32(3))

const cmpBytes: u8[] = [169, 2];

// Read CompactInt

BytesReader.decodeInto(cmpBytes);

// new CompactInt(170)

const int8Bytes: u8[] = [0xff];

// Read Int8

BytesReader.decodeInto(int8Bytes);

// new Int8(-1)

```

# Miscellaneous

### Convert bytes to hash

```jsx

Hash.bytesToHash([0xff, 0x00, 0xab]); 

// => [0x00, ... , 0x00, 0xff, 0x00, 0xab] (32 bytes long)

Hash.bytesToHash([0xff, 0x00, ..., 0x00]); // (32 bytes long)

// => [0xff, ... , 0x00] (32 bytes long)

```

# **Tests**

In order to run the unit tests, one must perform:

```bash

npm run test

```

# **License**

This repository is licensed under [Apache 2.0 license](https://github.com/LimeChain/as-scale-codec/blob/master/LICENSE)