feat: Add Algorand Integration (#860)

Co-authored-by: vahe9611 <vah.vahe97@gmail.com>
Co-authored-by: Vahe Hakobyan <49304207+Vahe9611@users.noreply.github.com>

Author: pedro-lino

.github/workflows/algorand-integration.yml

@@ -0,0 +1,122 @@
+name: Algorand-Icon-Integration
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+jobs:
+  Algorand-Icon-Integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build the Relayer
+        working-directory: ./cmd/iconbridge
+        run: |
+          go build .
+
+      - name: Build Goloop container
+        working-directory: ./devnet/docker/goloop
+        run: docker build -t icon-algorand_goloop .
+
+      - name: Run Goloop container
+        working-directory: ./devnet/docker/goloop
+        run: |
+          docker run -d \
+            --name goloop \
+            -p 9080:9080 \
+            -e GOLOOP_NODE_DIR=/goloop/data/goloop \
+            -e GOLOOP_LOG_WRITER_FILENAME=/goloop/data/log/goloop.log \
+            -t icon-algorand_goloop
+
+      - name: Install Algod and friends
+        run: |
+          sudo mkdir /tmp/algorand
+          sudo wget -O /tmp/algorand/algorand.tar.gz https://github.com/algorand/go-algorand/releases/download/v3.13.3-stable/node_stable_linux-amd64_3.13.3.tar.gz
+          cd /tmp/algorand
+          sudo tar xf algorand.tar.gz
+          cd bin
+          sudo mv algod goal kmd /usr/local/bin
+
+      - name: Run Algod
+        working-directory: ./devnet/algorand
+        run: |
+          goal network create -r /tmp/testnet -t ./template.json
+          cp ./config.json /tmp/testnet/Node
+          cp ./algod.token /tmp/testnet/Node
+          cp ./kmd_config.json /tmp/testnet/Node/kmd-v0.5/kmd_config.json
+          cp ./kmd.token /tmp/testnet/Node/kmd-v0.5/kmd.token
+          goal network start -r /tmp/testnet
+
+      - name: Run Algorand lifecheck test
+        run: |
+          go test -v pyteal/test/lifecheck_test/lifecheck_test.go
+
+      - name: Install goloop
+        run: |
+          cd /tmp
+          wget https://github.com/icon-project/goloop/archive/refs/tags/v1.3.3.tar.gz
+          tar xf v1.3.3.tar.gz
+          cd goloop-1.3.3/cmd/goloop
+          go install
+          cd /tmp
+          rm -rf goloop-1.3.3 v1.3.3.tar.gz
+
+      - name: Install PyTeal
+        working-directory: ./pyteal
+        run: |
+          sudo apt update
+          sudo apt install -y python3-pip
+          pip install pyteal
+
+      - name: Compile golang tools
+        working-directory: cmd/tools/algorand
+        run: ./install-tools.sh
+
+      - name: Set up JDK and Gradle
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+          distribution: "gradle"
+          gradle-version: "7.6"
+
+      - name: Test Javascore
+        working-directory: ./javascore
+        run: |
+          ./gradlew wrapped-token:test
+
+      - name: Build ICON smart contracts
+        working-directory: ./javascore
+        run: |
+          ./gradlew dummyBSH:optimizedJar
+          ./gradlew bmc:optimizedJar
+          ./gradlew wrapped-token:optimizedJar
+          ./gradlew test-token:optimizedJar
+          ./gradlew escrow:optimizedJar
+
+      - name: Build Algorand smart contracts
+        working-directory: pyteal
+        run: |
+          ./build.sh bmc.bmc bmc
+          ./build.sh bsh.bsh bsh
+          ./build.sh escrow.escrow escrow
+          ./build.sh reserve.reserve reserve
+
+      - name: Deploy contracts, setup system and update config file
+        working-directory: ./devnet/docker/icon-algorand
+        run: |
+          ./setup_system.sh
+
+      - name: Start the Relayer
+        working-directory: ./cmd/iconbridge
+        run: |
+          ./iconbridge -config=../../devnet/docker/icon-algorand/algo-config.json &
+          sleep 10
+
+      - name: Run integration test
+        working-directory: ./devnet/docker/icon-algorand
+        run: |
+          export PATH=$PATH:~/go/bin
+          ./dbsh-integration-test.sh
+          ./a2i-integration-test.sh
+          ./i2a-integration-test.sh

.gitignore

@@ -6,6 +6,7 @@ __pycache__
 **/*.iml
 build/
 devnet/docker/icon-bsc/build*/
+devnet/docker/icon-algorand/build*/
 bin/
 **/*/node_modules/
 abigenBindings/
@@ -22,3 +23,7 @@ rust/near/res
 
 devnet/docker/icon-bsc/local/
 devnet/docker/icon-bsc/data/
+devnet/docker/icon-algorand/local/
+devnet/docker/icon-algorand/cache/
+devnet/docker/icon-algorand/iconvalidators
+devnet/docker/icon-algorand/*keystore.json

cmd/iconbridge/chain/algo/bmc_abi.go

@@ -0,0 +1,91 @@
+package algo
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"path/filepath"
+	"time"
+
+	"github.com/algorand/go-algorand-sdk/abi"
+	"github.com/algorand/go-algorand-sdk/future"
+	"github.com/algorand/go-algorand-sdk/types"
+)
+
+const contractDir = "../../pyteal/teal/bmc/"
+const waitRounds = 5
+
+type AbiFunc struct {
+	name string
+	args []interface{}
+}
+
+func GetMethod(c *abi.Contract, name string) (abi.Method, error) {
+	m, err := c.GetMethodByName(name)
+	if err != nil {
+		return abi.Method{}, err
+	}
+	return m, nil
+}
+
+func Combine(mcp future.AddMethodCallParams, m abi.Method,
+	a []interface{}) future.AddMethodCallParams {
+	mcp.Method = m
+	mcp.MethodArgs = a
+	return mcp
+}
+
+func (s *sender) initAbi() error {
+	abiPath, err := filepath.Abs(contractDir + "contract.json")
+	if err != nil {
+		return fmt.Errorf("Couldn't retrieve abi file: %w", err)
+	}
+	rawBmc, err := ioutil.ReadFile(abiPath)
+	if err != nil {
+		return fmt.Errorf("Failed to open contract file: %w", err)
+	}
+	abiBmc := &abi.Contract{}
+	if err = json.Unmarshal(rawBmc, abiBmc); err != nil {
+		return fmt.Errorf("Failed to marshal abi contract: %w", err)
+	}
+	s.bmc = abiBmc
+
+	ctx, _ := context.WithTimeout(context.Background(), 60*time.Second)
+	sp, err := s.cl.algod.SuggestedParams().Do(ctx)
+	if err != nil {
+		return fmt.Errorf("Failed to get suggeted params: %w", err)
+	}
+
+	sp.Fee = 1000
+	s.mcp = &future.AddMethodCallParams{
+		AppID:           s.opts.BmcId,
+		Sender:          s.wallet.TypedAddress(),
+		SuggestedParams: sp,
+		OnComplete:      types.NoOpOC,
+		Signer:          s.wallet,
+	}
+	return nil
+}
+
+func (s *sender) callAbi(ctx context.Context, abiFuncs ...AbiFunc) (future.ExecuteResult, error) {
+	var atc = future.AtomicTransactionComposer{}
+	for _, abiFunc := range abiFuncs {
+		method, err := GetMethod(s.bmc, abiFunc.name)
+		if err != nil {
+			return future.ExecuteResult{}, fmt.Errorf("Failed to get %s method from json contract: %w",
+				abiFunc.name, err)
+		}
+
+		err = atc.AddMethodCall(Combine(*s.mcp, method, abiFunc.args))
+		if err != nil {
+			return future.ExecuteResult{}, fmt.Errorf("Failed to add %s method to atc: %w", abiFunc.name, err)
+		}
+	}
+
+	ret, err := atc.Execute(s.cl.algod, ctx, waitRounds)
+	if err != nil {
+		return future.ExecuteResult{}, fmt.Errorf("Failed to execute atc: %w", err)
+	}
+	return ret, nil
+}

cmd/iconbridge/chain/algo/client.go

@@ -0,0 +1,92 @@
+package algo
+
+import (
+	"context"
+	"fmt"
+	"math/big"
+	"time"
+
+	"github.com/algorand/go-algorand-sdk/client/v2/algod"
+	"github.com/algorand/go-algorand-sdk/client/v2/common/models"
+	"github.com/algorand/go-algorand-sdk/future"
+	"github.com/algorand/go-algorand-sdk/types"
+	"github.com/icon-project/icon-bridge/cmd/iconbridge/chain"
+	"github.com/icon-project/icon-bridge/common/log"
+)
+
+const (
+	AlgoBlockRate   = 4
+	BlockRetryLimit = 5
+)
+
+type Client struct {
+	log   log.Logger
+	algod *algod.Client
+}
+
+type IClient interface {
+	Log() log.Logger
+	GetBalance(ctx context.Context, hexAddr string) (*big.Int, error)
+	WaitForTransaction(ctx context.Context, txId string) (models.PendingTransactionInfoResponse, error)
+	GetLatestRound(ctx context.Context) (uint64, error)
+	GetBlockbyRound(ctx context.Context, round uint64) (block *types.Block, err error)
+	DecodeBtpMsg(log string) (*chain.Event, error)
+}
+
+func newClient(algodAccess []string, l log.Logger) (*Client, error) {
+	algodClient, err := algod.MakeClient(algodAccess[0], algodAccess[1])
+	if err != nil {
+		return nil, err
+	}
+	cli := &Client{
+		log:   l,
+		algod: algodClient,
+	}
+	return cli, nil
+}
+
+func (cl *Client) WaitForTransaction(ctx context.Context, txId string) (models.PendingTransactionInfoResponse, error) {
+	return future.WaitForConfirmation(cl.algod, txId, BlockRetryLimit, ctx)
+}
+
+func (cl *Client) GetBalance(ctx context.Context, walletAddr string) (*big.Int, error) {
+	accountInfo, err := cl.algod.AccountInformation(walletAddr).Do(ctx)
+	if err != nil {
+		return nil, err
+	} else {
+		return new(big.Int).SetUint64(accountInfo.Amount), nil
+	}
+}
+
+func (c *Client) Log() log.Logger {
+	return c.log
+}
+
+// get latest block round
+func (cl *Client) GetLatestRound(ctx context.Context) (uint64, error) {
+	sta, err := cl.algod.Status().Do(ctx)
+	return sta.LastRound, err
+}
+
+// get latest block number
+func (cl *Client) GetBlockbyRound(ctx context.Context, round uint64) (*types.Block, error) {
+	for i := 1; i <= BlockRetryLimit; i++ {
+		block, err := cl.algod.Block(round).Do(ctx)
+		if err != nil {
+			time.Sleep(AlgoBlockRate * time.Second)
+			continue
+		}
+		return &block, nil
+	}
+	err := fmt.Errorf("GetBlock reached retry limit")
+	return nil, err
+}
+
+// get latest block round
+func (cl *Client) GetBlockHash(ctx context.Context, round uint64) (string, error) {
+	hash, err := cl.algod.GetBlockHash(round).Do(ctx)
+	if err != nil {
+		return "", fmt.Errorf("Failed to get block hash: %v", err)
+	}
+	return hash.Blockhash, nil
+}