The examples make use of mock routing and testing feature loginForTest to demonstrate the API usage.
loginForTest function will create a client without sending autorisation request to the Authenticator and allows to run these samples as Standalone code.
In production code, it would be a necessity to authenticate with the authenticator and get the URI for connecting to the SAFE Network on user's behalf. Example code for authenticator authorisation can be reffered from the documentation example snippet. After the URI is obtained, fromAuthURI function can be used to connect to the network.
Obtaining the URI from authenticator is skipped and these examples are intended to demonstrate the API usage.
The safe_app_node is installed in dev mode for using the Mock Network with the testing features enabled.
Run npm install and this command will install the dependencies in dev mode.
You can discuss development-related questions on the SAFE Dev Forum. If you are just starting to develop an application for the SAFE Network, it's very advisable to visit the SAFE Network Dev Hub where you will find a lot of relevant information, including a tutorial to create an example SAFE desktop application which makes use of this package, as well as an introduction for understanding the SAFE Network data types and default containers.
Demonstrates the ImmutableData API for writing data in the SAFE Network and to read the same from the SAFE Network using plain cipher opt. The data stored is plain and can be read by anyone who has the address of the DataMap.
Execute npm run idata_plain for running this example.
Demonstrates the ImmutableData API for writing data in the SAFE Network and encrypting/decrypting the DataMap with Asymmetric Cipher opt.
Execute npm run idata_asymmetric for running this example.
Demonstrates the ImmutableData API for writing data in the SAFE Network and encrypting/decrypting the DataMap with Symmetric Cipher opt.
Execute npm run idata_symmetric for running this example.
Demonstrates the MutableData API for creating and updating a private MutableData. Also showcases serialise and deserialise APIs for privte MutableData.
Execute npm run mdata_private for running this example.
Demonstrates the MutableData API for creating and updating public MutableData. Emulate the MutableData as NFS for inserting the file to a mutable data, reading the content from the file using NFS API.
Execute npm run mdata_public for running this example.
This SAFE Network library is dual-licensed under the Modified BSD (LICENSE-BSD https://opensource.org/licenses/BSD-3-Clause) or the MIT license (LICENSE-MIT https://opensource.org/licenses/MIT) at your option.
Copyrights in the SAFE Network are retained by their contributors. No copyright assignment is required to contribute to this project.