Overview

This document serves as a step-by-step guide on how protocols can mint bonded governance tokens and initialise an auction to sell bonded governance tokens using Socean’s command-line interface (CLI) tool.

This flowchart summarises the 4 steps required to execute the above-mentioned actions:

https://whimsical.com/socean-streams-user-flow-for-protocols-WrjK1TKgX1yWTC9vf1y56A

1. Programs and CLI executables

1.1 Installing the CLI

• npm i -g @soceanfi/bonding-cli to install the bonding program CLI, bonding.
• npm i -g @soceanfi/descending-auction-cli to install the descending auction program CLI, desc.
• (You can also install the packages using yarn, and to a local project instead to avoid polluting the global namespace)

1.2 Understanding the programs

You should understand the two programs and their respective CLI executables below when interacting with the Socean Streams product.

• Bond Pool program
• bonding CLI executable
• Auction program
• desc CLI executable

2. Predefined parameters

You will be required to define the following parameters when using the our Bond Pool and Auction programs: