bigint-codec

0.1.1 • Public • Published

BigInt Codec

BigInt serialization codec using Uint8Arrays for NodeJS and the Web with no dependencies.

Packaged as both ECMAScript Modules and CommonJS thanks to Rollup.

Compatability Testing Status:

  • Bit-compatabile with u8/i8/u16/i16/u32/i32/u64/i64 encodings via DataView for both Little Endian (LE) and network order Big Ending (BE) encodings.
  • TODO: Test compatibility with ASN-1 Big-Int encodings.
  • TODO: Identify and test compatibility with other Big-Int encodings.

Example

import {encodeBigInt, decodeBigInt} from 'bigint-codec'
import {encodeBigUint, decodeBigUint} from 'bigint-codec'
 
const n_curve25519 = 0x1000000000000000000000000000000014def9dea2f79cd65812631a5cf5d3edn
 
const u8_BE = encodeBigInt(n_curve25519)
console.log(u8_BE)
// Uint8Array(32) [
//    16,   0,   0,   0,   0,   0,  0,  0,   0,
//     0,   0,   0,   0,   0,   0,  0, 20, 222,
//   249, 222, 162, 247, 156, 214, 88, 18,  99,
//    26,  92, 245, 211, 237
// ]
 
const n_rt = decodeBigInt(u8_BE)
 
console.log(n_rt === n_curve25519)
// true
 
 
const u8_LE = encodeBigInt(n_curve25519, true)
console.log(u8_LE)
// Uint8Array(32) [
//     237, 211, 245,  92,  26,  99, 18, 88, 214,
//     156, 247, 162, 222, 249, 222, 20,  0,   0,
//       0,   0,   0,   0,   0,   0,  0,  0,   0,
//       0,   0,   0,   0,  16
// ]
 
 
const n_rt_LE = decodeBigInt(u8_LE, true)
console.log(n_rt_LE === n_curve25519)
// true

Use

CDN
<script src="https://cdn.jsdelivr.net/npm/bigint-codec@VERSION/umd/index.min.js"></script>
<!-- or -->
<script src="https://cdn.jsdelivr.net/npm/bigint-codec/umd/index.min.js"></script>
<script>window.bigint_codec.encodeBigInt(23n)</script> 
 
<!-- or individually -->
 
<script src="https://cdn.jsdelivr.net/npm/bigint-codec@VERSION/umd/bigint_decode.min.js"></script>
<script>window.bigint_decode.decodeBigInt</script> 
 
<script src="https://cdn.jsdelivr.net/npm/bigint-codec@VERSION/umd/bigint_encode.min.js"></script>
<script>window.bigint_encode.encodeBigInt</script> 
 
<script src="https://cdn.jsdelivr.net/npm/bigint-codec@VERSION/umd/bigint_encode_into.min.js"></script>
<script>window.bigint_encode_into.encodeIntoBigInt</script> 
NodeJS import
import {decodeBigInt, decodeBigUint} from 'bigint-codec'
import {encodeBigInt, encodeBigUint} from 'bigint-codec'
 
// or individually
import {decodeBigInt, decodeBigUint} from 'bigint-codec/esm/bigint_decode.mjs'
import {encodeBigInt, encodeBigUint} from 'bigint-codec/esm/bigint_encode.mjs'
import {encodeIntoBigInt, encodeIntoBigUint} from 'bigint-codec/esm/bigint_encode_into.mjs'
NodeJS require()
const { decodeBigUint, encodeBigUint } = require('bigint-codec')
 
// or individually
const {decodeBigUint} = require('bigint-codec/cjs/bigint_decode.cjs')
const {encodeBigUint} require('bigint-codec/cjs/bigint_encode.cjs') 

API

Encode Signed BigInt
{
  encodeBigInt(value : BigInt, littleEndian: Boolean) : Uint8Array {},
  encodeBigIntLE(value : BigInt) : Uint8Array {},
  encodeBigIntBE(value : BigInt) : Uint8Array {},
  encodeIntoBigIntLE(value : BigInt, u8buf? : Uint8Array) : Uint8Array {},
  encodeIntoBigIntBE(value : BigInt, u8buf? : Uint8Array) : Uint8Array {},
}
Encode Unsigned BigInt
{
  encodeBigUint(value : BigInt, littleEndian: Boolean) : Uint8Array {},
  encodeBigUintBE(value : BigInt) : Uint8Array {},
  encodeBigUintLE(value : BigInt) : Uint8Array {},
  encodeIntoBigUintLE(value : BigInt, u8buf? : Uint8Array) : Uint8Array {},
  encodeIntoBigUintBE(value : BigInt, u8buf? : Uint8Array) : Uint8Array {},
}
Decode Signed BigInt
{
  decodeBigInt(u8buf: ArrayBuffer | Uint8Array, littleEndian: Boolean) : BigInt {},
  decodeBigIntLE(u8buf: ArrayBuffer | Uint8Array) : BigInt {},
  decodeBigIntBE(u8buf: ArrayBuffer | Uint8Array) : BigInt {},
}
Decode Unsigned BigInt
{
  decodeBigUint(u8buf: ArrayBuffer | Uint8Array, littleEndian: Boolean) : BigInt {},
  decodeBigUintBE(u8buf: ArrayBuffer | Uint8Array) : BigInt {},
  decodeBigUintLE(u8buf: ArrayBuffer | Uint8Array) : BigInt {},
}

License

BSD 2-clause

Keywords

none

Install

npm i bigint-codec

DownloadsWeekly Downloads

2

Version

0.1.1

License

BSD-2-Clause

Unpacked Size

128 kB

Total Files

42

Last publish

Collaborators

  • shanewholloway