@portkey/did

• Prerequisites
• Package.json Scripts
• Getting Started
  • Installation
    • Using NPM
    • Using Yarn
• @portkey/did API Reference
  • did.setConfig
  • did.login
    • type: loginAccount
    • type: scan
    • getLoginStatus
  • logout
  • register
    • getRegisterStatus
  • getHolderInfo
  • getVerifierServers
  • services
    • services.getVerificationCode
    • services.verifyVerificationCode
    • services.verifyGoogleToken
    • services.verifyAppleToken
    • services.sendAppleUserExtraInfo

Prerequisites

• :gear: NodeJS (LTS/Fermium)
• :toolbox: Yarn/Lerna

Package.json Scripts

Script	Description
clean	Uses rm to remove dist/
build	Uses tsc to build package and dependent packages
lint	Uses eslint to lint package
lint:fix	Uses eslint to check and fix any warnings
format	Uses prettier to format the code

Getting Started

The @portkey/did library is a collection of modules that contain functionality for the did ecosystem.

• @portkey/accounts is for the portkey account.
• @portkey/utils is for the portkey utils.
• @portkey/contracts is for the portkey contracts.
• @portkey/graphql is for the portkey graphql.
• @portkey/request is for the portkey request.
• @portkey/types is for the portkey types.
• @portkey/utils is for the portkey utils.
• @portkey/validator is for the portkey validator.

Installation

Using NPM

1npm install @portkey/did

Using Yarn

1yarn add @portkey/did

After that you need configure did server node、graphQL node、storage suite.

1class Store implements IStorageSuite {
2  async getItem(key: string) {
3    return localStorage.getItem(key);
4  }
5  async setItem(key: string, value: string) {
6    return localStorage.setItem(key, value);
7  }
8  async removeItem(key: string) {
9    return localStorage.removeItem(key);
10  }
11}
12did.setConfig({
13  requestDefaults: {
14    baseURL: 'your did server node',
15    timeout: 'timeout', // optional default 8000ms
16  },
17  graphQLUrl: 'your graphQL node',
18  storageMethod: new Store(),
19});

That’s it! now you can use the did object.

@portkey/did API Reference

did.setConfig

Where you configure did server node, graphQL node, storage suite.

1did.setConfig({
2  requestDefaults: {
3    baseURL: 'you did server node',
4    timeout: 'timeout', // optional default 8000ms
5  },
6  graphQLUrl: 'your graphQL node',
7  storageMethod: 'your storage suite',
8});

did.login

type: loginAccount

Email or mobile phone number or Google or Apple login.

1did.login(type: 'loginAccount', params: AccountLoginParams): Promise<LoginResult>;

Example

1did.login('loginAccount', {
2  chainId: 'chainId',
3  loginGuardianIdentifier: 'loginGuardianIdentifier',
4  guardiansApproved: [
5    {
6      type: 'Email',
7      identifier: 'identifier',
8      verifierId: 'verifierId',
9      verificationDoc: 'verificationDoc',
10      signature: 'signature',
11    },
12  ],
13  extraData: 'extraData',
14  context: {
15    requestId: 'requestId',
16    clientId: 'clientId',
17  },
18});

type: scan

Logged in management to add management.

1login(type: 'scan', params: ScanLoginParams): Promise<true>;

Example

1did.login('scan',{
2  chainId: 'chainId',
3  caHash: 'caHash',
4  managerInfo: {
5    address: 'address',
6    extraData: 'extraData'
7  };
8})

getLoginStatus

1getLoginStatus(params: { chainId: ChainId; sessionId: string }): Promise<RecoverStatusResult>;

Example

1did.getLoginStatus({
2  chainId: 'chainId',
3  sessionId: 'sessionId',
4});

logout

1logout(params: EditManagerParams): Promise<boolean>;

Example

1did.logout({ chainId: 'chainId' });

register

1register(params: Omit<RegisterParams, 'manager'>): Promise<RegisterResult>;

Example

