portkey-wallet / portkey-web

Typescript SDKs for developers to create our own app with portkey did solution/protocol.

portkey-web

Statements	Branches	Functions	Lines

Packages

Package	Version	Size	Link
@portkey/did
@portkey/accounts
@portkey/contracts
@portkey/graphql
@portkey/request
@portkey/services
@portkey/types
@portkey/utils
@portkey/validator
@portkey/socket
UI Packages
@portkey/did-ui-react

Get start

for users

Program start

yarn

# build packages
yarn build

# try to run test
yarn test

How to program in the portkey sdk

Write you interface and test case at first.

For example, if we want to run did.init();

// first step
// in interface files
export interface IDid {
  init(): boolean;
}
// second step
// intest files list did.test.ts
describe('did', () => {
  test('did init', () => {
    expect(did.init()).resolves.toBeTrue(); // true
  });
});

// third step
// implement the interface
class Did implements IDid {
  init() {
    return true;
  }
}

# run your test
npx jest ./packages/did/test/did.test.ts
# if passed, success

Loop the steps to get an awesome program.

IoC

@injectable()
class Did implements IDid {
  init() {
    return true;
  }
}

Node: jest will help us to write a better program with ioc.

portkey-web's Issues

portkey web

Implement registration flow

may i ask what are extraData, manager, clientId? how can i get those and pass them to register func? thanks
my steps:

1. get captcha token
2. did.services.getRecommendationVerifier({ chainId: 'AELF' }) -> verifier
3. did.services.getVerificationCode()
4. did.services.verifyVerificationCode()
5. did.services.register

Developing zklogin sdk

Expected Behavior

Developing zklogin sdk

Specifications

As a user, I would like to set a verify so that use zk.

Features:

• zk verify

Development Tasks:

• add nonce to auth for apple and google guaridan type

Dependencies

none

References

none

Portkey Security SDK Secondary Mailbox

Expected Behavior

Users should be able to set up an auxiliary email so that when performing various Guardian authorization operations, the system can send operation authorization prompt emails to the auxiliary email set by the user.

Specifications

As a user, I would like to set up an auxiliary email to receive operation authorization prompt emails when performing Guardian authorization operations.

Features:

• Create auxiliary email details page and setup page.
• Implement sending a verification code to validate the email set.

Development Tasks:

• Create auxiliary email details page and setup page.
• Implement sending a verification code to validate the email.

Dependencies

• Email sending service
• Verification code generation and validation service

References

None

"Invalid Telegram Login Information" inside Telegram bot TMA

TypeError: import_events.default is not a constructor

@portkey/did-ui-react 2.6.6

TypeError: import_events.default is not a constructor

fix：scan login

Expected Behavior

After successfully logging in by scanning the QR code, normal transactions will begin.

Specifications

none

Features:

none

Dependencies

when scan login

References

None

Portkey SDK use Ton Wallet as Guardian

Expected Behavior

Ton Wallet should be available as a new Guardian type within the application. Users should be able to select and use their Ton Wallet to secure their accounts, adding an additional layer of security.

Specifications

As a user, I would like to add Ton Wallet as a new Guardian type so that I can secure my account using my Ton Wallet, providing more flexibility and control over my account security.

Features:

• Add support for Ton Wallet as a Guardian type in the security settings.
• Allow users to link their Ton Wallet to their account as a Guardian.
• Implement UI changes to accommodate Ton Wallet as an option in the Guardian selection process.
• Ensure proper validation and authentication when using Ton Wallet as a Guardian.

Development Tasks:

• Integrate Ton Wallet API to support Guardian functionality.
• Modify the UI to include Ton Wallet as a selectable Guardian option.

Dependencies

Ton Wallet API Documentation

References

Ton Wallet API Documentation