guild-gated-contracts

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #golang #docker #nodejs #windows #awesome #kubernetes #awesome-list #pytorch #security #ios #openai

guild-gated-contracts

(★ 19)

Smart contracts with access control by guild.xyz, via oracles

guild-gated-contracts 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Guild-Gated Contracts

Smart contracts with access control by [Guild](https://guild.xyz), via [Chainlink](https://chain.link) oracles.

Currently 5 types of checks are supported:

- joined a specific guild
- is the owner of a specific guild
- is an admin of a specific guild
- satisfies requirements for a specific role
- has a specific role

The **[GuildOracle](contracts/GuildOracle.sol)** contract is suitable for creating any kind of Guild-gated contracts by building upon it. Find out how in [USAGE.md](USAGE.md).  
The first examples leveraging this new feature:

- [GatedDistributor](contracts/examples/GatedDistributor.sol): an ERC20 airdrop contract for guild-related actions.
- [GatedERC721](contracts/examples/GatedERC721.sol): an ERC721 Non-Fungible Token that can be claimed only after completing guild-related actions.

A detailed documentation can be found in the _[docs](docs)_ folder.

## Setup

To run the project you need [Node.js](https://nodejs.org) development environment.

Pull the repository from GitHub, then install its dependencies by executing this command:

```bash
npm install
```

Certain actions, like deploying to a public network or verifying source code on block explorers, need environment variables in a file named `.env`. See _[.env.example](.env.example)_ for more info.

## Contract deployment

To deploy the smart contracts to a network, replace _[networkName]_ with the name of the network and _[scriptName]_ with the name of the script you wish to run in this command:

```bash
npx hardhat run scripts/[scriptName] --network [networkName]
```

Networks can be configured in _[hardhat.config.ts](hardhat.config.ts)_. We've preconfigured the following:

- `hardhat` (for local testing, default)
- `ethereum` (Ethereum Mainnet)
- `goerli` (Görli Ethereum Testnet)
- `sepolia` (Sepolia Ethereum Testnet)
- `bsc` (BNB Smart Chain)
- `bsctest` (BNB Smart Chain Testnet)
- `polygon` (Polygon Mainnet (formerly Matic))
- `mumbai` (Matic Mumbai Testnet)
- `gnosis` (Gnosis Chain (formerly xDai Chain))
- `arbitrum` (Arbitrum One (Mainnet))
- `base` (Base Mainnet)
- `optimism` (Optimism Mainnet)
- `cronos` (Cronos Mainnet)
- `mantle` (Mantle Network Mainnet)
- `ontology` (Ontology EVM Mainnet)
- `linea` (Linea Mainnet)
- `cyber` (Cyber Mainnet)

## Verification

For source code verification on block explorers, you can use the Etherscan plugin:

```bash
npx hardhat verify [contractAddress] [constructorArguments] --network [networkName]
```

Note: the contract's address and the constructor arguments are printed by the deploy script, so they can easily be copied to this command.

For more detailed instructions, check out the plugin's documentation [here](https://hardhat.org/plugins/nomiclabs-hardhat-etherscan#usage).

## Linting

The project uses [Solhint](https://github.com/protofire/solhint) for Solidity smart contracts and [ESLint](https://eslint.org) for TypeScript files. To lint all files, simply execute:

```bash
npm run lint
```

To lint only the Solidity files:

```bash
npm run lint-contracts
```

To lint only the TypeScript files:

```bash
npm run lint-ts
```

## Tests

To run the unit tests written for this project, execute this command in a terminal:

```bash
npm test
```

To run the unit tests only in a specific file, just append the path to the command. For example, to run tests just for GatedERC721:

```bash
npm test test/GatedERC721.spec.ts
```

## Documentation

The documentation for the contracts is generated via the [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen) package. Run the tool via the following command:

```bash
npm run docgen
```

The output can be found in the _[docs](docs)_ folder.

guild-gated-contracts

guild-gated-contracts 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

guild-gated-contracts

guild-gated-contracts 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README