Skip to content

Commit 4abe140

Browse files
committed
docs(bank): README fixes
1 parent 172c008 commit 4abe140

File tree

1 file changed

+31
-35
lines changed

1 file changed

+31
-35
lines changed

x/bank/README.md

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,6 @@ aforementioned state:
116116
* Balances Index: `0x2 | byte(address length) | []byte(address) | []byte(balance.Denom) -> ProtocolBuffer(balance)`
117117
* Reverse Denomination to Address Index: `0x03 | byte(denom) | 0x00 | []byte(address) -> 0`
118118

119-
Here's a tightened, Google-style rewrite that keeps the key sections you liked and trims the rest for focus and clarity:
120-
121-
---
122-
123119
## Nibiru Extensions to `x/bank`
124120

125121
### What's different on Nibiru
@@ -536,7 +532,7 @@ nibid tx bank send [from_key_or_address] [to_address] [amount] [flags]
536532
Example:
537533

538534
```bash
539-
nibid tx bank send cosmos1.. cosmos1.. 100stake
535+
nibid tx bank send nibi1.. nibi1.. 100unibi
540536
```
541537

542538

@@ -559,15 +555,15 @@ nibid query bank balances [address] [flags]
559555
Example:
560556

561557
```bash
562-
nibid query bank balances cosmos1..
558+
nibid query bank balances nibi1..
563559
```
564560

565561
Example Output:
566562

567563
```yml
568564
balances:
569565
- amount: "1000000000"
570-
denom: stake
566+
denom: unibi
571567
pagination:
572568
next_key: null
573569
total: "0"
@@ -584,20 +580,20 @@ nibid query bank denom-metadata [flags]
584580
Example:
585581

586582
```bash
587-
nibid query bank denom-metadata --denom stake
583+
nibid query bank denom-metadata --denom unibi
588584
```
589585

590586
Example Output:
591587

592588
```yml
593589
metadata:
594-
base: stake
590+
base: unibi
595591
denom_units:
596592
- aliases:
597-
- STAKE
598-
denom: stake
593+
- UNIBI
594+
denom: unibi
599595
description: native staking token of simulation app
600-
display: stake
596+
display: unibi
601597
name: SimApp Token
602598
symbol: STK
603599
```
@@ -613,14 +609,14 @@ nibid query bank total [flags]
613609
Example:
614610

615611
```bash
616-
nibid query bank total --denom stake
612+
nibid query bank total --denom unibi
617613
```
618614

619615
Example Output:
620616

621617
```yml
622618
amount: "10000000000"
623-
denom: stake
619+
denom: unibi
624620
```
625621

626622
##### send-enabled
@@ -665,7 +661,7 @@ Example:
665661

666662
```bash
667663
grpcurl -plaintext \
668-
-d '{"address":"cosmos1..","denom":"stake"}' \
664+
-d '{"address":"nibi1..","denom":"unibi"}' \
669665
localhost:9090 \
670666
cosmos.bank.v1beta1.Query/Balance
671667
```
@@ -675,7 +671,7 @@ Example Output:
675671
```json
676672
{
677673
"balance": {
678-
"denom": "stake",
674+
"denom": "unibi",
679675
"amount": "1000000000"
680676
}
681677
}
@@ -693,7 +689,7 @@ Example:
693689

694690
```bash
695691
grpcurl -plaintext \
696-
-d '{"address":"cosmos1.."}' \
692+
-d '{"address":"nibi1.."}' \
697693
localhost:9090 \
698694
cosmos.bank.v1beta1.Query/AllBalances
699695
```
@@ -704,7 +700,7 @@ Example Output:
704700
{
705701
"balances": [
706702
{
707-
"denom": "stake",
703+
"denom": "unibi",
708704
"amount": "1000000000"
709705
}
710706
],
@@ -726,7 +722,7 @@ Example:
726722

727723
```bash
728724
grpcurl -plaintext \
729-
-d '{"denom":"stake"}' \
725+
-d '{"denom":"unibi"}' \
730726
localhost:9090 \
731727
cosmos.bank.v1beta1.Query/DenomMetadata
732728
```
@@ -739,14 +735,14 @@ Example Output:
739735
"description": "native staking token of simulation app",
740736
"denomUnits": [
741737
{
742-
"denom": "stake",
738+
"denom": "unibi",
743739
"aliases": [
744-
"STAKE"
740+
"UNIBI"
745741
]
746742
}
747743
],
748-
"base": "stake",
749-
"display": "stake",
744+
"base": "unibi",
745+
"display": "unibi",
750746
"name": "SimApp Token",
751747
"symbol": "STK"
752748
}
@@ -778,14 +774,14 @@ Example Output:
778774
"description": "native staking token of simulation app",
779775
"denomUnits": [
780776
{
781-
"denom": "stake",
777+
"denom": "unibi",
782778
"aliases": [
783-
"STAKE"
779+
"UNIBI"
784780
]
785781
}
786782
],
787-
"base": "stake",
788-
"display": "stake",
783+
"base": "unibi",
784+
"display": "unibi",
789785
"name": "SimApp Token",
790786
"symbol": "STK"
791787
}
@@ -808,7 +804,7 @@ Example:
808804

809805
```bash
810806
grpcurl -plaintext \
811-
-d '{"denom":"stake"}' \
807+
-d '{"denom":"unibi"}' \
812808
localhost:9090 \
813809
cosmos.bank.v1beta1.Query/DenomOwners
814810
```
@@ -819,16 +815,16 @@ Example Output:
819815
{
820816
"denomOwners": [
821817
{
822-
"address": "cosmos1..",
818+
"address": "nibi1..",
823819
"balance": {
824-
"denom": "stake",
820+
"denom": "unibi",
825821
"amount": "5000000000"
826822
}
827823
},
828824
{
829-
"address": "cosmos1..",
825+
"address": "nibi1..",
830826
"balance": {
831-
"denom": "stake",
827+
"denom": "unibi",
832828
"amount": "5000000000"
833829
}
834830
},
@@ -861,7 +857,7 @@ Example Output:
861857
{
862858
"supply": [
863859
{
864-
"denom": "stake",
860+
"denom": "unibi",
865861
"amount": "10000000000"
866862
}
867863
],
@@ -883,7 +879,7 @@ Example:
883879

884880
```bash
885881
grpcurl -plaintext \
886-
-d '{"denom":"stake"}' \
882+
-d '{"denom":"unibi"}' \
887883
localhost:9090 \
888884
cosmos.bank.v1beta1.Query/SupplyOf
889885
```
@@ -893,7 +889,7 @@ Example Output:
893889
```json
894890
{
895891
"amount": {
896-
"denom": "stake",
892+
"denom": "unibi",
897893
"amount": "10000000000"
898894
}
899895
}

0 commit comments

Comments
 (0)