Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 4.47 KB

README.md

File metadata and controls

63 lines (37 loc) · 4.47 KB
Raw

Kuoka Multisig Workflows

Intro

This project in an implementation of a multisig contract for the Kuoka Project (@KuokaProject). It is based on the HoverLabs multisig-timelock contract. Modification were made to add the ability to directly manage an xtz coin balance and to set a delegate.

Other code in this repository contains examples of how this contract can be used in several scenarios. It is using the ConseilJS library from Cryptonomic. Smart contract is written using SmartPy.

Deploy

The code in this repository is not meant to be used in production directly. It is a collection of examples that can be integrated into a user-friend UI for the relevant multisig workflows. The included code can be used to demonstrate the functionality of the contract. To do so, several test accounts need to be created and the the base contract needs to be deployed. Token transfers, both plain (FA1.2) and indexed (FA2) will require a token balance to be assigned to the multisig contract.

To deploy the contract use npm run deployMultisig.

Rotate Keys

Using npm run rotateKeys

Delegate

TBD

Transfer Balance

Using npm run transferBalance

Transfer Tokens

Using npm run transferToken

Transfer Indexed Tokens

TBD

Initialize Test Accounts

Test accounts can be created on teztnets. Several will be needed to run a full test, including at least three for the signers and perhaps more for deployment and contribution testing.

Configuration Items

config.json includes some required parameters. node is a Tezos RPC node for blockchain interactions. Currently it's using Nautilus Cloud from Cryptonomic. accounts is a list of tz1 Tezos accounts which will be interpreted as file names for the /accounts directory. tz1---.json is expected to be a faucet file from teztnets. tz1---.keys is expected to be a JSON file containing two keys, sk and pk, secret and public key respectively. At a minimum this repo requires three accounts. The multisig section contains a threshold, which is set to two initially, that is a minimum number of signatures required to execute an operation and timelock – a number of seconds to wait before an operation can be executed, for testing it's set to 30 seconds. After a contract is deployed an address will be added to this section which the various test scripts in this repo will use to interact with the multisig.

Quick Start

This section describes a quick & dirty deployment of a multisig contract. This is not intended to be representative of best practices for key management.

The following commands will deploy a multisig with two of three signers, the "deployer", "signer1", "signer2" accounts and a 30 second time-lock duration. The deployer must have a private key available to sign the deployment transaction. The first item in the accounts list is used as the deployment account and mush have the private key in it. Please take care to secure your private keys.

  1. mkdir KuokaMultisig && cd ./KuokaMultisig
  2. git clone https://github.com/anonymoussprocket/KuokaMultisig.git .
  3. npm i
  4. rm ./accounts/*
  5. echo "{\"sk\":\"<DEPLOYER_PRIVATE_KEY: edsk...>\",\"pk\":\"<DEPLOYER_PUBLIC_KEY: edpk...>\"}" > ./accounts/deployer.keys
  6. echo "{\"pk\":\"<SIGNER1_PUBLIC_KEY: edpk...>\"}" > ./accounts/signer1.keys
  7. echo "{\"pk\":\"<SIGNER2_PUBLIC_KEY: edpk...>\"}" > ./accounts/signer2.keys
  8. rm ./config.json
  9. echo "{ \"node\": \"https://tezos-prod.cryptonomic-infra.tech\", \"accounts\": [ \"deployer\", \"signer1\", \"signer2\" ], \"multisig\": { \"threshold\": 2, \"timelock\": 30 } }" > ./config.json
  10. npm run deployMultisig

Using the contract deployed above these commands will queue a balance transfer operation. This process is described in transferBalance.ts. Accordingly, 0.1 XTZ will be transferred to the first signer in the config file, the account described in deployer.keys. Note that for this operation it's necessary to have the private key for the signer account.

  1. echo "{\"sk\":\"<SIGNER1_PRIVATE_KEY: edsk...>\", \"pk\":\"<SIGNER1_PUBLIC_KEY: edpk...>\"}" > ./accounts/signer1.keys
  2. npm run transferBalance