Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
ipfs-core-types
Advanced tools
IPFS interface definitions used by implementations for API compatibility.
IPFS interface definitions used by implementations for API compatibility
The primary goal of this module is to define and ensure that IPFS core implementations and their respective client libraries implement the same interface, so that developers can quickly change between a local and a remote node without having to change their applications.
It offers a set of typescript interface definitions that define the IPFS core API. Once your implementation implements those APIs you can use the tests found in the interface-ipfs-core module to validate your implementation.
In JavaScript land:
$ npm install ipfs-core-types
Install ipfs-core-types
as one of the dependencies of your project and use it to ensure your implementations API compatibility:
/**
* @implements {import('ipfs-core-types').IPFS}
*/
class MyImpl {
// your implementation goes here
}
import type { IPFS } from 'ipfs-core-types'
class MyImpl implements IPFS {
// your implementation goes here
}
In order to validate API compatibility you can run typescript over your implementation which will point out all the API compatibilities if there are some.
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
FAQs
IPFS interface definitions used by implementations for API compatibility.
The npm package ipfs-core-types receives a total of 50,194 weekly downloads. As such, ipfs-core-types popularity was classified as popular.
We found that ipfs-core-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 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
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.