Skip to content

Commit

Permalink
chore: update README and iBTC assets
Browse files Browse the repository at this point in the history
chore: update README and iBTC assets
  • Loading branch information
scolear authored Dec 27, 2024
2 parents 53a00a3 + 5095da6 commit 4742f89
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,32 @@
[![Discord Banner](https://discordapp.com/api/guilds/887360470955208745/widget.png?style=banner2)](https://discord.gg/TtzqyfPCvE) -->

<div align="center">
<img src="./assets/dlcBTC_Token.svg" alt="icon" width="140" height="140" />
<img src="./assets/iBTC_Token.svg" alt="icon" width="140" height="140" />
</div>

# dlc-solidity

[![Build Status](https://github.com/DLC-link/dlc-solidity/actions/workflows/docker-build-and-push.yaml/badge.svg)](https://github.com/DLC-link/dlc-solidity/actions/workflows/docker-build-and-push.yaml)
[![Tests Status](https://github.com/DLC-link/dlc-solidity/actions/workflows/hardhat-test.yaml/badge.svg)](https://github.com/DLC-link/dlc-solidity/actions/workflows/hardhat-test.yaml)

This repo contains the solidity smart contracts for the DLC.Link infrastructure and the dlcBTC token.
This repo contains the solidity smart contracts for the DLC.Link infrastructure and the iBTC token.

Learn more about [DLCs](https://github.com/DLC-link/dlc-solidity#What-Are-DLCs) and [dlcBTC](https://dlcbtc.com).
Learn more about [DLCs](https://github.com/DLC-link/dlc-solidity#What-Are-DLCs) and [iBTC](https://www.ibtc.network/).

# Overview

A DLC is a contract on Bitcoin that enables users to move/lock Bitcoin conditionally. The possible outcomes of a DLC are predefined and stored by the DLC.Link Attestor Layer. Bitcoin locked in such a way can be represented then on any EVM chain using these smart contracts. The outcome - that is, the value that will be 'attested' to - is supplied by smart contracts too.

This way, any EVM chain can essentially move native Bitcoin in a safe, "bridgeless" way. Ethereum can leverage the power of DLCs and the trust-minimised Attestor Layer that DLC.Link provides.

_dlcBTC_ is a token that represents Bitcoin locked in DLCs. It is minted when Bitcoin is locked in a DLC and burned when the DLC is settled.
_iBTC_ is a token that represents Bitcoin locked in DLCs. It is minted when Bitcoin is locked in a DLC and burned when the DLC is settled.

Learn more about the whole architecture on the documentation site here:
https://docs.dlc.link/architecture/tech-stack

## Timelocked Upgrades

Some of the contracts in this repository are upgradeable. They can be changed by a multisig of dlcBTC team and external members. The upgrade process is timelocked, meaning that the upgrade will only happen after a certain time has passed (minimum 7 days). This is to ensure that the community has time to review the changes and react if necessary.
Some of the contracts in this repository are upgradeable. They can be changed by a multisig of DLC.Link team and external members. The upgrade process is timelocked, meaning that the upgrade will only happen after a certain time has passed (minimum 7 days). This is to ensure that the community has time to review the changes and react if necessary.

<img src="./assets/timelockArchitecture.svg" alt="architecture" width="100%" />

Expand Down
2 changes: 1 addition & 1 deletion assets/dlcBTC_Token.svg → assets/iBTC_Token.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
5 changes: 3 additions & 2 deletions scripts/helpers/mainnet-call-all.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# Check if the command line argument is provided
if [ $# -eq 0 ]; then
echo "Please provide a command argument."
exit 1
echo "Please provide a command argument."
exit 1
fi

# Assign the command line argument to a variable
Expand All @@ -14,4 +14,5 @@ HARDHAT_NETWORK=base dlc-link-eth $command $extra_args
HARDHAT_NETWORK=arbitrum dlc-link-eth $command $extra_args
HARDHAT_NETWORK=mainnet dlc-link-eth $command $extra_args
HARDHAT_NETWORK=bsc dlc-link-eth $command $extra_args
HARDHAT_NETWORK=avax dlc-link-eth $command $extra_args
HARDHAT_NETWORK=optimism dlc-link-eth $command $extra_args

0 comments on commit 4742f89

Please sign in to comment.