Skip to content

Commit da81a3c

Browse files
committed
feat: add licensing info, natspec
1 parent 8440f68 commit da81a3c

File tree

4 files changed

+19
-1
lines changed

4 files changed

+19
-1
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright 2023 Avail Project
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

src/MessageReceiver.sol

+6
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ pragma solidity ^0.8.23;
33

44
import {IMessageReceiver} from "src/interfaces/IMessageReceiver.sol";
55

6+
/**
7+
* @author @QEDK (Avail)
8+
* @title MessageReceiver
9+
* @notice A message receiver implementation for receiving messages from the Avail AMB
10+
* @custom:security [email protected]
11+
*/
612
abstract contract MessageReceiver is IMessageReceiver {
713
address public availBridge;
814

src/WrappedAvail.sol

+6
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ pragma solidity ^0.8.23;
44
import {ERC20, ERC20Permit} from "lib/openzeppelin-contracts/contracts/token/ERC20/extensions/ERC20Permit.sol";
55
import {IWrappedAvail} from "src/interfaces/IWrappedAvail.sol";
66

7+
/**
8+
* @author @QEDK (Avail)
9+
* @title WrappedAvail
10+
* @notice An Avail token implementation for Ethereum
11+
* @custom:security [email protected]
12+
*/
713
contract WrappedAvail is ERC20Permit, IWrappedAvail {
814
address public immutable bridge;
915

src/lib/Merkle.sol

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
// Modified from https://github.com/QEDK/solidity-misc/blob/master/contracts/Merkle.sol
33
pragma solidity ^0.8.23;
44

5+
/**
6+
* @author @QEDK
7+
* @title Merkle
8+
* @notice A gas-efficient ordered Merkle proof of inclusion implementation
9+
* @custom:security [email protected]
10+
*/
511
library Merkle {
612
function verify(bytes32[] calldata proof, bytes32 root, uint256 index, bytes32 leaf)
713
internal

0 commit comments

Comments
 (0)