Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rarimo/tss-svc

Threshold signature producer service that performs signing of cross chain operations
https://github.com/rarimo/tss-svc

cryptography ecdsa go threshold-signature

Last synced: 29 days ago
JSON representation

Threshold signature producer service that performs signing of cross chain operations

Host: GitHub
URL: https://github.com/rarimo/tss-svc
Owner: rarimo
License: mit
Created: 2023-10-04T11:36:45.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-09-04T12:22:43.000Z (4 months ago)
Last Synced: 2024-09-05T14:04:38.359Z (4 months ago)
Topics: cryptography, ecdsa, go, threshold-signature
Language: Go
Homepage: https://rarimo.github.io/tss-svc/
Size: 3.78 MB
Stars: 4
Watchers: 4
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

---
layout: default
title: TSS service
---

# TSS service

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Threshold signature service provides the signature for core APPROVED operations.
It works as a decentralized solution connected to the core for block timestamp bindings.

The TSS network requires a several parties launched by different validators that uses stored in the `rarimocore`
Cosmos module party addresses and public keys to connect with each other and produce signature.

Fore more information check the [`TSS Overview`](./index.md).

## V1.0.6 Upgrade information

With `v1.0.6` the binance [`tss-lib`](https://github.com/rarimo/tss-lib) was upgraded to the `v2.0.1`.
The v2 version comes with the new pre-params structure. It does not affect the signing process, but
it will cause an error during the next keygen session if you are using old params.

To avoid the errors in case you are already running the party,
you have to generate new pre-params and manually update the `pre` field in Vault. After setting new field data,
please restart the tss party service.

For more information, check: [`changes-of-preparams-of-ecdsa-in-v20`](https://github.com/rarimo/tss-lib#changes-of-preparams-of-ecdsa-in-v20).

## Build

Required environment:
```shell
export CGO_ENABLED=1
```

Build command (in repository root):
```shell
go build .
```

## Launch

### Generate TSS account:
```shell
rarimo-core keys add --keyring-backend test --home=$TSS_HOME
```
(it is recommended to generate the new one and do not use it in other services).

Also, you need to parse mnemonic to get corresponding private key:
```shell
rarimo-core tx rarimocore parse-mnemonic 'mnemonic phrase'
```

### Pre-setup secret parameters:
```shell
tss-svc run paramgen
```
execute and save the response JSON.

### Generate trial ECDSA private key:
```shell
tss-svc run prvgen
```
execute and store results.

### Setup the Hashicorp Vault and create secret for your tss (type KV version 2):

Secret should contain the following credentials:

* "data": "Leave empty"

* "pre": "Generated pre params JSON"

* "account": "Your Rarimo account hex key"

* "trial": "Generated Trial ECDSA private key hex"

JSON example:
```json
{
"tls": true,
"data": "",
"pre": "pre-generated-secret-data",
"account": "rarimo-account-private-key-hex-leading-0x",
"trial": "trial-ecdsa-private-key-hex-leading-0x"
}
```

### Create a configuration file (config.yaml) with the following structure:

```yaml
log:
disable_sentry: true
level: debug

## PostreSQL connection

db:
url: "postgres://tss:tss@tss-2-db:5432/tss?sslmode=disable"

## Port to listen for incoming GRPC requests

listener:
addr: :9000

## Core connections

core:
addr: tcp://validator:26657

cosmos:
addr: validator:9090

## Session configuration (should be the same for all services accross the system)

session:
start_block: 15
start_session_id: 1

## Swagger doc configuration

swagger:
addr: :1313
enabled: false

## Chain configuration

chain:
chain_id: "rarimo_201411-2"
coin_name: "urmo"
```

### Set up host environment:
```yaml
- name: KV_VIPER_FILE
value: /config/config.yaml # is the path to your config file
- name: VAULT_PATH
value: http://vault-internal:8200 # your vault endpoint
- name: VAULT_TOKEN
value: "" # your vault token ("root"/"read/write")
- name: MOUNT_PATH
value: secret
- name: SECRET_PATH
value: tss1 # name of the secret path vault (type KV version 2)
```

### Running service:
```shell
tss-svc migrate up && tss-svc run service
```

Example of docker-compose file:
```yaml
tss-1:
image: registry.github.com/rarimo/tss-svc:v1.0.3
restart: on-failure
depends_on:
- tss-1-db
ports:
- "9001:9000"
- "1313:1313"
volumes:
- ./config/tss/tss1.yaml:/config.yaml
environment:
- KV_VIPER_FILE=/config.yaml
- VAULT_PATH=http://vault:8200
- VAULT_TOKEN=dev-only-token
- MOUNT_PATH=secret
- SECRET_PATH=tss1
entrypoint: sh -c "tss-svc migrate up && tss-svc run service"

tss-1-db:
image: postgres:13
restart: unless-stopped
environment:
- POSTGRES_USER=tss
- POSTGRES_PASSWORD=tss
- POSTGRES_DB=tss
- PGDATA=/pgdata
volumes:
- tss-1-data:/pgdata
```

### Stake tokens to become an active party:
```shell
rarimo-core tx rarimocore stake [tss-account-addr] [tss url] [trial ECDSA pub key] --from $ADDRESS --chain-id rarimo-201411-2 --home=$RARIMO_HOME --keyring-backend=test --fees 0urmo --node=$RARIMO_NODE
```

You can stake tokens directly from your TSS account or by any other account that has enough funds.
Currently, to become an active party you will need exactly 100000000000urmo tokens (100000 RMO).

After some period your TSS will generate new keys with other active parties and become an active party.

### Unstake tokens (from tss account or delegator account):
```shell
rarimo-cored tx rarimocore unstake [tss-account-addr] --from $ADDRESS --chain-id rarimo-201411-2 --home=$RARIMO_HOME --keyring-backend=test --fees 0urmo --node=$RARIMO_NODE
```