Bricking (RFC-070)
A period when the community can review the RFC (comment Docs)
Document Maintainers: Andi Gabriel Tan 2024. List of other contributors in Annex. 1.
Copyright: MIT license
Copyright © 2018-2024 Axiologic Research and Contributors.
This document is licensed under MIT license.
Abstract
The “bricking” API space offers a set of portable functions for creating and reading bricks. However, the agent should handle brick management (storage and reconstruction) automatically, and you will not have to use them. More information on brick storage can be found in Brick Storages (RFC-003).
1. Bricking functions
//Load openDSU environment
require("../privatesky/psknode/bundles/openDSU");
//Load openDSU SDK
const opendsu = require("opendsu");
//Load keyssi library
const keyssispace = opendsu.loadApi("keyssi");
//Load bricking library
const bricking = opendsu.loadApi("bricking");
//Build a newKeySSI
const seedSSI = keyssispace.createSeedSSI("default");
bricking.putBrick(seedSSI, 'hello', (err, brickHash) =>{
const HLSSI = keyssispace.buildHashLinkSSI("default",brickHash);
bricking.putBrick(seedSSI, 'world', (err, brickHash2) =>{
const HLSSI2 = keyssispace.buildHashLinkSSI("default",brickHash2);
bricking.getBrick(HLSSI, 'authToken', (err, brick) =>{
console.log(brick.toString());
//Returns: “hello”
bricking.getMultipleBricks([HLSSI,HLSSI2], 'authToken', (err, bricks) =>{
console.log("brick:",bricks.toString());
//Returns: “brick: hello” “brick: world”
});
});
});
});
How to use
Function getBrick(hashLinkSSI, authToken, callback)
Description: Retrieve a brick from a hashLinkSSI.
| Name | Type | Value | Description |
|---|---|---|---|
| hashLinkSSI | HashLinkSSI object | *required | HashLinkSSI from which you want to get the brick. |
| authToken | JWT token | A JWT authentication token. | |
| callback | function | *required |
Callback parameters
| Name | Type | Response example |
|---|---|---|
| err | ErrorWrapper Object | |
| brick | Buffer |
Description: Contains a message and the error. / The content of the brick identified by the HashLinkSSI.
Function getMultipleBricks(hashLinkSSIList, authToken, callback)
Description: Retrieve multiple bricks from a hashLinkSSI list.
| Name | Type | Value | Description |
|---|---|---|---|
| hashLinkSSIList | Array of HashLinkSSIs | *required | List of HashLinkSSIs from which you want to get bricks. |
| authToken | JWT token | A JWT authentication token. | |
| callback | function | *required |
Callback parameters
| Name | Type | Response example |
|---|---|---|
| err | ErrorWrapper Object | |
| brick |
Description: List of HashLinkSSI from which you want to get bricks. / A JWT authentication token.
Function putBrick(domain, brick, authToken, callback)
Description: Add a brick to a domain.
| Name | Type | Value | Description |
|---|---|---|---|
| domain | KeySSI object | *required | The KeySSI associated with the blockchain and brick storage where you want to add the brick. |
| brick | ReadableStream or string | *required | The brick content you want to add to the brick storages. |
| authToken | JWT token | A JWT authentication token. | |
| callback | function | *required |
Callback parameters
| Name | Type | Response example |
|---|---|---|
| err | ErrorWrapper Object | |
| brickHash | string |
Description: Contains a message and the error. / The hash of the brick that was added. The KeySSI type (sha256 by default) defines the hash function.
Function constructBricksFromData(keySSI, data, options, callback)
Description: Create bricks from data.
| Name | Type | Value | Description |
|---|---|---|---|
| KeySSI | KeySSI object | *required | The KeySSI of the blockchain domain. |
| data | buffer | *required | |
| options | |||
| callback | function | *required |
Contributors
-
Axiologic Research: New content and improvements. Original texts under PharmaLedger Association and Novartis funding. MIT licensed content accordingly with the contracts. Publish and maintain the www.opendsu.org site.
-
PharmaLedger Project: Review, feedback, observations, new content, and corrections MIT licensed accordingly with the consortium agreements.
- PrivateSky Research Project: MIT licensed content accordingly with the contracts. https://profs.info.uaic.ro/~ads/PrivateSky/
Annex 1. Contributors
| Current Editors | |
|---|---|
| Sînică Alboaie | sinica.alboaie@axiologic.net |
| Cosmin Ursache | cosmin@axiologic.net |
| Teodor Lupu | teodor@axiologic.net |
| Andi-Gabriel Țan | andi@axiologic.net |
| Contributors Axiologic Research | |
| Adrian Ganga | adrian@axiologic.net |
| Andi-Gabriel Țan | andi@axiologic.net |
| Cosmin Ursache | cosmin@axiologic.net |
| Daniel Sava | daniel@axiologic.net |
| Nicoleta Mihalache | nicoleta@axiologic.net |
| Valentin Gérard | valentin@axiologic.net |
| PrivateSky Contributors | |
| Alex Sofronie | alsofronie@gmail.com (DPO) |
| Cosmin Ursache | cos.ursache@gmail.com (UAIC) |
| Daniel Sava | sava.dumitru.daniel@gmail.com (HVS, AQS) |
| Daniel Visoiu | visoiu.daniel.g@gmail.com (SGiant) |
| Lenuța Alboaie | lalboaie@gmail.com (UAIC) |
| Rafael Mastaleru | rafael@rms.ro (RMS) |
| Sînică Alboaie | salboaie@gmail.com (UAIC) |
| Vlad Balmos | vlad.balmos@gmail.com (Code932) |
| PharmaLedger Contributors | |
| Ana Balan | bam@rms.ro (RMS) |
| Bogdan Mastahac | mab@rms.ro (RMS) |
| Cosmin Ursache | cos@rms.ro (RMS) |
| Michael Sammeth | |
| Rafael Mastaleru | raf@rms.ro (RMS) |