Skip to content

Commit

Permalink
init: first
Browse files Browse the repository at this point in the history
  • Loading branch information
joundy committed Apr 5, 2024
0 parents commit 7afe817
Show file tree
Hide file tree
Showing 9 changed files with 452 additions and 0 deletions.
176 changes: 176 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
\*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
\*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

\*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

\*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.cache
.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

.cache/

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp
.cache

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.\*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store

13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# big-varuint

To install dependencies:

```bash
bun install
```

To run:

```bash
bun run example.ts
```
Binary file added bun.lockb
Binary file not shown.
52 changes: 52 additions & 0 deletions example.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import {
U128_MAX_NUMBER,
U16_MAX_NUMBER,
U32_MAX_NUMBER,
U64_MAX_NUMBER,
U8_MAX_NUMBER,
} from "./types";
import { U128, U16, U32, U64, U8 } from "./uint";
import { Varuint } from "./varuint";

async function main() {
const examples: Varuint[] = [
new U8(U8_MAX_NUMBER),
new U16(U16_MAX_NUMBER),
new U32(U32_MAX_NUMBER),
new U64(U64_MAX_NUMBER),
new U128(U128_MAX_NUMBER),
];

// encode
for (let i = 0; i < examples.length; i += 1) {
console.log(examples[i].toString());
console.log(examples[i].toVaruint());
}

// decode then encode
for (let i = 0; i < examples.length; i += 1) {
console.log(examples[i].toString());
if (examples[i] instanceof U8) {
const buff = examples[i].toVaruint();
console.log(U8.fromVaruint(buff).toString());
}
if (examples[i] instanceof U16) {
const buff = examples[i].toVaruint();
console.log(U16.fromVaruint(buff).toString());
}
if (examples[i] instanceof U32) {
const buff = examples[i].toVaruint();
console.log(U32.fromVaruint(buff).toString());
}
if (examples[i] instanceof U64) {
const buff = examples[i].toVaruint();
console.log(U64.fromVaruint(buff).toString());
}
if (examples[i] instanceof U128) {
const buff = examples[i].toVaruint();
console.log(U128.fromVaruint(buff).toString());
}
}
}

main();
11 changes: 11 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "big-varuint",
"module": "index.ts",
"type": "module",
"devDependencies": {
"bun-types": "latest"
},
"peerDependencies": {
"typescript": "^5.0.0"
}
}
22 changes: 22 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"compilerOptions": {
"lib": ["ESNext"],
"module": "esnext",
"target": "esnext",
"moduleResolution": "bundler",
"moduleDetection": "force",
"allowImportingTsExtensions": true,
"noEmit": true,
"composite": true,
"strict": true,
"downlevelIteration": true,
"skipLibCheck": true,
"jsx": "react-jsx",
"allowSyntheticDefaultImports": true,
"forceConsistentCasingInFileNames": true,
"allowJs": true,
"types": [
"bun-types" // add Bun global
]
}
}
7 changes: 7 additions & 0 deletions types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export const U8_MAX_NUMBER = 0xffn;
export const U16_MAX_NUMBER = 0xffffn;
export const U32_MAX_NUMBER = 0xffff_ffffn;
export const U64_MAX_NUMBER = 0xffff_ffff_ffff_ffffn;
export const U128_MAX_NUMBER = 0xffff_ffff_ffff_ffff_ffff_ffff_ffff_ffffn;

export const BUFFER_MAX_LENGTH = 19; // maximum u128 length
90 changes: 90 additions & 0 deletions uint.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
import {
U8_MAX_NUMBER,
U32_MAX_NUMBER,
U64_MAX_NUMBER,
U128_MAX_NUMBER,
U16_MAX_NUMBER,
} from "./types";
import { Varuint, decodeBigVaruint } from "./varuint";

export class U8 extends Varuint {
constructor(n: bigint) {
super(n, U8_MAX_NUMBER);
}

static fromString(nStr: string) {
return new U8(BigInt(nStr));
}

static fromNumber(nNum: number) {
return new U8(BigInt(nNum));
}

static fromVaruint(buff: Buffer){
return new U8(decodeBigVaruint(buff))
}
}

export class U16 extends Varuint {
constructor(n: bigint) {
super(n, U16_MAX_NUMBER);
}

static fromString(nStr: string) {
return new U16(BigInt(nStr));
}

static fromNumber(nNum: number) {
return new U16(BigInt(nNum));
}

static fromVaruint(buff: Buffer){
return new U16(decodeBigVaruint(buff))
}
}

export class U32 extends Varuint {
constructor(n: bigint) {
super(n, U32_MAX_NUMBER);
}

static fromString(nStr: string) {
return new U32(BigInt(nStr));
}

static fromNumber(nNum: number) {
return new U32(BigInt(nNum));
}

static fromVaruint(buff: Buffer){
return new U32(decodeBigVaruint(buff))
}
}

export class U64 extends Varuint {
constructor(n: bigint) {
super(n, U64_MAX_NUMBER);
}

static fromString(nStr: string) {
return new U64(BigInt(nStr));
}

static fromVaruint(buff: Buffer){
return new U64(decodeBigVaruint(buff))
}
}

export class U128 extends Varuint {
constructor(n: bigint) {
super(n, U128_MAX_NUMBER);
}

static fromString(nStr: string) {
return new U128(BigInt(nStr));
}

static fromVaruint(buff: Buffer){
return new U128(decodeBigVaruint(buff))
}
}
Loading

0 comments on commit 7afe817

Please sign in to comment.