@portkey/did

@portkey/did

• @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

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/contracts 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

npm install @portkey/did

Using Yarn

yarn add @portkey/did

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

class Store implements IStorageSuite {
  async getItem(key: string) {
    return localStorage.getItem(key);
  }
  async setItem(key: string, value: string) {
    return localStorage.setItem(key, value);
  }
  async removeItem(key: string) {
    return localStorage.removeItem(key);
  }
}
did.setConfig({
  requestDefaults: {
    baseURL: 'your did server node',
    timeout: 'timeout', // optional default 8000ms
  },
  graphQLUrl: 'your graphQL node',
  storageMethod: new Store(),
});

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.

did.setConfig({
  requestDefaults: {
    baseURL: 'you did server node',
    timeout: 'timeout', // optional default 8000ms
  },
  graphQLUrl: 'your graphQL node',
  storageMethod: 'your storage suite',
});

did.login

type: loginAccount

Email or phone number login.

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

Example

did.login('loginAccount', {
  chainId: 'chainId',
  loginGuardianAccount: 'loginGuardianAccount',
  guardiansApproved: [
    {
      type: 'Email',
      value: 'value',
      verifierId: 'verifierId',
      verificationDoc: 'verificationDoc',
      signature: 'signature',
    },
  ],
  deviceString: 'deviceString',
  context: {
    requestId: 'requestId',
    clientId: 'clientId',
  },
});

type: scan

Logged in management to add management.

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

Example

did.login('scan',{
  chainId: 'chainId',
  caHash: 'caHash',
  management: {
    managementAddress: 'managementAddress',
    deviceString: 'deviceString';
  };
})

getLoginStatus

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

Example

did.getLoginStatus({
  chainId: 'chainId',
  sessionId: 'sessionId',
});

logout

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

Example

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

register

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

Example

did.register({
  type: 'Email',
  loginGuardianAccount: 'loginGuardianAccount',
  deviceString: 'deviceString',
  chainId: 'chainId',
  verifierId: 'verifierId',
  verificationDoc: 'verificationDoc',
  signature: 'signature',
  context: {
    requestId: 'requestId',
    clientId: 'clientId',
  },
});

getRegisterStatus

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

Example

did.getRegisterStatus({
  chainId: 'chainId',
  sessionId: 'sessionId',
});

getHolderInfo

getHolderInfo by graphQL.

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

Example

did.getHolderInfo({
  managementAddress: 'managementAddress', // optional
  chainId: 'chainId',
});

getHolderInfo by contracts.

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

Example

did.getHolderInfo({
  caHash: 'caHash', // loginGuardianAccount and caHash choose one
  loginGuardianAccount: 'loginGuardianAccount', // loginGuardianAccount and caHash choose one
  chainId: 'chainId',
});

getVerifierServers

Get the VerifierServer information of the corresponding chain.

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

Example

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

services

services.getVerificationCode

send verification code.

getVerificationCode(params: SendVerificationCodeParams): Promise<SendVerificationCodeResult>;

Example

did._services.getVerificationCode({
  chainId: 'chainId',
  guardianAccount: 'guardianAccount',
  type: 'Email',
  verifierId: 'verifierId',
});

services.verifyVerificationCode

verify verification code.

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

Example

did._services.verifyVerificationCode({
  verifierSessionId: 'verifierSessionId',
  chainId: 'chainId',
  guardianAccount: 'guardianAccount',
  verifierId: 'verifierId',
  verificationCode: 'verificationCode',
});