Introduction

This document explains how to set up and use KOR Protocol TypeScript SDK. The SDK allows users to interact with KOR Protocol smart contract securely using an API key issued upon subscription.

To initialize the SDK, a website developer will use an API key. During the creation or modification of this API key, various security permissions can be configured. There are four distinct security rules that can be applied individually or in combination:

1. No Lock: The API key remains unrestricted, which poses a risk of unauthorized access and misuse by other users. This setting is suitable for developers testing in a staging environment where security is less critical.

2. Allowed Domains: This feature, known as "Allow list Domains," enables you to define specific web domains that are permitted to use your API key. This prevents unauthorized third parties from utilizing your key on their websites.

3. Allowed IPs: The "Allow list IPs" feature allows you to specify a set of IPv4 addresses authorized to make requests using your API key, effectively blocking requests from any other IP addresses.

4. Google reCAPTCHA: By integrating reCAPTCHA, you add an extra layer of security against malicious software, preventing bots from abusing your website's functionalities. Legitimate users can continue to perform actions like logging in, making purchases, or creating accounts, while fake users are blocked.