Skip to main content

Quick Start

Let us build privacy-preserving dApps with Arcana SDKs!

The figure below shows various Arcana Network platform components and what the dApp developers can use these for.

note

🚀 Want to get started in minutes? 🕒

Use Arcana's ready-to-use code samples, tutorials in the Arcana Academy!

Latest SDK Release

Check out Arcana Release Notes. Also refer to the latest Auth SDK Reference Guide and Storage SDK Reference Guide.

For details on the latest SDK release and past versions, see Auth SDK Release page and Storage SDK Release page on GitHub. To receive notifications when a new release for Arcana Auth or Arcana Storage is published, watch releases.

Get Started

To get started, you can try one of these options:

  1. Build a Demo dApp from scratch using a template and boilerplate code.

  2. Follow the instructions to integrate your dApp with the Arcana SDKs.

Option A: Build a Demo dApp

What you will build: Sample Demo dApp

What you need to do:

What the demo dApp does:

  • Integrates with the Auth SDK to onboard users via social authentication: Google OAuth and passwordless mechanisms.
  • Integrates with the Storage SDK. Allows users to upload data to the Arcana Store and enable access control.
    • Share Files
    • Revoke Access
    • Change File Owner
    • Delete



note

Before jumping into Option A implementation, you can test drive Arcana's demo app deployed at the link below:

https://demo.beta.arcana.network/

Option B: Integrate your dApp

If you chose this option, let us assume that you already have a dApp where you need to plug in Arcana functionality. If you are wondering where to begin and whether you need to integrate with one or more of the Arcana SDKs, it is recommended that you first take stock of your dApp requirements.

tip

Where to begin?

First figure out what Arcana Network platform components are needed for your dApp and then begin integrating! ☑️

Get insights about when to use which Arcana SDK in the context of your dApp requirements, and then Get Started!.

Let us say a dApp requires to address the following requirements:

i. Social Authethentication: Enable Web2-like user onboarding experience in the dApp

ii. Blockchain Transaction Approval: Allow dApp users to sign blockchain transactions using a Web3 wallet

iii. User Data Privacy & Access Control: Enable dApp users to store data in the Arcana Store and control data access

To address these requirements in your dApp, follow the steps below.

Step 1: Register and Configure dApp

Register and configure your dApp at the Arcana Developer Dashboard:

https://dashboard.beta.arcana.network

The dashboard assigns a unique App Address to each registered dApp.

Make sure you save the App Address assigned to your dApp. This will be required for integrating your dApp with Arcana SDKs in the next step.

For details about various dashboard settings and how they control Arcana SDK usage, see Arcana Dashboard Configuration Guide.

Step 2️: Integrate Arcana SDKs

tip

To address requirements i.) and ii.) listed above, the dApp must integrate with the Auth SDK.

If the dApp requires to address only requirement iii.) it must integrate with both the Auth as well as the Storage SDK.

The Storage SDK requires a Web3 Provider to sign blockchain transactions corresponding to storage operations such as file upload to the Arcana Store or accessing a file from the Arcana Store. Auth SDK provides an embedded Web3 wallet, the Arcana wallet, that works along with the Storage SDK to handle blockchain interactions for storage operations.

Alternatively, you can use one of the supported third-party Web3 wallets.

Auth SDK

Install Arcana Auth SDK. See Auth SDK usage guide and integrate your dApp with the Auth SDK.

Once Auth SDK is integrated, your dApp can easily onboard users via social authentication, passwordless login, and use the embedded Arcana web wallet features for signing blockchain transactions. Users can quickly get started with Web3 transactions without having to set up a traditional web wallet.

Storage SDK

Install Arcana Storage SDK. See Storage SDK usage guide and integrate your dApp with the Storage SDK.

After Storage SDK is integrated, your dApp can allow users to store data in Arcana Store and gain complete ownership, user data privacy and access control of their data.

🎉 That's all! Your dApp is now Arcana SDK enabled! 🏆

info

Does it require a lot of code to start using Arcana SDKs? No

You need to simply integrate SDKs and call the SDK functions.

Here is a typical use case example with code snippets.

See Also

note

We would love to hear your feedback on how you plan to use Arcana Network SDKs.

Contact Arcana support.