maximepremont/licenka

Web3 license manager for the Starton Hackathon by the Pocker team

Web3 license manager for the Starton Hackathon

⚙️ How to setup your project

⚠️ The contracts are currently deployed on the testnet, it is important to use it and not to use the mainnet.

🐳 With Docker (recommanded)

1. Add your Starton API Key API_KEY in the .env file of the project
2. Setup MongoDB vars MONGODB_URI and DB_NAME in the .env file of the project
3. Make sure Docker is working with docker run hello-world
4. Build and start the app with docker compose up

🫳🏼 By hand

It is recommanded to use NVM to have the correct node version.

1. Export your Starton API Key with export API_KEY=xx_xxx_xxxxxxx-xxxx-xxxx-xxxxxxxxxx, replacing xxxxx with your key
2. Export your MongoDB vars with export MONGODB_URI=xxx && export DB_NAME=xxx, replacing xxx with your vars
3. Install the correct version of node with nvm install 18
4. Use the correct version of node with nvm use
5. Install dependencies with npm install
6. Build the app with npm run build
7. Start the app with npm start

You can now access to the app at http://localhost:3000 or http://localhost:80

See the deployed project on licenka.space !

💣 Problem

It is difficult for small businesses to manage their license sale.

After thinking about the tracks proposed in this hackathon, we have finally found this problem: "It's difficult for small businesses to manage their sold licenses" which is into the "E-Society" track.

Nowadays, many companies want to sell their software products through the sale of licenses to its users.
However, in order to be able to sell licenses, these companies are forced to choose between two options: develop their own license and user management solution, or pay another company for a license management service.

In both cases, doing this is very expensive for businesses, which is very complicated for small businesses. This problem can also affect open-source projects, which do not have funds, and which must also find their own solution to make the companies that use the project pay, for example. The other problem that can arise concerns users, indeed if the platform managing their license were to close, there is no longer any evidence that the user has paid the license.

In our opinion, this issue falls within the theme of "Building a decentralized Future" because the important themes of real possession of its information, infallibility and democratization of decentralized technologies are at the heart of the challenges of Web3.

💡 Our solution

To solve this issue, we decided to create a license management platform called Licenka.

The objective of our platform is to make it easy to create a license by defining a price in BUSD and linking a wallet that will receive the funds when purchasing the license.

One of the challenges is to allow companies to use our solution very easily, so we were inspired by Starton in order to offer public API routes allowing companies to very simply buy, and check if a user has a license without Web3 knowledge.

The technologies we used are Next.js for the front and the API, Vercel for the deploy, Docker, MongoDB, Web3.js, Starton API, BNB Chain and we support Ledger.

Our main technical challenge was to be able to buy licenses easily, because it is necessary to approve the transfer of funds beforehand to be able to make the payment, and companies should not need to use Web3 technologies. Thus, we decided to create a page inspired by Paypal, on which the payment is made and which redirects the user to the chosen address once the license has been acquired.

Created figma model

Another problem we had to deal with was the fact that we could easily authenticate a user with metamask, on a Web2 app, to verify that he had a license. However we have developed a "oauth" flow (describe below). After oauth flow the client will receive a signed_nonce, which is use to call our Web2 API to authenticate the user and permit to client to know if the user has the license. This process avoids to the Web2 version for companies that do not wish to use Metamask auth.

Oauth flow

Thus, our solution can work both with the implementation of their own authentication flow for Web3 client, and both with the Web2 version for companies that do not wish to use Metamask auth.

📄 Facility

See the deployed project on licenka.space !2

⚠️ The contracts are currently deployed on the testnet, it is important to use it and not to use the mainnet. Here are the steps to install and test our project :

1. Use git clone [email protected]:MaximePremont/Licenka.git
2. Use cd Licenka
3. Add your Starton API Key API_KEY in the .env file of the project
4. Setup MongoDB vars MONGODB_URI and DB_NAME in the .env file of the project
5. Setup and start like described here, recommanded : docker compose up

You can now access to the app at http://localhost:3000

👋 Team and comments

Team name: POCKER

Team members :

• Maxime PREMONT
• Victor GUYOT
• Nolann SABRE
• Mikael VALLENET
• Ahmed ABOUELLEIL-SAYED

During the hackathon we learned how to create a contract on the BSC blockchain and deploy it using Starton API/Front. Using next.js and Web3.js we were able to create our first Dapp, and interact with our contract using Starton and direct function calling with Web3.js.

📌 Technical documentation

To use our system, you must first create a license in order to obtain the license ID. Then it is possible to use it as desired.

🛟 It is possible to define an expiration for licenses in days when they are created !

⚠️ The contracts are currently deployed on the testnet, it is important to use it and not to use the mainnet.

🗒 Here are the following address:

• Licenka Contract address: 0x150B6328F1810589aF899f6d9F17E0347f77c8b8
• BUSD Contract address : 0xeD24FC36d5Ee211Ea25A80239Fb8C4Cfd80f12Ee

Our solution is deployed and working with 3 parts :

