Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@ngraveio/bc-ur
Advanced tools
A JS implementation of the Uniform Resources (UR) specification from Blockchain Commons
This repository is an implementation of the BC-UR encoding, following the C++ implementation and trying to provide a similar API for Javascript/Typescript usage.
To install, run:
yarn add @ngraveio/bc-ur
import {UR, UREncoder} from '@ngraveio/br-ur'
const message = {any: 'property'}
const messageBuffer = Buffer.from(JSON.stringify(message))
// First step is to create a UR object from a Buffer
const ur = UR.fromBuffer(messageBuffer)
// Then, create the UREncoder object
// The maximum amount of fragments to be generated in total
const maxFragmentLength = 150
// The index of the fragment that will be the first to be generated
// If it's more than the "maxFragmentLength", then all the subsequent fragments will only be
// fountain parts
const firstSeqNum = 0
// Create the encoder object
const encoder = new UREncoder(ur, maxFragmentLength, firstSeqNum)
// Keep generating new parts, until a condition is met; for example the user exits the page, or clicks "DONE"
while(!stop) {
// get the next part in the sequence
let part = encoder.nextPart()
// get the part as a string containing the cbor payload and display it with whatever way
// the part looks like this:
// ur:bytes/1-9/lpadascfadaxcywenbpljkhdcahkadaemejtswhhylkepmykhhtsytsnoyoyaxaedsuttydmmhhpktpmsrjtdkgslpgh
displayPart(part)
}
import {URDecoder} from '@ngraveio/br-ur'
// Create the decoder object
const decoder = new URDecoder()
do {
// Scan the part from a QRCode
// the part should look like this:
// ur:bytes/1-9/lpadascfadaxcywenbpljkhdcahkadaemejtswhhylkepmykhhtsytsnoyoyaxaedsuttydmmhhpktpmsrjtdkgslpgh
const part = scanQRCode()
// register the new part with the decoder
decoder.receivePart(part)
// check if all the necessary parts have been received to successfully decode the message
} while (!decoder.isComplete())
// If no error has been found
if (decoder.isSuccess()) {
// Get the UR representation of the message
const ur = decoder.resultUR()
// Decode the CBOR message to a Buffer
const decoded = ur.decodeCBOR()
// get the original message, assuming it was a JSON object
const originalMessage = JSON.parse(decoded.toString())
}
else {
// log and handle the error
const error = decoder.resultError()
console.log('Error found while decoding', error)
handleError(error)
}
FAQs
A JS implementation of the Uniform Resources (UR) specification from Blockchain Commons
The npm package @ngraveio/bc-ur receives a total of 31,673 weekly downloads. As such, @ngraveio/bc-ur popularity was classified as popular.
We found that @ngraveio/bc-ur demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.