PolkADAPT is an Augmented Data Application Protocol Technology for Multichains that aims to be a framework that offers a data abstraction layer for applications by providing one single multichain namespace.
Namespace: “A namespace is a set of signs (names) that are used to identify and refer to objects of various kinds. A namespace ensures that all of a given set of objects have unique names so that they can be easily identified. Namespaces are commonly structured as hierarchies to allow reuse of names in different contexts. In computer programming, namespaces are typically employed for the purpose of grouping symbols and identifiers around a particular functionality and to avoid name collisions between multiple identifiers that share the same name.”
PolkADAPT offers one single hierarchical namespace for an entire heterogeneous multichain. In particular it offers a single namespace for the multichain’s relay chain and all its specialized shard chains in a hierarchical manner. PolkADAPT is the central registry to avoid name collisions. In its core PolkADAPT proxies the on-chain functionality that PolkadotJS provides.
PolkADAPT Adapters can register their functionality in PolkADAPT’s central namespace. The Adapters define in what way the central hierarchical namespace allows for retrieval, augmentation and extension of the data in a uniform way.
You're looking at the project workspace and source repository for the @polkadapt NPM packages. This workspace was generated with Angular to leverage the testing and building tools that come with it.
Note: Angular is not a dependency of the resulting project libraries. You don't need Angular to use PolkADAPT in your application. The @polkadapt packages are not tied to any application development framework, so you can use this in React, Vue, Angular, etc.
To use PolkADAPT in your application, follow the installation instructions in the README file of @polkadapt/core (or projects/core/README.md).
If you wish to develop and build the packages yourself, install the workspace development dependencies (npm install) and build the libraries with the command npm run build. The resulting package files are stored in the dist directory.
If you would like to learn about the build environment, please check out the Angular libary documentation.
We aim to keep the build environment updated with the latest versions. Version ranges can be found in the root package.json file.
The npm install command will automatically update the build environment's dependencies.
For all of our individually published packages there's no need to regularly change dependency versions in code, unless building fails with a newer dependency version. That's why it's recommended to test the build process for every new version of a dependency. If the build fails, it's time to fix, build and publish a new version of our package.
The npm run build command will automatically update individual package dependencies before building.
For substrate-rpc, we chose to allow a specific version range of @polkadot/api as a peer dependency, which means that application developers must install a version (preferably the latest) within this range as a dependency of their applications.
Angular has some tooling to help upgrade the build environment to a newer stack.
# It's recommended to have @angular/cli installed globally:
npm -g install @angular/cli
# To update an existing installation:
npm -g update @angular/cli
# To upgrade the build environment, run this command
# in the same directory as this README:
ng update @angular/cli @angular/core --allow-dirty
# Sometimes we want to compare project structure and
# dependencies with a new blank Angular project.
# Outside of this repository, you can run:
ng new --strict --create-application=false testdir
# You now have a directory 'testdir' to compare with.
# Generate a library in it, so all remaining
# dependencies are installed as well:
cd testdir
ng generate library my-lib
# You can now compare these files with our project, e.g. package.json, angular.json.