1. A main page (https://licenka.space) to show the project
2. A license creation page (https://licenka.space/create), to create a new license with our wallet
3. A license buy page (https://licenka.space/approve), which allow the user to buy a license with his wallet, and redirect to the company page after that.
4. A oauth page (https://licenka.space/oauth?redirect_uri=https://demo.licenka.space/auth&licence_id=7)

⚠️ To work with the purchase page, the company must indicate the license to be purchased and the page to redirects to something like this : https://licenka.space/approve/?license=XX&redirect=https://xxxxxx.xx

As explained, our API can be used in 2 different ways: Web2 or Web3 :

• Web2 API:

  • Get license informations for a user https://licenka.space/api/license

    Query:
        userAddress
        licenseId
    200:
        license: {
        licenseId: 
        validTime: 
        isInfinite: 
    }
    

  • Know if a user has a license https://www.licenka.space/api/checkLicense

    Query:
        userAddress
        licenseId
        signedNonce
    200:
        license: bool
    

  • Get a nonce of user, with this nonce signed we can authenticate user https://www.licenka.space/api/wallet/nonce

    Query:
        walletAddress
    200:
        nonce: string
    

• Web3 Licenka:  Here are the functions which can be called by users (Owner functions and internal functions are not displayed)

  • Licenka Contract address: 0x150B6328F1810589aF899f6d9F17E0347f77c8b8
  • BUSD Contract address : 0xeD24FC36d5Ee211Ea25A80239Fb8C4Cfd80f12Ee

   

  • Get the license information from a given ID.

      function licenses(uint index) returns(License)
  
      struct License {
          address owner;
          string name;
          uint price;
          uint duration;
      }

  • Get the subscription information from a given ID.

      function subscriptions(uint index) returns(Subscription)
  
      struct Subscription {
          address owner;
          uint validTime;
      }

  • Create a license with a given name, price, and duration (0 for an endless license). Each payment will be sent to the owner address.

      function createLicence(address owner, string memory name, uint price, uint duration)

  • Create a subscription to a license.

      function subscribe(uint licenseId)

  • Check if an address has a valid subscription to a license.

      function verifySubscription(address owner, uint licenseId) returns(bool)

  • Get all the licenses owned by a wallet

      function getLicenses(address owner) returns(uint[])

  • Get all the subscriptions owned by a wallet

      function getSubscriptions(address owner) returns(uint[])

  • Get information about the subscription of the owner for a license.

      function getSubscriptionIdForLicense(address owner, uint licenseId) returns(uint)

• Web3 LicenkaChecker:  LicenkaChecker is a contract to be added to developers' contract who would like to check for users subscription validity.

  • Add the address of the Licenka contract address.

      constructor(address licenkaAddress)

  • Modifier to require a wallet to have a valid subscription to a license.

      modifier mustBeSubscribe(address owner, uint licenseId)

☀️ Business model & Growth

The objective of our project is to propose a reliable and very inexpensive alternative. Thus, we will earn money by taking 3 % when purchasing a license with our system.

Our possible project has a very big potential to grow, indeed we have already been able to imagine an even more advanced system which would make it possible to propose an client and/or an user dashboard to they can manage their purchased or selled licenses.

🚀 After some improvements, our project will be ready to be deployed on the mainnet !

📤 Project Submission

💾 Presentation video 2.0

https://www.youtube.com/watch?v=vazbtqNn8To&ab_channel=MaximePremont

You can also find the 1.0 video here.

🧪 Demonstration app

We have built an demonstration app, called CloudGaming, you've seen in the previous video. This application is in demo folder. If you want to know how to implement Licenka and/or test it, check the demo demo/README.md.

⭐️ Conclusions

Our project is deployed and available on licenka.space !

Features :

• Web3 implementation
• Web2 API simple implementation
• Create a license
• Create a license with expiration time
• Check if user has a license
• Get license informations for a user
• Buy a license
• Oauth flow with wallet signature of an nonce
• Be able to authenticate user with signed nonce

Partners :

• Starton : for contract calls and management
• BNB Chain : deployment
• Ledger : full compatibility of ledger wallets with our system

❤️ Thanks to Starton and all of its partners for making it possible to attend the talks, workshops and the organization of this hackathon.

licenka's Issues

Get license callback

What is the purpose of the branch
Call the correct function when the user gets a license

Issue templates

Create basic github issue templates for report bug, feature_request and branch (issue type allowing to generate branches like the dev branch).

front redirect after buy

What is the purpose of the branch
Redirect user after buying is complete

Licenka(2.0): Adapt demo site to new version

Node web server

Describe the solution you'd like
Create a basic node web server, that redirect on the repository

404 not found page

Describe the solution you'd like
404 not found page

Update conract info

What is the purpose of the branch
Add new abi and address

Licenka(2.0): Adapt Documentation (README & Loom Video)

Licenka2.0: Delete password & sign-in w/ MetaMask

Setup API routes

Describe the solution you'd like
We will setup API routes

Setup page structure

Describe the solution you'd like
Setup page structure

Vercel deploy config

Describe the solution you'd like
Create a vercel deploy config

Vercel audience analytics

Describe the solution you'd like
Add the vercel audience package

Add the different web pages needed

Is your feature request related to a problem? Please describe.
We need to create the different pages that the user will interact with, to discover our service, to create a license, to get a license and if someone got lost.

Describe the solution you'd like
Create a web page for each scenario.

License information according to license's id.

Docker start

Describe the solution you'd like
Add docker for start the project

Update contract address in api

What is the purpose of the branch
Update contract address in api.

Ajouter confirmation des actions avec toastify

Pour la création et l'approve.

Licenka(2.0): Add sign-in & signature of nonce with MetaMask

Refer to this article :

Add api routes

What is the purpose of the branch
Add api routes to fetch contract data, and check if a license has been purchased

Add button on landing page to create license page

Solidity contract

What is the purpose of the branch
Create the solidity contract for licenka

Landing page

Describe the solution you'd like
Develop landing page to present our project

Web3 technical doc

What is the purpose of the branch
Edit the readme to complete the web3 technicals

Create a demo which use Licenka

The demonstration should demonstrate the usefulness of Licenka.

• Developp a webapp which use Licenka tu buy a License
• Show the easy implementation for checking if the License is valid

Landing page cards

Describe the solution you'd like
Complete the landing page cards.

Update contract

What is the purpose of the branch
Update contract.

Readme fix

Describe the solution you'd like
In the readme, fix some problems and add the Web3 part and the correct video.

[FRONT] design (avis perso, je ne suis pas designer)

Home page:

• Le texte "Create your license the secure way" est un peut trop serré à gauche, mais si on lui donne plus d'esapce, l'image de droite grandit
• L'image à côté de our misson est collé à la droite de l'écran (je trouve ça pas très beau)
• La roadmap est grave stylée mais, la deuxième flèche arrive un peu trop à gauche (avis perso)

Approve page:

• Les tailles entre les inputs et les boutons ne correspondent pas
• Ca serait cool d'avoir une option pour voir le mot de passe qu'on a tapé (avis perso, comme y'a pas de confirmation c'est un moyen d'être sur de ce qui est entré)

Create page:

• J'aime pas trop la outline des inputs quand je click dessus (à limite faudrait l'enlever et changer la couleur de la border quand l'input est actif)
• Mettre un pattern sur l'input de wallet (https://gist.github.com/MBrassey/623f7b8d02766fa2d826bf9eca3fe005 mais en vrai pas obligé)
• L'input type number permet de taper n'importe quoi (nb neg, e, etc...)

    <input type="text" inputmode="numeric" pattern="[0-9]*">

• J'aime pas trop les boutons pour choisir "Forever" ou "Limited" (perso je vois plus des checkbox) -> dans tous les cas, ils ne marchent pas et le mode "non-actif" est pas très beau (je parle du gris clair)
• sur la dernière ligne du form, si on ressere l'écran, ça se supperpose
• J'ai pas l'icon pour le text "How to create a license ?"

Global:

• Disable les boutons quand les forms ne sont pas valide (c'est du détail, en vrai osef un peu)
• Un peu de padding en bas de page (c'est pas agréable le form collé en bas de page) -> pourquoi faire un footer que tu mets sur toutes les pages
• La scrollbar à droite est moche (https://stackoverflow.com/questions/16670931/hide-scroll-bar-but-while-still-being-able-to-scroll ou alors la modifiée pour qu'elle soit moins moche: https://css-tricks.com/almanac/properties/s/scrollbar/)

Change front approve format

What is the purpose of the branch
Change the front of the approve page to make it practical

Create license

Describe the solution you'd like
Create license page for company

Basic node app

Describe the solution you'd like
Create a simple node app

Add README.md

Describe the solution you'd like
Add a README.md following hackathon template.

Hide number of days input when forever button is selected.

Ajouter gestion d'érreur avec les pattern/regex aux inputs

License

Describe the solution you'd like
Setup an MIT license

Add web3js

What is the purpose of the branch
Implement web3js in the front

Docker starton key env

Describe the solution you'd like
Manage the starton key in the docker and .env

Ajouter footer

Ajouter un footer avec le logo, différentes pages, liens github etc...

Remove PORT in .env

Describe the solution you'd like
Remove the PORT var in the .env because unused

Code of conduct

Describe the solution you'd like
Setup a contributing code of conduct

small front fix

What is the purpose of the branch
Small tweaks to the front and add BigNumbers

Added contract address to readme

What is the purpose of the branch
Added contract address to readme

Readme license time

Describe the solution you'd like
Add the license expiration explanation

Analytics component

Describe the solution you'd like
Add the vercel analytics component.

Demo video

Describe the solution you'd like
Add the video demo to the readme and remove the link of the demo project if required.

Licenka(2.0): Adapt frontend, delete pwd and add new page for sign-in

• Get all params (redirect_uri, license_id)
• Get license info to inform user wich license ask his auth
• Call api to get wallet_nonce
• Sign wallet_nonce with metamask
• Redirect user on redirect_uri with signed_nonce

Setup NEXT.js

Describe the solution you'd like
Setup NEXT.js

Buy license page

Describe the solution you'd like
Buy license

Readme business informations

Describe the solution you'd like
Add business informations like growth and fees to the readme.