@hyperledger/cactus-core-api
Advanced tools
Contains type definitions/interfaces for the kernel of the codebase. Kept separate from the implementation so that it is easier to use it as a dependency.
This package is meant to be depended on by most of the other packages for interface definitions, abstract classes and generated code. All of which is to be kept with as few dependencies as possible in order to reduce the potential for circular dependencies.
From the above it also comes that the core-api package is rarely used by developers who are implementing projects with Hyperledger Cactus and instead it is mostly consumed by the framework's other packages internally (e.g. the Hyperledger Cactus contributors).
You can install the package via your favorite package manager.
Yarn:
yarn add --exact @hyperledger/cactus-core-api
npm:
npm install --save-exact=true @hyperledger/cactus-core-api
We highly recommend using exact versions in general when managing your dependencies in order to achieve (or get closer to) reproducible builds and to enhance your security posture against malicious package versions that might get pushed to the registries without the knowledge or consent or well intentioned maintainers.
import {
GetKeychainEntryRequestV1,
isICactusPlugin,
IEndpointAuthzOptions,
IExpressRequestHandler,
IWebServiceEndpoint,
} from "@hyperledger/cactus-core-api";
if (!isICactusPlugin(plugin)) {
throw new Error(`PluginRegistry#add() plugin not an ICactusPlugin`);
}
To test the Rust build, you need to run either one of the following:
yarn lerna run proto:protoc-gen-rust (from the project root)
or a regular cargo build from the core-api package directory, e.g.:
cd packages/cactus-core-api/
cargo build
If you prefer to use make that also works from the package directory:
cd packages/cactus-core-api/
make
The protocol buffer to Rust compilation is not yet part of the project build by default because we need some time to include the Rust toolchain in the project-wide list of build dependencies for developers.
FAQs
Contains type definitions/interfaces for the kernel of the codebase. Kept separate from the implementation so that it is easier to use it as a dependency.
The npm package @hyperledger/cactus-core-api receives a total of 162 weekly downloads. As such, @hyperledger/cactus-core-api popularity was classified as not popular.
We found that @hyperledger/cactus-core-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.