Skip to content

Commit

Permalink
feat: upgrade polkadot 0.9.42 & create cargo workspace (#723)
Browse files Browse the repository at this point in the history
  • Loading branch information
DylanVerstraete authored Jun 7, 2023
1 parent b9a9cca commit 5605bca
Show file tree
Hide file tree
Showing 119 changed files with 9,972 additions and 10,355 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/build_test.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ RUN apt update && \
python3.10 get-pip.py && \
rm -rf get-pip.py && \
curl https://sh.rustup.rs -sSf | sh -s -- -y && \
$HOME/.cargo/bin/rustup install nightly-2022-05-11 && \
$HOME/.cargo/bin/rustup target add wasm32-unknown-unknown && \
# $HOME/.cargo/bin/rustup install nightly-2023-06-04 && \
# cleanup image
rm -rf /var/lib/apt/lists/* && \
apt -y clean && \
Expand Down
9 changes: 3 additions & 6 deletions .github/workflows/build_test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
build-and-test:
runs-on: [self-hosted, tfchainrunner01]
container:
image: threefolddev/tfchain:3
image: threefolddev/tfchain:4
env:
DEBIAN_FRONTEND: noninteractive
PATH: /root/.cargo/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/local/go/bin
Expand All @@ -35,15 +35,12 @@ jobs:
- name: Build
run: |
cd substrate-node
rustup target add wasm32-unknown-unknown --toolchain nightly-2022-05-11
cargo +nightly-2022-05-11 build --release
cargo build --release
- name: Unit tests
run: |
cd substrate-node
cargo +nightly-2022-05-11 test --no-fail-fast
cd pallets
cargo +nightly-2022-05-11 test --no-fail-fast
cargo test --no-fail-fast --features runtime-benchmarks
- name: Integration tests
run: |
Expand Down
10 changes: 10 additions & 0 deletions bridge/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Generated by Cargo
# will have compiled files and executables
/target/

# These are backup files generated by rustfmt
**/*.rs.bk
tfchain_bridge/tfchain_bridge
master1.json
signer1.json
signer2.json
201 changes: 201 additions & 0 deletions bridge/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
28 changes: 28 additions & 0 deletions bridge/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Tfchain TFT bridge

Bridge TFT between a TFchain and the Stellar network.

There are 2 components that make up this bridge:

- A pallet that needs to be included in the tfchain runtime: [pallet-tft-bridge](../substrate-node/pallets/pallet-tft-bridge)
- Bridge daemons: [tfchain_bridge](./tfchain_bridge)

## Running Bridge instances

### Mainnet

Bridge account on mainnet: `GBNOTAYUMXVO5QDYWYO2SOCOYIJ3XFIP65GKOQN7H65ZZSO6BK4SLWSC`

Can be interacted with on: https://portal.grid.tf

### Testnet

Bridge account on testnet `GA2CWNBUHX7NZ3B5GR4I23FMU7VY5RPA77IUJTIXTTTGKYSKDSV6LUA4`

Can be interacted with on: https://portal.test.grid.tf

### Devnet

Bridge account on devnet: `GDHJP6TF3UXYXTNEZ2P36J5FH7W4BJJQ4AYYAXC66I2Q2AH5B6O6BCFG`

Can be interacted with on: https://portal.dev.grid.tf
65 changes: 65 additions & 0 deletions bridge/specs/bridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# TFT Tfchain Stellar bridge

## Stellar TFT to Tfchain TFT

The bridge monitors a central stellar account that is goverened by the threefoldfoundation. When a user sends an amount of TFT to that stellar account, the bridge will pick up this transaction.

### Destination

In the memo text of this transaction is the Tfchain address of the receiver.

**TODO: how to convert/encode an SS58 address so it fits in the Stellar memo text.**

## Components

There are 3 main components to get the bridge working.

- Central stellar bridge wallet (requires multisig in order to be secure)
- The `pallet-tft-bridge` (the runtime functionality)
- Validator daemons

Note: There must always be as many validator daemons as there are signers on the stellar bridge wallet account.

## Pallet TFT Bridge

Is the main runtime functionality, distributes consensus for minting / burning tokens on TF Chain and manages signature passaround for the validators in order to execute a multisig transaction on the central Stellar bridge wallet.

Contains following extrinsic to call:

#### Admin setup
- `add_validator(accountId)` (root call for the admin to setup the bridge)
- `remove_validator(accountId)` (root call for the admin to setup the bridge)
- `set_fee_account(accountId) (root call for the admin to setup the bridge fee wallet on tfchain)`
- `set_deposit_fee(amount) (root call for the admin to setup the bridge desposit on tfchain)`
- `set_burn_fee() (root call for the admin to setup the bridge burn fee on tfchain)`
#### Stellar -> TF Chain (minting on TF Chain)
- `propose_or_vote_mint_transaction(transaction, target, amount)`
#### TF Chain -> Stellar (burning on TF Chain)
- `propose_burn_transaction_or_add_sig(transaction, target, amount, signature, stellarAccountAddress)`
#### User callable extrinsic
- `swap_to_stellar(target, amount)`

## Validator daemon

Is a signer of the multisig Stellar bridge wallet. This code does the following things:

- Monitors central Stellar bridge wallet for incoming transactions
- Monitors events on chain

More will be explained below

## Stellar swap to TF Chain flow

A user looks up the Stellar bridge wallet address for a swap to TF Chain. He then sends a transaction with some amount to the bridge wallet.

Now the validator daemons monitoring the bridge wallet will see an incoming transaction and execute a `propose_or_vote_mint_transaction` on TF Chain. If the transaction has already been executed before, this will fail.

If more then *(number of validators / 2) + 1* voted that this mint transaction is valid, then the chain will execute a `mint` on the target address for the specified amount of tokens.

## TF Chain swap to Stellar

A user will call `swap_to_stellar(optional target, amount)`. The validator daemons will pick up a an event containing information about the swap to stellar. The validators will call `propose_burn_transaction_or_add_sig` with the information about the stellar transaction.

If more then *(number of validators / 2) + 1* signatures are present on the burn transaction, the transaction is considered valid and the chain will emit an event that the transaction is ready to be submitted.

The daemons will see this transaction ready event and retrieve the transcation object from storage. They will submit the transaction, along with all the signatures to the stellar network. Only one validator will succeed in this operation, the other validators will get an error, but they can ignore that because stellar has a double spend protection mechanism.
9 changes: 9 additions & 0 deletions bridge/tfchain_bridge/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM golang:alpine3.14 as BUILDER
WORKDIR /opt/tfchain
COPY . .
WORKDIR /opt/tfchain
RUN go build

FROM alpine:3.13.5
COPY --from=BUILDER /opt/tfchain/tfchain_bridge /bin/
ENTRYPOINT [ "/bin/tfchain_bridge" ]
13 changes: 13 additions & 0 deletions bridge/tfchain_bridge/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Building the bridge

## local build

This is a normal go project so just execute `go build`.

## Build a docker image

To build a docker image with the latest git tag as version:

```sh
docker build -t tftchainstellarbridge:$(git describe --abbrev=0 --tags | sed 's/^v//') .
```
23 changes: 23 additions & 0 deletions bridge/tfchain_bridge/chart/tfchainbridge/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
Loading

0 comments on commit 5605bca

Please sign in to comment.