interledgerjs / btp-packet Goto Github PK

Packet parser for Bilateral Transfer Protocol

TypeScript 100.00%

btp-packet's Introduction

Interledger.js Monorepo

Packages

Payments

Name	Version	Description
`@interledger/pay`		Send payments over Interledger using STREAM
`@interledger/stream-receiver`		Simple & composable stateless STREAM receiver

Utilities

Name	Version	Description
`ilp-logger`		Debug logging utility for Interledger modules
`ilp-packet`		Serialization/deserialization utility for ILP packets
`ilp-plugin`		Connect to a local, open BTP server
`ilp-plugin-btp`		One plugin to rule them all
`ilp-protocol-ccp`		Serialization/deserialization for the CCP routing protocol
`ilp-protocol-ildcp`		Fetch asset and account details from a parent
`ilp-protocol-stream`		Reliably send streams of money and data over ILP
`oer-utils`		Tools for OER parsing and serialization

Installation

The monorepo is set up to use lerna and pnpm workspaces. To get started run the following:

pnpm install - pnpm will install the dependencies and do the necessary linking (no need to run lerna bootstrap).
pnpm build
pnpm test - This will run the tests in all the packages.

Running script commands

Script commands such as test and lint can be run from the root of the project by running:

# Run tests for all packages
pnpm test

# Run tests for a specific module a package
pnpm test --scope=<package-name>

Or in the package directory:

pnpm test

If you are interested in contributing, please read the contributing guidelines.

For Maintainers

Versioning

Independent versioning is used for this project and releases can only be made from master. You will need to set the GH_TOKEN env variable to your personal GitHub access token. Please make sure that you are up to date with master and that the tests and linting pass. Then use the following to create a release:

# On master
GH_TOKEN=<github-token> lerna version --conventional-commits --create-release github

and follow the command prompts. This will commit the package version changes and create the necessary tags - all of which will be pushed to master. It will also create changelogs and official GitHub releases.

If you want to release an alpha then run

# On master
GH_TOKEN=<github-token> lerna version --conventional-commits --conventional-prerelease --create-release github

This will append -alpha.<alpha-version> to the release name. The alpha release can be graduated (1.0.1-alpha.1 => 1.0.1) by running:

# On master
GH_TOKEN=<github-token> lerna version --conventional-commits --conventional-graduate --create-release github

Adding new packages

All source code is expected to be TypeScript and is placed in the src folder. Tests are put in the test folder. The NPM package will not contain any TypeScript files (*.ts) but will have typings and source maps. A typical project should have the following structure:

|-- src
|-- test
|-- package.json
|-- tsconfig.build.json

The tsconfig.build.json file should have the following

{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "composite": true,
    "baseUrl": ".",
    "rootDir": "src",
    "outDir": "dist",
    "tsBuildInfoFile": "./dist/tsconfig.build.tsbuildinfo"
  },
  "include": [
    "src"
  ]
}

The package.json file should specify the following

{
  "name": "<package-name>",
  "license": "Apache-2.0",
  "publishConfig": {
    "access": "public"
  }
}

In the scripts section of the package.json, be sure to have build, cover (which runs tests with coverage) and codecov. These will be called from the CI pipeline. Please use the following as a guideline:

"scripts": {
  "build": "tsc -p tsconfig.build.json",
  "cover": "...",
  "codecov": "curl -s https://codecov.io/bash | bash -s - -s coverage -F <flagname>"
}

The cover script should run the tests with code coverage and output the coverage results in a format that can be uploaded to codecov. The flagname will be used by codecov to track coverage per package. Please make sure it matches the regex ^[a-z0-9_]{1,45}$.

Importing legacy modules

This process preserves the commit history of the legacy modules.

git clone [email protected]:adrianhopebailie/interledgerjs.git
git clone [email protected]:interledgerjs/legacy-module.git
cd legacy-module
git pull
cd ../interledgerjs
lerna import ../legacy-module --dest=packages --preserve-commit --flatten

You then need to replace the tsconfig.json file with the tsconfig.build.json and update the package.json as described above.

Dependencies

We keep devDependencies that are shared across all packages in the root package.json file. Dependencies can be added to individual packages using Lerna

lerna add <package to install> --scope=<package-name>

# Add dev dependency
lerna add <package to install> --scope=<package-name> --dev

Running script commands

Script commands such as test and lint can be run from the root of the project by running

