@zkPass/Transgate-JS-SDK is Now Open-source.

We are thrilled to announce the launch of @zkPass/Transgate-JS-SDK, an open-source toolkit tailored for developers.

This SDK enhances third-party Decentralized Applications (DApps) by facilitating effortless integration with the zkPass TransGate extension. Developers can leverage this SDK to link their DApps with the zkPass TransGate browser extension, empowering users to selectively and privately authenticate their private data across any HTTPS website, eliminating the need for OAuth API authorization.

Integration Guide

To begin integration:
1) Setup: Ensure your DApp environment is compatible with JavaScript ES6 or later. Register and Configure your Project in the zkPass Dev Center.

1. Login zkPass dev center and connect your wallet.
2. Create a new project by providing the necessary information.
3. Upon project creation, you will receive an appid.
4. Add a schema by choosing a category and a base schema.
5. Customize the assertions as required.
6. After submission, a unique schemaId will be generated. Please note that while schemas cannot be modified once created, they can be deleted.

2) Incorporate TransGate JS-SDK: Install the SDK using either npm or yarn, then integrate the TransGate JS-SDK into your project:

const verify = async () => {
  try {
    // The appid of the project created in dev center
    const appid = "8fb9d43c-2f24-424e-a98d-7ba34a5532f5"

    // Create the connector instance
    const connector = new TransgateConnect(appid)

    // Check if the TransGate extension is installed
    // If it returns false, please prompt to install it from chrome web store
    const isAvailable = await connector.isTransgateAvailable()

    if (isAvailable) {
      // The schema id of the project
      const schemaId = "516a720e-29a4-4307-ae7b-5aec286e446e"

      // Launch the process of verification
      // This method can be invoked in a loop when dealing with multiple schemas
      const res = await connector.launch(schemaId)

      // verifiy the res onchain/offchain based on the requirement     
      
    } else {
      console.log('Please install TransGate')
    }
  } catch (error) {
    console.log('transgate error', error)
  }
}

• TransGate extension can be downloaded from Chrome Web Store.
• Make sure the DApp’s domain matches the project configuration in the dev center.

3) Configuration: Set up the SDK according to your DApp’s specific parameters, as outlined in our comprehensive Integration Documentation.
4) Testing: Use the supplied test suites to confirm smooth integration and identify any potential problems.

How It Works

The zkPass Transgate-JS-SDK links your DApp with TransGate, facilitating ZK verification. This procedure involves the user preparing for verification, the DApp initiating the SDK, and communication with the allocator node and TransGate. After login, the verification process starts, establishing a 3P-TLS connection and generating a zk-proof. The validator node then verifies this proof and returns the result to the DApp through the SDK.

Why zkPass Transgate-JS-SDK

The zkPass Transgate-JS-SDK offers a seamless way to integrate zkPass into your applications, providing privacy-preserving verification and compatibility with HTTPS websites. It supports 3P-TLS for secure data verification and includes anti-cheating mechanisms and memory-efficient zero-knowledge proofs (ZKPs). The SDK’s versatility makes it ideal for a wide range of applications where trust and privacy are of utmost importance.

Conclusion

zkPass is bridging the gap between web private data and the evolving web3 ecosystem. By utilizing the zkPass Transgate-JS-SDK, developers can incorporate advanced privacy-preserving verification mechanisms into their DApps, enhancing user trust and data integrity. This integration is facilitated through a user-friendly process that includes schema creation, TransGate extension compatibility, and a comprehensive verification workflow.

With its focus on user privacy, versatile application scenarios, and a commitment to ongoing development and support. zkPass enables developers to build more secure, efficient, and user-focused applications, This contributes to the broader vision of a more private and decentralized web.

Whether you’re developing decentralized identity solutions, social apps, DeFi protocols, parametric insurance or any application that requires secure, trusted and private data verification, the zkPass Transgate-JS-SDK provides the necessary and flexibility tools to meet these challenges head-on.

Community and Support

Join our Discord for support, discussions, and collaboration.

zkPass Links:

Website | Twitter | Discord | Medium | Github