CyberConnect
The JavaScript library provides CyberConnect
class which includes functions to allows users to control their decentralized identity(DIDs) and social graph data. The library encapsulates the complex authentication logic (authenticate to Ceramic Network) into easy-to-use functions.
CyberConnect API.
Getting started
Installation
npm install @cyberlab/cyberconnect
or
yarn add @cyberlab/cyberconnect
Basic usage
Init CyberConnect
import CyberConnect, {
Env,
Blockchain,
} from 'npm install @cyberlab/cyberconnect';
const cyberConnect = new CyberConnect({
namespace: 'CyberConnect',
env: Env.Production,
chain: Blockchain.ETH,
provider: provider,
signingMessageEntity: 'CyberConnect' || your entity,
});
namespace
- Your applciation name.env
- (optional) Env decides the endpoints. Now we havestaging
andproduction
. (The default value isEnv.Production
).chain
- (optional) The blockchain you want to connect with. Now we supportethereum
andsolana
. (The default isBlockchain.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 walletI authorize ${signingMessageEntity} from this device using signing key:
. The default entity isCyberConnect
.
See Solana for Solana demo.
Authenticate
The authenticate()
includes two signs for AuthProvider
and Capi10Link.
All users should sign for AuthProvider
every session.
Only first time users need to sign for Capi10Link
and it may takes 5-10 seconds.
Only authenticate once if call cyberconnect.authenticate()
multiple time.
You can run cyberconnect.authenticate()
somewhere before doing connect
to do the authentication first, then the user doesn't need to sign when calling connect
.
You can also call connect
directly, then the user have to sign during the function call.
await cyberConnect.authenticate();
Connect
cyberConnect.connect(targetAddr, alias);
targetAddr
- The target wallet address to connect.alias
- (optional) Alias for the target address.
Disconnect
cyberConnect.disconnect(targetAddr);
targetAddr
- The target wallet address to disconnect.
SetAlias
cyberConnect.setAlias(targetAddr, alias);
targetAddr
- The target wallet address to disconnect.alias
- The alias for the target address.
Solana
You can get Solana provider from @solana/wallet-adapter-react
import { useWallet } from '@solana/wallet-adapter-react';
const solanaProvider = useWallet();
Note: 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 'npm install @cyberlab/cyberconnect';
const cyberConnect = new CyberConnect({
namespace: 'CyberConnect',
env: Env.Production,
chain: Blockchain.ETH,
provider: solanaProvider,
chainRef: Solana.SOLANA_MAINNET_CHAIN_REF,
});
Contributing
We are happy to accept small and large contributions, feel free to make a suggestion or submit a pull request.