@klaytn/contracts

Branch name will be changed

We will change the master branch to main on Dec 15, 2022. After the branch policy change, please check your local or forked repository settings.

Klaytn Contracts

A library for secure smart contract development. Build on a solid foundation of community-vetted code. It is a fork of openzepplin contracts. In addition to that, this repository contains Klaytn's token standards such as KIP-7, KIP-17, and KIP-37 compatible with ERC-20, ERC-721, and ERC-1155 respectively.

Please refer to this link for the mapping of Ethereum to Klaytn token standards.

Overview

Installation

$ npm install @klaytn/contracts

An alternative to npm is to use the GitHub repository klaytn/klaytn-contracts to retrieve the contracts. When doing this, make sure to specify the tag for a release such as v1.0.0, instead of using the master branch.

Usage

Once installed, you can use the contracts in the library by importing them:

pragma solidity ^0.8.0;

import "@klaytn/contracts/KIP/token/KIP17/KIP17.sol";

contract MyCollectible is KIP17 {
    constructor() KIP17("MyCollectible", "MCO") {
    }
}

To keep your system secure, you should always use the installed code as-is, and neither copy-paste it from online sources, nor modify it yourself. The library is designed so that only the contracts and functions you use are deployed, so you don't need to worry about it needlessly increasing gas costs.

Contribute

In line with our commitment to decentralization, all Klaytn codebase and its documentations are completely open source. Klaytn always welcomes your contribution. Anyone can view, edit, fix its contents and make suggestions. You can either create a pull request on GitHub or use GitBook. Make sure to sign our Contributor License Agreement (CLA) first and there are also a few guidelines our contributors would check out before contributing:

• Contribution Guide
• License
• Code of Conducts

Need Help?

If you have any questions, please visit our Gitter channel, Klaytn Developers Forum and Discord channel.

License

Contracts is released under the MIT License.

Acknowledgments

Thanks for Openzepplin Team for providing the contracts.