https://github.com/kaiachain/kaia-contracts

https://github.com/kaiachain/kaia-contracts

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kaiachain/kaia-contracts
• Owner: kaiachain
• License: mit
• Created: 2024-06-05T10:05:07.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-27T15:43:50.000Z (7 months ago)
• Last Synced: 2025-01-11T16:40:46.932Z (8 days ago)
• Language: Solidity
• Homepage:
• Size: 23.5 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Audit: audit/2017-03.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-kaia - Smart contracts for Kaia - Library for secure smart contract development. (Starter Kits)

README

        
# Kaia Contracts

[![Docs](https://img.shields.io/badge/docs-%F0%9F%93%84-blue)](https://docs.kaia.io)

[![NPM Package](https://badge.fury.io/js/@kaiachain%2Fcontracts.svg)](https://www.npmjs.com/package/@kaiachain/contracts)

[![Gitter](https://badges.gitter.im/kaiachain/kaia-contracts.svg)](https://gitter.im/kaiachain/kaia-contracts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

**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 Kaia'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](https://kips.kaia.io/token) link for the mapping of Ethereum to Kaia token standards.

## Overview

### Installation

```console

$ npm install @kaiachain/contracts

```

An alternative to npm is to use the GitHub repository `kaiachain/kaia-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 `main` branch.

### Usage

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

```solidity

pragma solidity ^0.8.0;

import "@kaiachain/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 Kaia codebase and its documentations are completely open source. Kaia 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](./CONTRIBUTING.md)

- [License](./LICENSE)

- [Code of Conducts](./code-of-conduct.md)

## Need Help? 

If you have any questions, please visit our [Gitter channel](https://gitter.im/kaiachain/kaia-contracts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge), [Kaia Developers Forum](https://forum.kaia.io/) and [Discord channel](https://discord.gg/kaiachain).

## License

 Contracts is released under the [MIT License](LICENSE).

## Acknowledgments 

Thanks for Openzepplin Team for providing the  contracts.