Skip to content

Commit

Permalink
Add command to create an auction and add auction CLI tests (#83)
Browse files Browse the repository at this point in the history
Part of [Service provider auctions](https://www.notion.so/Service-provider-auctions-a7b63697d818479493ec145ea6ea3c1c)

Examples:

```bash
# vickrey auction
laconic registry auction create --kind vickrey --commits-duration 60 --reveals-duration 60 --commit-fee 1000 --reveal-fee 1000 --minimum-bid 1000000
```

```bash
# provider auction
laconic registry auction create --kind provider --commits-duration 60 --reveals-duration 60 --commit-fee 1000 --reveal-fee 1000 --max-price 3000000 --num-providers 5

# Release provider auction funds
laconic registry auction release-funds --auction-id <auction-id>
```

Co-authored-by: IshaVenikar <ishavenikar7@gmail.com>
Reviewed-on: https://git.vdb.to/cerc-io/laconic-registry-cli/pulls/83
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
  • Loading branch information
2 people authored and nabarun committed Sep 25, 2024
1 parent 86259b3 commit 0342254
Show file tree
Hide file tree
Showing 10 changed files with 612 additions and 27 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ dist/*
out

config.yml
.env
*~

.idea
.idea
136 changes: 120 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ These commands require a `config.yml` file present in the current working direct
Get node status:

```bash
$ laconic registry status
laconic registry status
{
"version": "0.3.0",
"node": {
Expand Down Expand Up @@ -186,7 +186,7 @@ $ laconic registry status
Get account details:

```bash
$ laconic registry account get --address laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k
laconic registry account get --address laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k
[
{
"address": "laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k",
Expand All @@ -206,7 +206,7 @@ $ laconic registry account get --address laconic15za32wly5exgcrt2zfr8php4ya49n5y
Send tokens:

```bash
$ laconic registry tokens send --address laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k --type alnt --quantity 1000000000
laconic registry tokens send --address laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k --type alnt --quantity 1000000000
{
"tx": {
"hash": "977152CBE474613E1BBAFEF286F12134829FAF3C9E7C8349149DE3E687B816FC",
Expand Down Expand Up @@ -250,7 +250,7 @@ $ laconic registry tokens send --address laconic15za32wly5exgcrt2zfr8php4ya49n5y
Get token TX details:

```bash
$ laconic registry tokens gettx --hash 977152CBE474613E1BBAFEF286F12134829FAF3C9E7C8349149DE3E687B816FC
laconic registry tokens gettx --hash 977152CBE474613E1BBAFEF286F12134829FAF3C9E7C8349149DE3E687B816FC
{
"hash": "977152CBE474613E1BBAFEF286F12134829FAF3C9E7C8349149DE3E687B816FC",
"height": 343369,
Expand Down Expand Up @@ -280,15 +280,15 @@ record:
Publish record (see below for commands to create/query bonds):

```bash
$ laconic registry record publish --filename watcher.yml --bond-id 58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785 --gas 250000 --fees 250000alnt
laconic registry record publish --filename watcher.yml --bond-id 58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785 --gas 250000 --fees 250000alnt
{ id: 'bafyreic3auqajvgszh3vfjsouew2rsctswukc346dmlf273ln4g6iyyhba' }
```
Get record:
```bash
$ laconic registry record get --id bafyreic3auqajvgszh3vfjsouew2rsctswukc346dmlf273ln4g6iyyhba
laconic registry record get --id bafyreic3auqajvgszh3vfjsouew2rsctswukc346dmlf273ln4g6iyyhba
[
{
"id": "bafyreic3auqajvgszh3vfjsouew2rsctswukc346dmlf273ln4g6iyyhba",
Expand Down Expand Up @@ -341,7 +341,7 @@ laconic registry authority reserve laconic
Check authority information:
```bash
$ laconic registry authority whois laconic
laconic registry authority whois laconic
[
{
"ownerAddress": "",
Expand Down Expand Up @@ -387,7 +387,7 @@ $ laconic registry authority whois laconic
Get authority auction info:
```bash
$ laconic registry auction get 0294fb2e3659c347b53a6faf4bef041fd934f0f3ab13df6d2468d5d63abacd48
laconic registry auction get 0294fb2e3659c347b53a6faf4bef041fd934f0f3ab13df6d2468d5d63abacd48
[
{
"id": "0294fb2e3659c347b53a6faf4bef041fd934f0f3ab13df6d2468d5d63abacd48",
Expand Down Expand Up @@ -425,7 +425,7 @@ $ laconic registry auction get 0294fb2e3659c347b53a6faf4bef041fd934f0f3ab13df6d2
Commit an auction bid:
```bash
$ laconic registry auction bid commit 0294fb2e3659c347b53a6faf4bef041fd934f0f3ab13df6d2468d5d63abacd48 25000000 alnt
laconic registry auction bid commit 0294fb2e3659c347b53a6faf4bef041fd934f0f3ab13df6d2468d5d63abacd48 25000000 alnt
Reveal file: ./out/bafyreiay2rccax64yn4ljhvzvm3jkbebvzheyucuma5jlbpzpzd5i5gjuy.json
```
Expand Down Expand Up @@ -475,7 +475,7 @@ laconic registry name set lrn://laconic/watcher/erc20 bafyreic3auqajvgszh3vfjsou
Lookup name information:
```bash
$ laconic registry name lookup lrn://laconic/watcher/erc20
laconic registry name lookup lrn://laconic/watcher/erc20
[
{
"latest": {
Expand All @@ -489,7 +489,7 @@ $ laconic registry name lookup lrn://laconic/watcher/erc20
Resolve name:
```bash
$ laconic registry name resolve lrn://laconic/watcher/erc20
laconic registry name resolve lrn://laconic/watcher/erc20
[
{
"id": "bafyreic3auqajvgszh3vfjsouew2rsctswukc346dmlf273ln4g6iyyhba",
Expand Down Expand Up @@ -530,9 +530,9 @@ $ laconic registry name resolve lrn://laconic/watcher/erc20
Delete name:
```bash
$ laconic registry name delete lrn://laconic/watcher/erc20
laconic registry name delete lrn://laconic/watcher/erc20
$ laconic registry name resolve lrn://laconic/watcher/erc20
laconic registry name resolve lrn://laconic/watcher/erc20
[
null
]
Expand All @@ -547,7 +547,7 @@ laconic registry bond create --type alnt --quantity 1000
List bonds:
```bash
$ laconic registry bond list
laconic registry bond list
[
{
"id": "58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785",
Expand Down Expand Up @@ -575,7 +575,7 @@ $ laconic registry bond list
Get bond:
```bash
$ laconic registry bond get --id 58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785
laconic registry bond get --id 58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785
[
{
"id": "58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785",
Expand All @@ -593,7 +593,7 @@ $ laconic registry bond get --id 58508984500aa2ed18e059fa8203b40fbc9828e3bfa1953
Query bonds by owner:
```bash
$ laconic registry bond list --owner laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k
laconic registry bond list --owner laconic15za32wly5exgcrt2zfr8php4ya49n5y7masu7k
[
{
"id": "58508984500aa2ed18e059fa8203b40fbc9828e3bfa195361335c4e4524c4785",
Expand Down Expand Up @@ -659,3 +659,107 @@ Reassociate records (switch bond):
```bash
laconic registry bond records reassociate --old-bond-id 5c40abd336ae1561f2a1b55be73b12f5a083080bf879b4c9288d182d238badb0 --new-bond-id 3e11c61f179897e4b12e9b63de35d36f88ac146755e7a28ce0bcdd07cf3a03ae
```
Create a `provider` auction:
```bash
laconic registry auction create --kind provider --commits-duration 60 --reveals-duration 60 --denom alnt --commit-fee 1000 --reveal-fee 1000 --max-price 100000 --num-providers 5
{"auctionId":"73c5fa4b91bb973641ccbb6901a8404745fb8793c95485b00d5a791e6b6c1630"}
# Set auction id in a variable
AUCTION=
```
Commit an auction bid:
```bash
laconic registry auction bid commit $AUCTION 25000 alnt
{"reveal_file":"/home/user/laconic-registry-cli/out/bafyreiai5upey4562ont54pe7m3buiphtd6n3q2vr5lxdcj3gpyklbbgvy.json"}
```
Reveal an auction bid:
```bash
laconic registry auction bid reveal $AUCTION /home/user/laconic-registry-cli/out/bafyreiai5upey4562ont54pe7m3buiphtd6n3q2vr5lxdcj3gpyklbbgvy.json
{"success": true}
```
Check the auction state on completion:
```bash
laconic registry auction get $AUCTION
[
{
"id": "b66b74048fc360de6a926123b760e6485276d90ad2274b5386c02664cd04bace",
"kind": "provider",
"status": "completed",
"ownerAddress": "laconic1maqfgs93hnvzqh5mfj9kxt4e3n27vhd0w7emrx",
"createTime": "2024-09-17T09:51:48.605610628",
"commitsEndTime": "2024-09-17T09:52:48.605610628",
"revealsEndTime": "2024-09-17T09:53:48.605610628",
"commitFee": {
"type": "alnt",
"quantity": 1000
},
"revealFee": {
"type": "alnt",
"quantity": 1000
},
"minimumBid": {
"type": "",
"quantity": 0
},
"winnerAddresses": [
"laconic13qrlfkgl02wgwpw0n4j8kswygwnukphy92249r"
],
"winnerBids": [
{
"type": "alnt",
"quantity": 25000
}
],
"winnerPrice": {
"type": "alnt",
"quantity": 25000
},
"maxPrice": {
"type": "alnt",
"quantity": 100000
},
"numProviders": 5,
"bids": [
{
"bidderAddress": "laconic13qrlfkgl02wgwpw0n4j8kswygwnukphy92249r",
"status": "reveal",
"commitHash": "bafyreifjkhiakayvvaasnsw7ufaax54ncow4xuycqnox7hxay34c6yod7a",
"commitTime": "2024-09-17T09:52:03.665761945",
"revealTime": "2024-09-17T09:53:00.904061323",
"commitFee": {
"type": "alnt",
"quantity": 1000
},
"revealFee": {
"type": "alnt",
"quantity": 1000
},
"bidAmount": {
"type": "alnt",
"quantity": 25000
}
}
]
}
]
```
Release provider winning funds:
```bash
laconic registry auction release-funds $AUCTION
{"success": true}
```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@cerc-io/laconic-registry-cli",
"version": "0.2.8",
"version": "0.2.9",
"main": "index.js",
"repository": "git@github.com:cerc-io/laconic-registry-cli.git",
"author": "",
Expand Down Expand Up @@ -29,7 +29,7 @@
"typescript": "^4.6.3"
},
"dependencies": {
"@cerc-io/registry-sdk": "^0.2.9",
"@cerc-io/registry-sdk": "^0.2.10",
"@cosmjs/stargate": "^0.32.2",
"fs-extra": "^10.1.0",
"js-yaml": "^3.14.1",
Expand Down
106 changes: 106 additions & 0 deletions src/cmds/registry-cmds/auction-cmds/create.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
import { Arguments } from 'yargs';
import assert from 'assert';

import { AUCTION_KIND_PROVIDER, AUCTION_KIND_VICKREY, Registry } from '@cerc-io/registry-sdk';

import { getConfig, getConnectionInfo, getGasAndFees, getGasPrice, txOutput } from '../../../util';

export const command = 'create';

export const desc = 'Create auction.';

export const builder = {
kind: {
type: 'string',
describe: 'Auction kind (vickrey | provider)'
},
'commits-duration': {
type: 'string',
describe: 'Duration for bid commit phase in seconds'
},
'reveals-duration': {
type: 'string',
describe: 'Duration for bid reveal phase in seconds'
},
denom: {
type: 'string',
describe: 'Denom to use'
},
'commit-fee': {
type: 'string',
describe: 'Fee for committing a bid to the auction'
},
'reveal-fee': {
type: 'string',
describe: 'Fee for revealing a bid in the auction'
},
'minimum-bid': {
type: 'string',
default: 0,
describe: 'Minimum bid amount (only for vickrey auction)'
},
'max-price': {
type: 'string',
default: 0,
describe: 'Max acceptable bid price (only for provider auction)'
},
'num-providers': {
type: 'number',
describe: 'Number ofdesired providers (only for provider auction)'
}
};

export const handler = async (argv: Arguments) => {
const { config } = argv;

const kind = argv.kind as string;
const validAuctionKinds = [AUCTION_KIND_VICKREY, AUCTION_KIND_PROVIDER];
assert(validAuctionKinds.includes(kind), `Invalid auction kind, has to be one of ${validAuctionKinds}.`);

if (kind === AUCTION_KIND_VICKREY) {
assert(argv.minimumBid, 'Invalid minimum bid.');
assert(!argv.maxPrice, `Max price can only be used with ${AUCTION_KIND_PROVIDER} auction.`);
assert(!argv.numProviders, `Num providers can only be used with ${AUCTION_KIND_PROVIDER} auction.`);
} else if (kind === AUCTION_KIND_PROVIDER) {
assert(argv.maxPrice, 'Invalid max price.');
assert(argv.numProviders, 'Invalid num providers.');
assert(!argv.minimumBid, `Minimum bid can only be used with ${AUCTION_KIND_VICKREY} auction.`);
}

assert(argv.commitsDuration, 'Invalid commits duration.');
assert(argv.revealsDuration, 'Invalid reveals duration.');
assert(argv.commitFee, 'Invalid commit fee.');
assert(argv.revealFee, 'Invalid reveal fee.');

const commitsDuration = argv.commitsDuration as string;
const revealsDuration = argv.revealsDuration as string;

const denom = argv.denom as string;
const commitFee = argv.commitFee as string;
const revealFee = argv.revealFee as string;
const minimumBid = argv.minimumBid as string;
const maxPrice = argv.maxPrice as string;
const numProviders = argv.numProviders as number;

const { services: { registry: registryConfig } } = getConfig(config as string);
const { rpcEndpoint, gqlEndpoint, privateKey, chainId } = getConnectionInfo(argv, registryConfig);
assert(rpcEndpoint, 'Invalid registry RPC endpoint.');
assert(gqlEndpoint, 'Invalid registry GQL endpoint.');
assert(privateKey, 'Invalid Transaction Key.');
assert(chainId, 'Invalid registry Chain ID.');

const gasPrice = getGasPrice(argv, registryConfig);
const registry = new Registry(gqlEndpoint, rpcEndpoint, { chainId, gasPrice });

const fee = getGasAndFees(argv, registryConfig);

let result: any;
if (kind === AUCTION_KIND_VICKREY) {
result = await registry.createAuction({ commitsDuration, revealsDuration, denom, commitFee, revealFee, minimumBid }, privateKey, fee);
} else {
result = await registry.createProviderAuction({ commitsDuration, revealsDuration, denom, commitFee, revealFee, maxPrice, numProviders }, privateKey, fee);
}

const jsonString = `{"auctionId":"${result.auction?.id}"}`;
txOutput(result, jsonString, argv.output, argv.verbose);
};
Loading

0 comments on commit 0342254

Please sign in to comment.