https://github.com/edjcase/motoko_cbor

https://github.com/edjcase/motoko_cbor

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/edjcase/motoko_cbor
• Owner: edjCase
• License: mit
• Created: 2022-07-25T04:23:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-30T20:46:41.000Z (5 months ago)
• Last Synced: 2024-07-04T17:44:36.699Z (4 months ago)
• Language: Motoko
• Size: 111 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-motoko - motoko_cbor - CBOR encoding/decoding library (Libraries / Encoding)

README

        
## Funding

This library was originally incentivized by [ICDevs](https://ICDevs.org). You

can view more about the bounty on the

[forum](https://forum.dfinity.org/t/icdevs-org-bounty-18-cbor-and-candid-motoko-parser-3-000/11398)

or [website](https://icdevs.org/bounties/2022/02/22/CBOR-and-Candid-Motoko-Parser.html). The

bounty was funded by The ICDevs.org commuity and the award paid to

@Gekctek. If you use this library and gain value from it, please consider

a [donation](https://icdevs.org/donations.html) to ICDevs.

# Overview

This is a library that is written in Motoko that enables the encoding and decoding of CBOR between bytes and a CBOR variant type

# Package

### MOPS

```

mops install cbor

```

To setup MOPS package manage, follow the instructions from the [MOPS Site](https://j4mwm-bqaaa-aaaam-qajbq-cai.ic0.app/)

# Usage

### Cbor Bytes -> Cbor Object

```

import Types "mo:cbor/Types";

import Decoder "mo:cbor/Decoder";

let bytes: [Nat8] = [0xbf, 0x63, 0x46, 0x75, 0x6e, 0xf5, 0x63, 0x41, 0x6d, 0x74, 0x21, 0xff];

let cbor: Types.Value = switch(Decoder.decodeBytes(bytes)) {

    case (#err(e)) ...;

    case (#ok(c)) c;

};

```

### Cbor Object -> Cbor Bytes

```

import Types "mo:cbor/Types";

import Encoder "mo:cbor/Encoder";

let bytes: Types.Value = #majorType5([

    (#majorType3("Fun"), #majorType7(#bool(true))),

    (#majorType3("Amt"), #majorType1(-2))

]);

let bytes: [Nat8] = switch(Encoder.encode(bytes)) {

    case (#err(e)) ...;

    case (#ok(c)) c;

};

```

### Custom Type -> Cbor Bytes

_Not Yet Implemented_

use `to_candid(...)`. See https://internetcomputer.org/docs/current/developer-docs/build/cdks/motoko-dfinity/language-manual#candid-serialization

### Cbor Bytes -> Custom Type

_Not Yet Implemented_

use `from_candid(...)`. See https://internetcomputer.org/docs/current/developer-docs/build/cdks/motoko-dfinity/language-manual#candid-serialization

# API

## Decoder.mo

`decode(blob: Blob) : Result.Result`

Decodes a blob into a cbor value variant

`decodeBytes(bytes: Iter.Iter) : Result.Result`

Decodes a series of bytes into a cbor value variant

## Encoder.mo

`encode(value: Types.Value) : Result.Result<[Nat8], Types.EncodingError>`

Encodes a cbor value into a byte array

`encodeToBuffer(buffer: Buffer.Buffer, value: Types.Value) : Result.Result<(), Types.EncodingError>`

Encodes a cbor value into the supplied byte buffer

# FloatX: Half(16), Single(32), Double(64)

Due to the lack of float functionality (`float <-> bytes`, `half`, `single`) and external reference was used for these. `xtended-numbers` in vessel or `github.com/gekctek/motoko_numbers`

# Testing

```

mops test

```