# All tests in all packages
lerna run test

#Scoping to a package
lerna run test --scope=<package-name>

btp-packet's People

Contributors

Stargazers

Watchers

Forkers

kattmingming berilac interledger-ripple

btp-packet's Issues

Don't base64-encode conditions and fulfillments

Just like liquidity curves are left as buffers in https://github.com/interledgerjs/ilp-packet#ilqpliquidityresponse, we should leave conditions and fulfillments as buffers too.

We also already pass ILP payments, and other protocol data as buffers.

This goes for both the values returned by deserialize functions and the values expected by serialize functions, although for the latter, just like for the rejectionReason, we can overload, so if you give it a string instead of a buffer, it should still interpret it as base64.

An in-range update of codecov is breaking the build 🚨

The devDependency codecov was updated from `3.4.0` to `3.5.0`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

codecov is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ ci/circleci: test: Your tests failed on CircleCI (Details).

Commits

The new version differs by 3 commits.

e98d176 v3.5.0
c7741f2 Patch cves 755 813 (#130)
03256a4 feat(services): add TeamCity CI (#131)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Fix Code Coverage in CI

An in-range update of @types/node is breaking the build 🚨

The devDependency @types/node was updated from `10.12.13` to `10.12.14`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ ci/circleci: test: Your tests failed on CircleCI (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Don't wrap packet data in VarOctetString

https://github.com/interledgerjs/clp-packet/blob/master/index.js#L101 should probably just write contents, not a VarOctetString containing it?

An in-range update of oer-utils is breaking the build 🚨

The dependency oer-utils was updated from `3.0.1` to `3.1.0`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

oer-utils is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

❌ ci/circleci: test: Your tests failed on CircleCI (Details).

Commits

The new version differs by 5 commits.

4a0fd30 3.1.0
e0813c4 fix: reject variable integers of length zero
3cdb8ab chore: re-enable code coverage reporting
c072342 chore: update dependencies
f3dc629 feat: allow using JS numbers instead of BigNumbers

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

sequence-of prefix, 2 or 8 bytes?

http://www.oss.com/asn1/resources/books-whitepapers-pubs/Overview%20of%20OER.pdf says
the quantity field of a sequence-of type is encoded as an unsigned binary integer in eight octets, doesn't that contradict what was implemented in https://github.com/interledgerjs/clp-packet/blob/master/index.js#L85-L86?

Time is incorrectly encoded

Issue
The time in the packets is not encoded in a way that the OER document under RFCs suggests:
If the millisecond part is zero, it MUST be left out. Trailing zeros in the millisecond part MUST be left out. (OER Notes)

Code to reproduce

import dateFormat = require('dateformat');

const fn = d => Buffer.from(dateFormat(d, "UTC:yyyymmddHHMMss.l'Z'")).toString();

console.log(fn(new Date('2017-08-28T18:32:00.000Z')));
console.log(fn(new Date('2017-08-28T18:32:00.010Z')));
console.log(fn(new Date('2017-08-28T18:32:00.100Z')));

Results
20170828183200.000Z should be 20170828183200Z
20170828183200.010Z should be 20170828183200.01Z
20170828183200.100Z should be 20170828183200.1Z

An in-range update of @types/chai is breaking the build 🚨

The devDependency @types/chai was updated from `4.2.2` to `4.2.3`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/chai is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ ci/circleci: test: Your tests failed on CircleCI (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

interledgerjs / btp-packet Goto Github PK

btp-packet's Introduction

Interledger.js Monorepo

Packages

Payments

Utilities

Installation

Running script commands

For Maintainers

Versioning

Adding new packages

Importing legacy modules

Dependencies

Running script commands

btp-packet's People

Contributors

Stargazers

Watchers

Forkers

btp-packet's Issues

The devDependency codecov was updated from 3.4.0 to 3.5.0.

The devDependency @types/node was updated from 10.12.13 to 10.12.14.

The dependency oer-utils was updated from 3.0.1 to 3.1.0.

The devDependency @types/chai was updated from 4.2.2 to 4.2.3.

Recommend Projects

Recommend Topics

Recommend Org

The devDependency codecov was updated from `3.4.0` to `3.5.0`.

The devDependency @types/node was updated from `10.12.13` to `10.12.14`.

The dependency oer-utils was updated from `3.0.1` to `3.1.0`.

The devDependency @types/chai was updated from `4.2.2` to `4.2.3`.