Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@arianee/arianee-privacy-gateway-client
Advanced tools
This is a TypeScript library that provides a client to interact with the Arianee Privacy Gateway. The Arianee Privacy Gateway is used to retrieve content of private non-fungible tokens (NFTs).
Readme
This is a TypeScript library that provides a client to interact with the Arianee Privacy Gateway. The Arianee Privacy Gateway is used to retrieve content of private non-fungible tokens (NFTs).
To use the library, you need to import the ArianeePrivacyGatewayClient
class and create a new instance of it with the following parameters:
auth
: An instance of the Core
class from the @arianee/core
package, an Arianee access token as a string, or an object containing a message and a signature.fetchLike
: A function that behaves like the fetch
function, used to make HTTP requests.The ArianeePrivacyGatewayClient
class provides the following methods:
certificateRead
This method retrieves the (original) content of a NFT. If the NFT was updated, you need to use updateRead
instead.
async certificateRead(
rpcUrl: RpcUrl,
{
certificateId,
passphrase,
}: {
certificateId: string;
passphrase?: string;
}
): Promise<ArianeeProductCertificateI18N>;
updateRead
This method retrieves the updated content of a NFT.
async updateRead(
rpcUrl: RpcUrl,
{
certificateId,
passphrase,
}: {
certificateId: string;
passphrase?: string;
}
): Promise<ArianeeProductCertificateI18N>;
messageRead
This method retrieves the content of a private NFT message.
async messageRead(
rpcUrl: RpcUrl,
{
messageId,
}: {
messageId: string;
}
): Promise<ArianeeMessageI18N>;
eventRead
This method retrieves the content of a private NFT event.
async eventRead(
rpcUrl: RpcUrl,
{
certificateId,
eventId,
passphrase,
}: {
certificateId: string;
eventId: string;
passphrase?: string;
}
): Promise<ArianeeEventI18N>;
The library supports two types of authentication: Arianee access tokens and message/signature authentication. If you pass an instance of the Core class as the auth parameter, the library will use an Arianee access token generated using the Core instance to authenticate requests. If you pass an object with a message and a signature property, the library will use message/signature authentication.
Errors are automatically handled by the library, whenever an error is returned by the privacy gateway, the client will throw a PrivacyGatewayError
with the following properties:
message
: The error message.privacyGatewayErrorEnum
: The value of the PrivacyGatewayErrorEnum (from @arianee/common-types
) associated to the error.FAQs
This is a TypeScript library that provides a client to interact with the Arianee Privacy Gateway. The Arianee Privacy Gateway is used to retrieve content of private non-fungible tokens (NFTs).
The npm package @arianee/arianee-privacy-gateway-client receives a total of 142 weekly downloads. As such, @arianee/arianee-privacy-gateway-client popularity was classified as not popular.
We found that @arianee/arianee-privacy-gateway-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.