1did.register({
2  type: 'Email',
3  loginGuardianIdentifier: 'loginGuardianIdentifier',
4  extraData: 'extraData',
5  chainId: 'chainId',
6  verifierId: 'verifierId',
7  verificationDoc: 'verificationDoc',
8  signature: 'signature',
9  context: {
10    requestId: 'requestId',
11    clientId: 'clientId',
12  },
13});

getRegisterStatus

1getRegisterStatus(params: { chainId: ChainId; sessionId: string }): Promise<RegisterStatusResult>;

Example

1did.getRegisterStatus({
2  chainId: 'chainId',
3  sessionId: 'sessionId',
4});

getHolderInfo

getHolderInfo by graphQL.

1getHolderInfo(params: Pick<GetHolderInfoParams, 'manager' | 'chainId'>): Promise<GetCAHolderByManagerResult>;

Example

1did.getHolderInfo({
2  manager: 'manager', // optional
3  chainId: 'chainId',
4});

getHolderInfo by server.

1getHolderInfo(params: Omit<GetHolderInfoParams, 'manager'>): Promise<IHolderInfo>;

Example

1did.getHolderInfo({
2  caHash: 'caHash', // loginGuardianIdentifier and caHash choose one
3  loginGuardianIdentifier: 'loginGuardianIdentifier', // loginGuardianIdentifier and caHash choose one
4  chainId: 'chainId',
5});

getVerifierServers

Get the VerifierServer information of the corresponding chain.

1getVerifierServers(chainId: ChainId): Promise<VerifierItem[]>;

Example

1did.getVerifierServers({
2  chainId: 'chainId',
3});

check manager is exist

Check whether the manager has management permissions for the account.

1checkManagerIsExist(params:{chainId: ChainId, caHash:string, manager:string}): Promise<boolean>;

Example

1did.checkManagerIsExist({
2  chainId: 'chainId',
3  caHash: 'caHash',
4  manager: 'manager'
5});

services

services.getVerificationCode

send verification code.

1getVerificationCode(params: SendVerificationCodeRequestParams): Promise<SendVerificationCodeResult>;

Example

1did.services.getVerificationCode({
2  params: {
3    chainId: 'chainId',
4    guardianIdentifier: 'guardianIdentifier',
5    type: 'Email',
6    verifierId: 'verifierId',
7    operationType: 'operationType',
8  },
9  headers: {
10    reCaptchaToken: 'reCaptchaToken',
11  },
12});

operationType types

services.verifyVerificationCode

verify verification code.

1verifyVerificationCode(params: VerifyVerificationCodeParams): Promise<VerifyVerificationCodeResult>;

Example

1did.services.verifyVerificationCode({
2  verifierSessionId: 'verifierSessionId',
3  chainId: 'chainId',
4  guardianIdentifier: 'guardianIdentifier',
5  verifierId: 'verifierId',
6  verificationCode: 'verificationCode',
7  operationType: 'operationType',
8});

services.verifyGoogleToken

verify Google token.

1verifyGoogleToken(params: VerifierSocialTokenParams): Promise<VerifyVerificationCodeResult>;

Example

1did.services.verifyGoogleToken({
2  chainId: 'chainId',
3  accessToken: 'accessToken',
4  verifierId: 'verifierId',
5  operationType: 'operationType',
6});

services.verifyAppleToken

verify Apple token.

1verifyAppleToken(params: VerifyAppleTokenParams): Promise<VerifyVerificationCodeResult>;

Example

1did.services.verifyAppleToken({
2  chainId: 'chainId',
3  verifierId: 'verifierId',
4  identityToken: 'identityToken',
5  operationType: 'operationType',
6});

services.sendAppleUserExtraInfo

send Apple user extra info.

1sendAppleUserExtraInfo(params: SendAppleUserExtraInfoParams): Promise<SendAppleUserExtraInfoResult>;

Example

1did.services.sendAppleUserExtraInfo({
2  identityToken: 'identityToken',
3  userInfo: {
4    name: {
5      firstName: 'firstName',
6      lastName: 'lastName',
7    },
8    email: 'email',
9  },
10});