2.15.2 • Published 9 months ago

@portkey/did v2.15.2

Weekly downloads
-
License
ISC
Repository
github
Last release
9 months ago

ES Version Node Version NPM Package Version

Prerequisites

Package.json Scripts

ScriptDescription
cleanUses rm to remove dist/
buildUses tsc to build package and dependent packages
lintUses eslint to lint package
lint:fixUses eslint to check and fix any warnings
formatUses 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

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 mobile phone number or Google or Apple login.

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

Example

did.login('loginAccount', {
  chainId: 'chainId',
  loginGuardianIdentifier: 'loginGuardianIdentifier',
  guardiansApproved: [
    {
      type: 'Email',
      identifier: 'identifier',
      verifierId: 'verifierId',
      verificationDoc: 'verificationDoc',
      signature: 'signature',
    },
  ],
  extraData: 'extraData',
  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',
  managerInfo: {
    address: 'address',
    extraData: 'extraData'
  };
})

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, 'manager'>): Promise<RegisterResult>;

Example

did.register({
  type: 'Email',
  loginGuardianIdentifier: 'loginGuardianIdentifier',
  extraData: 'extraData',
  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, 'manager' | 'chainId'>): Promise<GetCAHolderByManagerResult>;

Example

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

getHolderInfo by server.

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

Example

did.getHolderInfo({
  caHash: 'caHash', // loginGuardianIdentifier and caHash choose one
  loginGuardianIdentifier: 'loginGuardianIdentifier', // loginGuardianIdentifier 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',
});

check manager is exist

Check whether the manager has management permissions for the account.

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

Example

did.checkManagerIsExist({
  chainId: 'chainId',
  caHash: 'caHash',
  manager: 'manager'
});

services

services.getVerificationCode

send verification code.

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

Example

did.services.getVerificationCode({
  params: {
    chainId: 'chainId',
    guardianIdentifier: 'guardianIdentifier',
    type: 'Email',
    verifierId: 'verifierId',
    operationType: 'operationType',
  },
  headers: {
    reCaptchaToken: 'reCaptchaToken',
  },
});

operationType types

services.verifyVerificationCode

verify verification code.

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

Example

did.services.verifyVerificationCode({
  verifierSessionId: 'verifierSessionId',
  chainId: 'chainId',
  guardianIdentifier: 'guardianIdentifier',
  verifierId: 'verifierId',
  verificationCode: 'verificationCode',
  operationType: 'operationType',
});

services.verifyGoogleToken

verify Google token.

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

Example

did.services.verifyGoogleToken({
  chainId: 'chainId',
  accessToken: 'accessToken',
  verifierId: 'verifierId',
  operationType: 'operationType',
});

services.verifyAppleToken

verify Apple token.

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

Example

did.services.verifyAppleToken({
  chainId: 'chainId',
  verifierId: 'verifierId',
  identityToken: 'identityToken',
  operationType: 'operationType',
});

services.sendAppleUserExtraInfo

send Apple user extra info.

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

Example

did.services.sendAppleUserExtraInfo({
  identityToken: 'identityToken',
  userInfo: {
    name: {
      firstName: 'firstName',
      lastName: 'lastName',
    },
    email: 'email',
  },
});
2.15.2

9 months ago

2.15.2-alpha.0

9 months ago

2.15.0

9 months ago

2.15.1

9 months ago

2.14.2-alpha.0

9 months ago

2.14.0-alpha.7

9 months ago

2.14.0-alpha.6

9 months ago

2.14.0-alpha.5

9 months ago

2.14.0-alpha.4

9 months ago

2.14.0-alpha.3

9 months ago

2.14.0-alpha.2

9 months ago

2.14.0-alpha.1

9 months ago

2.13.3-alpha.1

9 months ago

2.13.3-alpha.0

9 months ago

2.13.3-alpha.2

9 months ago

2.14.0-alpha.0

9 months ago

2.13.2

9 months ago

2.12.1-alpha.1

9 months ago

2.13.0

9 months ago

2.13.1

9 months ago

2.12.1-alpha.0

9 months ago

2.11.1-alpha.0

9 months ago

2.11.0

9 months ago

2.11.0-alpha.13

10 months ago

2.11.0-alpha.12

10 months ago

2.11.0-alpha.15

10 months ago

2.11.0-alpha.14

10 months ago

2.11.0-alpha.16

10 months ago

2.11.0-alpha.11

10 months ago

2.11.0-alpha.10

10 months ago

2.10.6-alpha.10

10 months ago

2.10.6-alpha.14

10 months ago

2.10.6-alpha.9

10 months ago

2.10.6-alpha.8

10 months ago

2.10.6-alpha.6

10 months ago

2.10.6-alpha.5

10 months ago

2.10.6-alpha.4

10 months ago

2.11.0-alpha.8

10 months ago

2.11.0-alpha.7

10 months ago

2.11.0-alpha.9

10 months ago

2.11.0-alpha.4

10 months ago

2.11.0-alpha.3

10 months ago

2.11.0-alpha.6

10 months ago

2.11.0-alpha.2

10 months ago

2.11.0-alpha.1

10 months ago

2.12.0-alpha.1

9 months ago

2.12.0-alpha.2

9 months ago

2.12.0

9 months ago

2.11.0-alpha.0

10 months ago

2.10.5

10 months ago

2.10.4

10 months ago

2.10.6-alpha.1

10 months ago

2.10.6-alpha.0

10 months ago

2.10.1

10 months ago

2.10.2

10 months ago

2.9.6-alpha.6

11 months ago

2.9.6-alpha.5

11 months ago

2.9.6-alpha.4

11 months ago

2.9.6-alpha.3

11 months ago

2.9.6-alpha.2

11 months ago

2.9.4

11 months ago

2.8.1

11 months ago

2.9.1

11 months ago

2.1.7-alpha.0

1 year ago

2.1.7-alpha.1

1 year ago

2.8.0

11 months ago

2.7.2

12 months ago

2.7.1

12 months ago

2.6.6-alpha.0

1 year ago

2.7.1-alpha.4

12 months ago

2.7.1-alpha.3

12 months ago

2.7.1-alpha.1

1 year ago

2.7.1-alpha.0

1 year ago

2.6.7

1 year ago

2.6.6

1 year ago

2.6.8

1 year ago

2.5.6

1 year ago

2.5.5

1 year ago

2.6.5

1 year ago

2.6.4

1 year ago

2.6.3-alpha.2

1 year ago

2.6.3

1 year ago

2.5.2

1 year ago

2.5.4

1 year ago

2.6.3-alpha.1

1 year ago

2.6.3-alpha.0

1 year ago

2.6.2

1 year ago

2.5.0

1 year ago

2.5.1

1 year ago

2.6.1

1 year ago

2.6.0

1 year ago

2.5.0-alpha.52

1 year ago

2.6.0-alpha.4

1 year ago

2.5.0-alpha.51

1 year ago

2.5.0-alpha.50

1 year ago

2.6.0-alpha.3

1 year ago

2.5.0-alpha.49

1 year ago

2.5.0-alpha.48

1 year ago

2.5.0-alpha.47

1 year ago

2.5.0-alpha.46

1 year ago

2.5.0-alpha.42

1 year ago

2.5.0-alpha.41

1 year ago

2.5.0-alpha.38

1 year ago

2.5.0-alpha.37

1 year ago

2.5.0-alpha.36

1 year ago

2.4.5

1 year ago

2.5.0-alpha.35

1 year ago

2.5.0-alpha.34

1 year ago

2.5.0-alpha.33

1 year ago

2.5.0-alpha.32

1 year ago

2.5.0-alpha.31

1 year ago

2.5.0-alpha.30

1 year ago

2.5.0-alpha.29

1 year ago

2.5.0-alpha.28

1 year ago

2.5.0-alpha.27

1 year ago

2.5.0-alpha.26

1 year ago

2.5.0-alpha.25

1 year ago

2.4.4

1 year ago

2.4.4-alpha.0

1 year ago

2.4.4-alpha.1

1 year ago

2.5.0-alpha.24

1 year ago

2.5.0-alpha.23

1 year ago

2.5.0-alpha.22

1 year ago

2.5.0-alpha.20

1 year ago

2.5.0-alpha.19

1 year ago

2.5.0-alpha.18

1 year ago

2.5.0-alpha.17

1 year ago

2.5.0-alpha.16

1 year ago

2.5.0-alpha.15

1 year ago

2.5.0-alpha.7

1 year ago

2.5.0-alpha.8

1 year ago

2.5.0-alpha.5

1 year ago

2.5.0-alpha.4

1 year ago

2.5.0-alpha.14

1 year ago

2.5.0-alpha.13

1 year ago

2.5.0-alpha.12

1 year ago

2.5.0-alpha.3

1 year ago

2.5.0-alpha.2

1 year ago

2.4.2-alpha.4

1 year ago

2.4.3

1 year ago

2.4.2-alpha.5

1 year ago

2.4.2-alpha.6

1 year ago

2.4.2-alpha.7

1 year ago

2.4.2-alpha.8

1 year ago

2.4.2-alpha.9

1 year ago

2.5.0-alpha.1

1 year ago

2.5.0-alpha.0

1 year ago

2.4.2-alpha.1

1 year ago

2.4.2-alpha.3

1 year ago

2.4.2-alpha.0

1 year ago

2.4.1

1 year ago

2.4.0

1 year ago

2.3.3-alpha.1

1 year ago

2.3.2

1 year ago

2.3.1

1 year ago

2.3.0

1 year ago

2.2.1-alpha.0

1 year ago

2.2.0

1 year ago

2.1.1

1 year ago

2.1.0

1 year ago

2.0.5

1 year ago

2.0.4

1 year ago

2.0.4-alpha.1

1 year ago

2.0.4-alpha.0

1 year ago

2.0.3

1 year ago

2.1.0-alpha.0

1 year ago

2.0.2

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

2.0.1-alpha.1

1 year ago

2.0.1-alpha.2

1 year ago

2.0.0-alpha.28

1 year ago

2.0.0-alpha.27

1 year ago

2.0.0-alpha.26

1 year ago

2.0.0-alpha.25

1 year ago

2.0.0-alpha.24

1 year ago

2.0.0-alpha.22

1 year ago

2.0.0-alpha.21

1 year ago

2.0.0-alpha.23

1 year ago

2.0.1-alpha.0

1 year ago

2.0.0-alpha.20

1 year ago

2.0.0-alpha.19

1 year ago

2.0.0-alpha.18

1 year ago

2.0.0-alpha.17

1 year ago

2.0.0-alpha.16

1 year ago

2.0.0-alpha.15

1 year ago

2.0.0-alpha.14

1 year ago

2.0.0-alpha.13

1 year ago

2.0.0-alpha.12

1 year ago

2.0.0-alpha.9

1 year ago

2.0.0-alpha.11

1 year ago

2.0.0-alpha.10

1 year ago

2.0.0-alpha.7

1 year ago

2.0.0-alpha.8

1 year ago

2.0.0-alpha.6

1 year ago

2.0.0-alpha.4

1 year ago

2.0.0-alpha.5

1 year ago

2.0.0-alpha.3

1 year ago

2.0.0-alpha.1

2 years ago

1.5.5-alpha.1

2 years ago

1.5.5-alpha.2

2 years ago

1.5.5-alpha.0

2 years ago

1.5.4-alpha.2

2 years ago

1.5.2-alpha.3

2 years ago

1.5.4-alpha.1

2 years ago

2.0.0-alpha.0

2 years ago

1.5.4-alpha.0

2 years ago

1.5.3

2 years ago

1.5.2

2 years ago

0.0.2-alpha.3

2 years ago

1.5.2-alpha.0

2 years ago

0.0.2-alpha.2

2 years ago

1.2.0

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.0.0-alpha.8

2 years ago

1.0.0-alpha.7

2 years ago

1.0.0-alpha.6

2 years ago

1.0.0-alpha.5

2 years ago

1.0.0-alpha.4

2 years ago

1.0.0-alpha.3

2 years ago

1.0.0-alpha.2

2 years ago

1.5.0-alpha.23

2 years ago

1.5.0-alpha.20

2 years ago

1.5.0-alpha.22

2 years ago

1.5.0-alpha.21

2 years ago

1.3.0-alpha.0

2 years ago

1.3.0-alpha.2

2 years ago

1.3.0-alpha.1

2 years ago

1.3.0-alpha.3

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.4.1-alpha.0

2 years ago

1.4.1-alpha.1

2 years ago

1.4.1-alpha.2

2 years ago

1.5.1

2 years ago

1.5.0

2 years ago

1.5.0-alpha.1

2 years ago

1.4.4-alpha.3

2 years ago

1.4.4-alpha.2

2 years ago

1.4.4-alpha.1

2 years ago

1.4.4-alpha.0

2 years ago

1.4.4-alpha.7

2 years ago

1.4.4-alpha.6

2 years ago

1.4.4-alpha.5

2 years ago

1.4.4-alpha.4

2 years ago

1.5.0-alpha.17

2 years ago

1.5.0-alpha.16

2 years ago

1.5.0-alpha.19

2 years ago

1.5.0-alpha.18

2 years ago

1.5.0-alpha.13

2 years ago

1.5.0-alpha.12

2 years ago

1.5.0-alpha.15

2 years ago

1.5.0-alpha.5

2 years ago

1.5.0-alpha.14

2 years ago

1.5.0-alpha.6

2 years ago

1.5.0-alpha.7

2 years ago

1.5.0-alpha.8

2 years ago

1.5.0-alpha.11

2 years ago

1.5.0-alpha.9

2 years ago

1.5.0-alpha.10

2 years ago

1.4.0-alpha.0

2 years ago

1.0.2

2 years ago

1.4.0-alpha.1

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

1.4.0-alpha.3

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.4.3

2 years ago

1.0.7

2 years ago

1.4.2

2 years ago

1.4.1

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.5.1-alpha.1

2 years ago

1.5.1-alpha.0

2 years ago

1.5.1-alpha.5

2 years ago

1.5.1-alpha.4

2 years ago

1.5.1-alpha.3

2 years ago

1.5.1-alpha.2

2 years ago

1.5.1-alpha.8

2 years ago

1.5.1-alpha.6

2 years ago

1.0.5-alpha.0

2 years ago

1.1.0-alpha.1

2 years ago

1.1.0-alpha.2

2 years ago

1.1.0-alpha.0

2 years ago

1.1.0-alpha.5

2 years ago

1.1.0-alpha.6

2 years ago

1.1.0-alpha.3

2 years ago

1.1.0-alpha.4

2 years ago

1.0.10

2 years ago

1.0.0-alpha.0

2 years ago

0.0.1-alpha.9.0

2 years ago

0.0.1-alpha.8.8

2 years ago

0.0.1-alpha.8.9

2 years ago

0.0.1-alpha.3.5

2 years ago

0.0.1-alpha.3.6

2 years ago

0.0.1-alpha.3.4

2 years ago

0.0.1-alpha.3.7

2 years ago

0.0.1-alpha.3.8

2 years ago

0.0.1-alpha.3.2

2 years ago

0.0.1-alpha.3.3

2 years ago

0.0.1-alpha.3.1

2 years ago

0.0.1-alpha.3.0

2 years ago

0.0.1-alpha.2.8

2 years ago

0.0.1-alpha.2.9

2 years ago

0.0.1-alpha.2.6

2 years ago

0.0.1-alpha.2.7

2 years ago

0.0.1-alpha.2.5

2 years ago

0.0.1-alpha.2.4

2 years ago

0.0.1-alpha.2.2

2 years ago

0.0.1-alpha.2.3

2 years ago

0.0.1-alpha.2.1

2 years ago

0.0.1-alpha.2.0

2 years ago

0.0.1-alpha.1.9

2 years ago

0.0.1-alpha.1.8

2 years ago

0.0.1-alpha.1.7

2 years ago

0.0.1-alpha.1.6

2 years ago

0.0.1-alpha.1.5

2 years ago

0.0.1-alpha.1.4

2 years ago

0.0.1-alpha.1

2 years ago