pokt-network/pocket-aat-js

Application Authentication Token SDK

Pocket-AAT-JS

Generate to-spec AAT tokens for your Pocket JavaScript applications easily using this SDK. Current supported version of the AAT specification supported by this library: 0.0.1. For more details, please reference the AAT documentation.

Overview

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Requirements

You should have at least have a basic knowledge of blockchain technology and know your way around JavaScript. You will also need to install the NPM tool.

Installation

npm install --save @pokt-network/aat-js

Documentation

// First require the PocketAAT class
const PocketAAT = require('@pokt-network/aat-js');

// Define the arguments needed to build an AAT
const clientPublicKey = 'b70382156da53d4274f655961e8b1aa0950aa7f4';
const applicationPublicKey = 'a85f3577dcfe59bfed60b3ed013c739ac875237f98a98735dfa13733b0ced42d';
const applicationPrivateKey = 'f70196f8f9246c957e4947c1be09da98c405aebc1a4e2...';

(async () => {
  try {
      // Create a new PocketAAT instance
      var pocketAAT = await PocketAAT.from('0.0.1', clientPublicKey, applicationPublicKey, applicationPrivateKey);
      
      // Example JSON output
      console.log(JSON.stringify(pocketAAT));
  } catch (e) {
      console.log(e);
  }
})();

Running the tests

npm run test

Contributing

Please read CONTRIBUTING.md for details on contributions and the process of submitting pull requests.

Support & Contact

License

This project is licensed under the MIT License; see the LICENSE.md file for details.

pocket-aat-js's Issues

Create a constructor for an already pre-signed AAT

Describe the solution you'd like
Whenever an AAT already exists and it's being pre-signed, the PocketAAT class should have a constructor to build such an object with pre-existing data.

Installing as a NPM package doesn't include any javascript files.

Describe the bug
When installed as a NPM package, the resulting installed package doesn't include any source files to be imported by the project.

To Reproduce
Steps to reproduce the behavior:

1. npm install pokt-network/pocket-aat-js#staging
2. Go into the node_modules/pocket-aat-js directory of the project
3. Inspect the files to see that the source files or the dist files are missing.

Expected behavior

1. npm install pokt-network/pocket-aat-js#staging
2. Go into the node_modules/pocket-aat-js directory of the project
3. Inspect the files to see that the source files or the dist javascript files are present.
4. Import the pocket-aat-js dependency in the code succesfully.

Fix missing repo image

Documentation updates

Describe the solution you'd like
Update the repository documentation and issue templates to match Organization standards.

V0.1.2 release

The new release includes:

• Dependency alert changes.
• Supported Node version update.

Add issue templates & feature requests

Add signature and hashing

Add both sign and hash functions with the respective packages to match Pocket Core current format for the AAT as per the provided documentation @ https://github.com/pokt-network/pocket-core/blob/staging/doc/application-auth-token.md

Update package version to 0.1.1-rc

Signature object key names are not matching pocket-core

Signature is not matching pocket-core due to the object keys order and names not matching, this will generate a different hash and change the end result.

Create base project structure

Create the base of the project structure.

As per discussion typescript if the best option.

Add documentation

Create README tutorial.
Document code.

Add unit tests

Add proper test for initializing the instance, failing to initialize, hashing and signing.

Package can't be installed from github

Describe the bug
Package can't be installed from github

To Reproduce
npm install --save pokt-network/pocket-aat-js#staging

Expected behavior
The package must be correctly installed.

Test

This is just a test for Discourse integration.

Update README to match spec

README should match repo-template / README spec doc

https://docs.google.com/document/d/1DW761zObVqvykSbw-vSlJua1_ABDBHwxbbneTGF_buA/edit

Replace actual ed25519 dependency

Actual ed25519 dependency only works with node versions equals or below 10.19. Replace with our own fork of the library that supports node v12.15.

@pokt-network/ed25519

Update the library with the new Pocket-JS interface changes

README is out of date

Creating a Pocket AAT is now an async process.

Add CI configuration

Update package for rc-0.0.2

Application signature doesn't match specs

Describe the bug
The application signature generated by the pocketAAT is not matching the expected results as per the specs.

Change testing framework to Chai

Describe the solution you'd like
In order to make it consistent with the rest of the organization Typescript/Javascript projects, the testing framework should be Chai.

Additional context
Currently Jest is being used.

Refactor PocketAAT interface

Change the PocketAAT constructor to handle signature creation during instantiation.
Expose all of PocketAAT properties as public.

Add CLI

Add a CLI to manually generate AAT's via CLI.

Add validation to all of the PocketAAT attributes

Describe the solution you'd like
Currently the PocketAAT class doesn't validate it's 4 core attributes for validity:

• version: Should be checked against the supported versions by the library.
• clientPublicKey: Should be checked against length and format (currently hex only is supported)
• applicationPublicKey: Should be checked against length and format (currently hex only is supported)
• applicationSignature: Should be checked against length and format (currently hex only is supported), also it should be checked against the applicationPublicKey to make sure the signature belongs to that applicationPublicKey.