https://github.com/pawanpaudel93/valist-software-license

Valist Software License SDK
https://github.com/pawanpaudel93/valist-software-license

sdk typescript valist

Last synced: about 2 months ago
JSON representation

Valist Software License SDK

• Host: GitHub
• URL: https://github.com/pawanpaudel93/valist-software-license
• Owner: pawanpaudel93
• License: mit
• Created: 2022-11-21T18:29:57.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-30T18:06:12.000Z (about 2 years ago)
• Last Synced: 2024-11-21T04:49:07.499Z (about 2 months ago)
• Topics: sdk, typescript, valist
• Language: TypeScript
• Homepage: https://valist-software-license-gated-dapp.vercel.app
• Size: 669 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  



# Valist lightweight TypeScript SDK & License NFT Gated Dapp



  



## Table of Contents

- [About](#about)

- [Installing](#installing)

- [Development](#development)

- [Folder Structure](#packages)

- [Contributing](#contributing)

## About 

Valist is the Universal software deployment and monetization protocol. Valist Software License is the lightweight sdk of [valist-sdk](https://github.com/valist-io/valist-js/tree/main/packages/valist-sdk) only having fewer core functionality like `purchaseProduct`, `purchaseProductToken` and `checkLicense`.

A `checkLicense` function that:

- Prompts a human-readable message signature request from the user's wallet

- Recovers the address from the signature

- Uses that address to check the user's balance on the Software License NFT contract

A `purchaseProduct` function that prompts the user to purchase the Software License NFT with native MATIC.

A `purchaseProductToken` function that prompts the user to purchase the Software License NFT with the user's desired (and supported) token.

A `hasLicense` function that checks whether a given address has license to a given product ID.

Learn more about [Valist](https://valist.io/).

## Installing the package 

Install the package using npm or yarn as desired to get started.

```

npm install --save valist-software-license

```

OR

```

yarn add valist-software-license

```

## Development 

### Requirements

- node >= 18.11.0

- yarn >= 3.3.0

### Setup

```bash

git clone https://github.com/pawanpaudel93/valist-software-license

cd valist-software-license

yarn

```

## 🧐 Folder Structure 

    .

    ├── packages                 # All workspaces

    │   ├── sdk                  # Valist software license lightweight SDK.

    │   ├── license-gated-dapp   # License gated nextjs Dapp utilizing valist software license sdk

    └── ...

## Author

👤 **Pawan Paudel**

- Github: [@pawanpaudel93](https://github.com/pawanpaudel93)

## 🤝 Contributing 

Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/pawanpaudel93/valist-software-license/issues).

## Show your support

Give a ⭐️ if this project helped you!

Copyright © 2022 [Pawan Paudel](https://github.com/pawanpaudel93).