Integration Guide
This guide provides an overview of @nucypher/taco
. In this guide, we will walk through a more complete usage example and explain some of the taco
concepts.
Note that the underlying trust assumptions vary between versions and technologies; these are explained in detail on these pages:
0. Pick an appropriate taco
version
taco
versionBefore we install taco
, we need to consider which network we would like to use:
mainnet
- a production MAINNET environmenttapir
- a stableTESTNET
, for testing integrations, and matchesmainnet
lynx
- a bleeding-edgeDEVNET
, used for internal development and future features
tapir
is the stable testnet recommended for developers.
Once you picked a network, head over to npmjs.com to find the current version for a given network. To find the appriopriate network, refer to the "Tags" column in the "Current Tags" section:
You can learn more about the current state of mainnet
and test networks here:
1. Install and integrate taco
taco
To begin, we need to install the taco
library:
For this guide we'll need a few extra packages:
In order to use taco
, we have to call initialize
method first. This method takes care of initializing the WASM module for taco
dependencies.
With this out of the way, we're ready to use taco
in our app.
2. Describe decryption conditions
Before we encrypt our data, we have to describe the decryption conditions.
Conditions are the requirements for a data recipient to access the plaintext data – i.e. what they will need to prove later to gain decryption rights. There are multiple Condition
types we can use here, including predefined conditions such as ERC721Ownership.
The ERC721Ownership
condition checks the owner of a given token ID. It can be customized by using the ownerOf
contract method and comparing it with the requestor's signature. For more information, see the References section.
We will now specify the conditions that must be met to access the data. In this tutorial, we will require that the requester owns an ERC721 token with a token ID of 5954.
We create more complex conditions by combining them with CompoundCondition
3. Encrypt the plaintext
We're ready to encrypt our plaintext and gate access to the encrypted contents with our conditions, NFTOwnership
.
The resulting messageKit
contains the encrypted data and associated conditions.
4. Request decryption rights
Finally, we will test the conditional access control service by requesting decryption rights:
At decryption time, the requester will be asked to verify their address by signing a message in their wallet. If the requester's address controls the minimum number (or greater) of the specified NFT, they are eligible to receive the requisite number of decryption fragments. By assembling these fragments, they are able to decrypt and view the plaintext encrypted in the previous step.
Note that the requester does not need to manually sign the next time they seek access to the data, as their client can temporarily cache their signature. Fresh plaintexts encrypted under any conditions involving the same wallet address are automatically accessible to any requester who has signed at least once, provided they still fulfill the (new) conditions, and the cached signature has not expired.
Complete example
This is the complete, end-to-end example of taco
integration
Example applications
The following samples showcase integrations with React-based web apps, and serve as an 'end-to-end' reference for creating conditions-based encryption & decryption:
Last updated