Welcome to the Züs Example Webapp! This web application demonstrates the usage of the zus-js-sdk to interact with the 0chain blockchain.
See the Live Preview here: https://dev-zus-webapp.zus.network
Züs is a high-performance cloud on a fast blockchain offering privacy and configurable uptime. It is an alternative to traditional cloud S3 and has shown better performance on a test network due to its parallel data architecture. The technology uses erasure code to distribute the data between data and parity servers. Züs storage is configurable to provide flexibility for IT managers to design for desired security and uptime, and can design a hybrid or a multi-cloud architecture with a few clicks using Blimp's workflow, and can change redundancy and providers on the fly.
For instance, the user can start with 10 data and 5 parity providers and select where they are located globally, and later decide to add a provider on-the-fly to increase resilience, performance, or switch to a lower cost provider.
Users can also add their own servers to the network to operate in a hybrid cloud architecture. Such flexibility allows the user to improve their regulatory, content distribution, and security requirements with a true multi-cloud architecture. Users can also construct a private cloud with all of their own servers rented across the globe to have a better content distribution, highly available network, higher performance, and lower cost.
The QoS protocol is time-based where the blockchain challenges a provider on a file that the provider must respond within a certain time based on its size to pass. This forces the provider to have a good server and data center performance to earn rewards and income.
The privacy protocol from Züs is unique where a user can easily share their encrypted data with their business partners, friends, and family through a proxy key sharing protocol, where the key is given to the providers, and they re-encrypt the data using the proxy key so that only the recipient can decrypt it with their private key.
Züs has ecosystem apps to encourage traditional storage consumption such as Blimp, a S3 server and cloud migration platform, and Vult, a personal cloud app to store encrypted data and share privately with friends and family, and Chalk, a zero upfront cost permanent storage solution for NFT artists.
Other apps are Bolt, a wallet that is very secure with air-gapped 2FA split-key protocol to prevent hacks from compromising your digital assets, and it enables you to stake and earn from the storage providers; Atlus, a blockchain explorer and Chimney, which allows anyone to join the network and earn using their server or by just renting one, with no prior knowledge required.
Follow the steps below to run the webapp.
To install the dependencies, run the following command:
npm install
# or
yarnStart the development server using the following command:
npm run dev
# or
yarn devOnce the server is running, open http://localhost:3000 in your browser to see the result.
This webapp covers demo for two product lines of Zus i.e. bolt and vult.
Bolt is a cryptocurrency wallet for exchanging ZCN ERC-20 and Ethereum tokens. It also supports token staking, allowing users to earn rewards.
Vult is a decentralized anonymous file-sharing platform. Users can upload files and securely share them with others.
Both Bolt and Vult rely on the zus-js-sdk to interact with the 0chain blockchain.
Follow the step-by-step guide below to create a webapp using the Zus JS SDK:
- Set up a webapp using Next.js or any other framework of your choice.
- Install the Zus JS SDK by running either of the following commands:
npm install @zerochain/zus-sdkyarn add @zerochain/zus-sdk
-
Download the latest build of wasm(goSdk), and place it in the same dicrectory as your app's entrypoint. In most cases it would be the public or dist directory. You can get the latest build of wasm from the first action on this page. How to download wasm?
-
Add these two scripts to the
headof your entrypoint html file. These scripts are required by wasm for it's operations.
<script src="https://cdn.jsdelivr.net/gh/herumi/[email protected]/browser/bls.js"></script>
<script src="https://cdn.jsdelivr.net/gh/golang/[email protected]/misc/wasm/wasm_exec.js"></script>- Initialize the Zus JS SDK by following the zus-js-sdk documentation:
import { init } from '@zerochain/zus-sdk'
// default config
const configJson = {
chainId: '0afc093ffb509f059c55478bc1a60351cef7b4e9c008a53a6cc8241ca8617dfe',
signatureScheme: 'bls0chain',
minConfirmation: 50,
minSubmit: 50,
confirmationChainLength: 3,
blockWorker: 'https://demo.zus.network/dns',
zboxHost: 'https://0box.demo.zus.network',
defaultSharderConsensous: 3,
}
const config = [
configJson.chainId,
configJson.blockWorker,
configJson.signatureScheme,
configJson.minConfirmation,
configJson.minSubmit,
configJson.confirmationChainLength,
configJson.zboxHost,
configJson.zboxAppType,
configJson.defaultSharderConsensous,
]
await init(config)-
Utilize the Zus JS SDK's methods to interact with the 0chain blockchain. Refer to the zus-js-sdk documentation for detailed information.
-
Create a wallet using the Zus JS SDK's
createWalletmethod. This method returns a wallet object containing the public and private keys.
import { createWallet } from '@zerochain/zus-sdk'
const wallet = await createWallet()
// save the wallet in local storage by using Redux or any other state management library- Set your wallet in the Zus JS SDK by using the
setWalletmethod. This method takes the walletId, privateKey, publicKey, and mnemonic as parameters.
import { setWallet } from '@zerochain/zus-sdk'
await setWallet(walletId, privateKey, publicKey, mnemonic)- Use the Zus JS SDK's
getBalancemethod to get the balance of your wallet. This method takes the walletId as a parameter.
import { getBalance } from '@zerochain/zus-sdk'
const balance = await getBalance(walletId)- Use the Zus JS SDK's
createAllocationmethod to create an allocation. This method takes the allocation config object as a parameter.
import { createAllocation } from '@zerochain/zus-sdk'
// default config
const config = {
datashards: 2,
parityshards: 2,
size: 1073741824,
expiry: Math.round(new Date().getTime() / 1000) + 2628000,
minReadPrice: 0,
maxReadPrice: 10000000000,
minWritePrice: 0,
maxWritePrice: 10000000000,
lock: 10450000000,
}
const allocation = await createAllocation(config)
// save the allocation in local storage by using Redux or any other state management libraryExplore this demo webapp's source code to learn more about how to use the Zus JS SDK.
Here are some common terms used in our code and the 0chain blockchain:
- Blobber: A blobber is a storage provider that stores files on behalf of users. Blobbers are paid in ZCN tokens for storing and serving files.
- Allocation: An allocation is a group of blobbers used to store files. It defines storage and payment parameters and is paid in ZCN tokens.
- Miners: Miners are the nodes that run the 0chain blockchain and are rewarded in ZCN tokens.
- Sharders: Sharders are the nodes that run the 0chain blockchain and are rewarded in ZCN tokens.
- Wallet: A wallet is a collection of keys used to sign transactions. It is used for blobbers, miners, sharders, and users.
- ZCN: ZCN is the token used to pay miners, sharders, blobbers, and users.
- ERC20: ERC20 is the token format used by ZCN and Ethereum.
- Public Key: A public key is used to verify a signature and transactions.
- Private Key: A private key is used to sign transactions.
- Signature: A signature verifies that a transaction was signed by a private key.
- Mnemonics: Mnemonics are a set of words used to generate a wallet for a user.
Join our Hackathon Discord community for support and discussions: