Skip to main content
Version: V1

Connect with JS SDK

The CyberConnect SDK provides two primary functions, connect and disconnect, which in social graphs are follow and unfollow.

The library encapsulates the complex authentication logic (authenticate to Ceramic Network) into easy-to-use functions.

You can directly test out the CyberConnect SDK in the sandbox from Create a Connection section or check out the source code on Github.

Installation​

For installation, simply run:

npm install @cyberlab/cyberconnect

User Flow​

In general, there are two steps needed from users to write connection data.

1. Initiation Action​

The user starts by clicking the follow/unfollow button on the website, it should invoke connect function in the JavaScript library.

2. Sign MetaMask Message​

This step is needed only when it's the user's first action in the current session. The user doesn't need to sign MetaMask message again for the following actions.

After the user signs the first message, the library will generate a derived signing key stored in the memory for the safety of future interactions with Ceramic Network.

Basic Usage​

Init CyberConnect​

import CyberConnect, { Env, Blockchain } from "@cyberlab/cyberconnect";

const cyberConnect = new CyberConnect({
  namespace: "CyberConnect",
  env: Env.Production,
  chain: Blockchain.ETH,
  provider: provider,
  signingMessageEntity: "CyberConnect" || "YOUR_ENTITY_HERE",
});
  • namespace - The namespace you want to use. We recommend you use your application name as namespace and hence, you can later filter out connections from your platform. If empty value of namespace is given, the connection will be put into the default, CyberConnect namespace. See details on namespace page.
  • env - (optional) Env decides the endpoints. Now we have staging and production. (The default value is Env.Production).
  • chain - (optional) The blockchain you want to connect with. Now we support Ethereum and Solana. (The default is Blockchain.ETH).
  • provider - The corresponding provider of the given chain.
  • signingMessageEntity - (optional) Use to describe the entity users sign their message with. Users will see it when authorizing in the wallet I authorize ${signingMessageEntity} from this device using signing key. The default entity is CyberConnect.

Connect​

cyberConnect.connect(targetAddr, alias, connectionType);
  • targetAddr - The target wallet address to connect.
  • alias - (optional) Alias for the target address.
  • connectionType - (optional) The type of the connection. The default value is Connection.FOLLOW. See Connection Type for more details.

Disconnect​

cyberConnect.disconnect(targetAddr);
  • targetAddr - The target wallet address to disconnect.

BatchConnect​

cyberConnect.batchConnect(targetAddrs, connectionType);
  • targetAddrs - A list of wallet addresses to connect.
  • connectionType - (optional) The type of the connection. The default value is Connection.FOLLOW. See Connection Type for more details.

SetAlias​

cyberConnect.setAlias(targetAddr, alias);
  • targetAddr - The target wallet address to disconnect.
  • alias - The alias for the target address.

BidirectionalConnect​

cyberConnect.bidirectionalConnect(targetAddr, biConnectType);
  • targetAddr - The target wallet address to disconnect.
  • biConnectionType - The type of the bidirectional connection. See BiConnection Type for more details.

Learn more about bidirectional Connection here

AckNotifications​

cyberConnect.ackNotifications(notificationIds);
  • notificationIds - A list of notificationId .

Learn more about notification here.

AckAllNotifications​

cyberConnect.ackAllNotifications();

Learn more about notification here.

Connection Type​

You can create different types of connections for different purposes (e.g. you can like a NFT by creating a LIKE connection from you to the NFT).

import { ConnectionType } from "@cyberlab/cyberconnect";

cyberConnect.connect(targetAddr, alias, ConnectionType.LIKE);

The types we support: FOLLOW, LIKE, REPORT, WATCH and VOTE.

info

Only one type connection can be created from one to another, which means you can't create both FOLLOW connection and LIKE connection from you to "Ryan".

BiConnection Type​

You can create different types of bi-connections for different purposes (e.g. you can send a request by using INIT type or accept a request by using ACCEPT type).

import { BiConnectionType } from "@cyberlab/cyberconnect";

cyberConnect.bidirectionalConnect(targetAddr, BiConnectionType.INIT);

The types we support: INIT, ACCEPT, REJECT, TERMINATE, BLOCK and UNBLOCK.

Solana​

You can get Solana provider from @solana/wallet-adapter-react

import { useWallet } from "@solana/wallet-adapter-react";
const solanaProvider = useWallet();
info

You need to pass chainRef when you connect to Solana. Now we have three options: Solana.SOLANA_MAINNET_CHAIN_REF, Solana.SOLANA_DEVNET_CHAIN_REF and Solana.SOLANA_TESTNET_CHAIN_REF.

import CyberConnect, { Env, Blockchain, Solana } from "@cyberlab/cyberconnect";

const cyberConnect = new CyberConnect({
  namespace: "CyberConnect",
  env: Env.Production,
  chain: Blockchain.ETH,
  provider: solanaProvider,
  chainRef: Solana.SOLANA_MAINNET_CHAIN_REF,
});
Designed by