Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
dee5e1cb9e
|
|||
|
e388a55575
|
|||
|
c52ec1dc43
|
56
README.md
56
README.md
@@ -2,18 +2,54 @@
|
|||||||
|
|
||||||
TypeScript library for MeshCore protocol utilities.
|
TypeScript library for MeshCore protocol utilities.
|
||||||
|
|
||||||
Quick start
|
## Packet parsing
|
||||||
|
|
||||||
1. Install dev dependencies:
|
Using the library to decode MeshCore packets:
|
||||||
|
|
||||||
```bash
|
```ts
|
||||||
npm install --save-dev typescript tsup
|
import { Packet } from '@hamradio/meshcore';
|
||||||
|
|
||||||
|
const raw = new Uint8Array(Buffer.from("050AA50E2CB0336DB67BBF78928A3BB9BF7A8B677C83B6EC0716F9DD10002A06", "hex"));
|
||||||
|
const packet = Packet.fromBytes(raw);
|
||||||
|
console.log(packet);
|
||||||
|
|
||||||
|
/*
|
||||||
|
_Packet {
|
||||||
|
header: 5,
|
||||||
|
transport: undefined,
|
||||||
|
pathLength: 10,
|
||||||
|
path: Uint8Array(10) [
|
||||||
|
165, 14, 44, 176,
|
||||||
|
51, 109, 182, 123,
|
||||||
|
191, 120
|
||||||
|
],
|
||||||
|
payload: Uint8Array(20) [
|
||||||
|
146, 138, 59, 185, 191, 122,
|
||||||
|
139, 103, 124, 131, 182, 236,
|
||||||
|
7, 22, 249, 221, 16, 0,
|
||||||
|
42, 6
|
||||||
|
],
|
||||||
|
routeType: 1,
|
||||||
|
payloadVersion: 0,
|
||||||
|
payloadType: 1,
|
||||||
|
pathHashCount: 10,
|
||||||
|
pathHashSize: 1,
|
||||||
|
pathHashBytes: 10,
|
||||||
|
pathHashes: [
|
||||||
|
'a5', '0e', '2c',
|
||||||
|
'b0', '33', '6d',
|
||||||
|
'b6', '7b', 'bf',
|
||||||
|
'78'
|
||||||
|
]
|
||||||
|
}
|
||||||
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Build the library:
|
## Identities
|
||||||
|
|
||||||
```bash
|
The package supports:
|
||||||
npm run build
|
- `Identity` for public key management.
|
||||||
```
|
- `LocalIdentity` for private key management.
|
||||||
|
- `Contact` for managing named identities.
|
||||||
3. Use the build output from the `dist/` folder or publish to npm.
|
- `Group` for managing groups.
|
||||||
|
- `KeyManager` for managing all of the above and handling decryption.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "meshcore",
|
"name": "@hamradio/meshcore",
|
||||||
"version": "1.1.1",
|
"version": "1.1.3",
|
||||||
"description": "MeshCore protocol support for Typescript",
|
"description": "MeshCore protocol support for Typescript",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"MeshCore",
|
"MeshCore",
|
||||||
@@ -9,7 +9,7 @@
|
|||||||
],
|
],
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://git.maze.io/ham/meshcore.js"
|
"url": "https://git.maze.io/ham/meshcore.js"
|
||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"author": "Wijnand Modderman-Lenstra",
|
"author": "Wijnand Modderman-Lenstra",
|
||||||
|
|||||||
21
src/index.ts
21
src/index.ts
@@ -1,11 +1,20 @@
|
|||||||
export * from './identity';
|
export * from './identity';
|
||||||
export * from './identity.types';
|
import * as identityTypes from './identity.types';
|
||||||
export type * from './identity.types';
|
import type * as identityTypesTypes from './identity.types';
|
||||||
|
|
||||||
export * from './crypto';
|
export * from './crypto';
|
||||||
export * from './crypto.types';
|
import * as cryptoTypes from './crypto.types';
|
||||||
export type * from './crypto.types';
|
import type * as cryptoTypesTypes from './crypto.types';
|
||||||
|
|
||||||
export * from './packet';
|
export * from './packet';
|
||||||
export * from './packet.types';
|
import * as packetTypes from './packet.types';
|
||||||
export type * from './packet.types';
|
import type * as packetTypesTypes from './packet.types';
|
||||||
|
|
||||||
|
export type {
|
||||||
|
identityTypes,
|
||||||
|
identityTypesTypes,
|
||||||
|
cryptoTypes,
|
||||||
|
cryptoTypesTypes,
|
||||||
|
packetTypes,
|
||||||
|
packetTypesTypes
|
||||||
|
};
|
||||||
|
|||||||
@@ -52,13 +52,13 @@ export class Packet implements IPacket {
|
|||||||
this.payloadVersion = (header >> 6) & 0x03;
|
this.payloadVersion = (header >> 6) & 0x03;
|
||||||
this.payloadType = (header >> 2) & 0x0f;
|
this.payloadType = (header >> 2) & 0x0f;
|
||||||
|
|
||||||
this.pathHashCount = (pathLength >> 6) + 1;
|
this.pathHashSize = (pathLength >> 6) + 1;
|
||||||
this.pathHashSize = pathLength & 0x3f;
|
this.pathHashCount = pathLength & 0x3f;
|
||||||
this.pathHashBytes = this.pathHashCount * this.pathHashSize;
|
this.pathHashBytes = this.pathHashCount * this.pathHashSize;
|
||||||
|
|
||||||
this.pathHashes = [];
|
this.pathHashes = [];
|
||||||
for (let i = 0; i < this.pathHashCount; i++) {
|
for (let i = 0; i < this.pathHashBytes; i += this.pathHashSize) {
|
||||||
const hashBytes = this.path.slice(i * this.pathHashSize, (i + 1) * this.pathHashSize);
|
const hashBytes = this.path.slice(i, i + this.pathHashSize);
|
||||||
const hashHex = bytesToHex(hashBytes);
|
const hashHex = bytesToHex(hashBytes);
|
||||||
this.pathHashes.push(hashHex);
|
this.pathHashes.push(hashHex);
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user