Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
170 commits
Select commit Hold shift + click to select a range
7fc4d96
Use host default name server in docker
auxten Mar 6, 2019
cccf455
Merge pull request #276 from CovenantSQL/bugfix/dockerUseHostDNS
Mar 7, 2019
74c0c84
Update README.md
auxten Mar 7, 2019
bd3a1cd
Update README.md
auxten Mar 7, 2019
8513c62
Add video link
auxten Mar 7, 2019
91b63e5
Trim release pkg
Mar 8, 2019
40ea242
Remove cql-adapter
auxten Mar 8, 2019
305339b
Merge pull request #278 from CovenantSQL/feature/trimReleasePkg
auxten Mar 10, 2019
109bfea
Add more test for symmetric
Mar 10, 2019
671c434
Add end to end decrypt encrypt func
Mar 10, 2019
2fcc7b0
Support content-type header in cors
Mar 12, 2019
0beb125
Merge pull request #280 from CovenantSQL/bugfix/cors_allowed_headers
foreseaz Mar 12, 2019
14e4384
Merge branch 'develop' into feature/e2eCrypt
xq262144 Mar 13, 2019
c4645e2
Merge pull request #279 from CovenantSQL/feature/e2eCrypt
auxten Mar 13, 2019
f321302
Add demos
auxten Mar 16, 2019
e740de2
Update demos
auxten Mar 16, 2019
a784986
Remove one useless flag. Reorder some code.
laodouya Mar 7, 2019
b5a8bfe
Split cql command func into internal package
laodouya Mar 14, 2019
4a08673
Move log and waitTxConfirmationMaxDuration to internal vars.
laodouya Mar 14, 2019
b5e0875
Fix UsqlRegister should not use outside variable.
laodouya Mar 14, 2019
60a6806
Move cql console funcs to internal/command
laodouya Mar 14, 2019
32718ec
Refactor interactive usql feature into console command.
laodouya Mar 14, 2019
c9735f1
Refactor version print into version command.
laodouya Mar 15, 2019
d186072
Refactor token balance check funcs into balance command.
laodouya Mar 15, 2019
2f59c1d
Refactor createDB feature into create command.
laodouya Mar 15, 2019
dc4fa1a
Refactor dropDB feature into drop command.
laodouya Mar 15, 2019
292137c
Fail while cql drop command could not wait tx confirm.
laodouya Mar 15, 2019
8513210
Refactor updatePermission feature into permission command.
laodouya Mar 15, 2019
eb6f562
Refactor transferToken feature into transfer command.
laodouya Mar 15, 2019
93b77dd
Move ConsoleLog init into package.
laodouya Mar 15, 2019
bbef278
Refactor explorer feature into cql web command.
laodouya Mar 16, 2019
b49fee4
Refactor adapter feature into cql adapter command.
laodouya Mar 16, 2019
3a04bf7
Add new line after one console output.
laodouya Mar 17, 2019
f7af2a4
Change web and adapter start process into a func.
laodouya Mar 17, 2019
29bd64b
Add web and adapter params for console command.
laodouya Mar 17, 2019
70ec1fa
Make golint happy.
laodouya Mar 18, 2019
2c5d31c
Fix cql test case.
laodouya Mar 18, 2019
d3b14b7
Fix old client compatibility test.
laodouya Mar 18, 2019
dcad0f4
Fix unit test: cql.test should set -test.coverprofile flag first befo…
laodouya Mar 18, 2019
159e0ff
Fix compatibility test.
laodouya Mar 18, 2019
359d218
Change cql create subcommand, only accept metainfo json string as par…
laodouya Mar 18, 2019
6a9fd16
Refactor benchmark codes and scripts
leventeliu Mar 18, 2019
653ff8c
Merge remote-tracking branch 'origin/develop' into feature/bench_arg
leventeliu Mar 18, 2019
9eb99bd
Minor fix
leventeliu Mar 18, 2019
ad0bb8f
Update licence in code.
laodouya Mar 18, 2019
641b58a
Add function to make bench name for parsing
leventeliu Mar 18, 2019
14395bc
Add eventual consistency benchmark in GNTE
leventeliu Mar 18, 2019
577c112
Add help info while no command provide.
laodouya Mar 18, 2019
73b61df
Merge pull request #285 from CovenantSQL/feature/bench_arg
leventeliu Mar 18, 2019
4d6dd7e
Add help command to show sub command usage.
laodouya Mar 18, 2019
7edd4a1
Merge branch 'develop' into feature/cql_refactor
Mar 18, 2019
90e35a8
Modify cql command help grammar.
laodouya Mar 19, 2019
086d11c
Update cql README.
laodouya Mar 19, 2019
c2a8a90
Update cql README.
laodouya Mar 19, 2019
b468835
Update cql help description.
laodouya Mar 19, 2019
1a9fa33
Make cql read password of master key from terminal as default.
laodouya Mar 20, 2019
b707682
Update test case with -no-password.
laodouya Mar 20, 2019
8199f47
Remove -password in all usage line.
laodouya Mar 20, 2019
99b5532
Remove [] in required params.
laodouya Mar 20, 2019
75051ba
Exit with 0 if cql help has no errors.
laodouya Mar 20, 2019
8ef09e1
Rename permission command to grant.
laodouya Mar 20, 2019
a02b689
Rename web command to explorer.
laodouya Mar 20, 2019
4c5d3f8
Format cql help command tab
laodouya Mar 20, 2019
b5c005a
Fix cql explorer unit test.
laodouya Mar 20, 2019
bc8a56a
Merge pull request #284 from CovenantSQL/feature/cql_refactor
Mar 20, 2019
207db59
Fix bug in dbms updatePermission call
Mar 18, 2019
c2d1e3d
Allow permission revocation in transaction processing
Mar 18, 2019
e6f964d
Update faucet to support various new web operations
Mar 18, 2019
c177346
Fix typo of errors package
Mar 18, 2019
2e3817d
Support overriding listen addr in faucet commandline
Mar 18, 2019
043148f
Return token amount in faucet api
Mar 18, 2019
2c9ee84
Use argTx instead of constant literal
Mar 18, 2019
39a3378
Add missing log to faucet persistence init error
Mar 18, 2019
19a750e
Add keystore in conf to docker ignore list
Mar 18, 2019
91701c6
Fix typo in faucet api callbacks
Mar 18, 2019
5b450ad
Add optional node count support for database creation
Mar 20, 2019
1e99e6e
Fix update permission test case nonce no
Mar 20, 2019
3c6b3e2
Golint issues
Mar 20, 2019
dd7f080
Add missing break to users permission update
Mar 21, 2019
6c3f566
Use sqlite for dht key store
Mar 21, 2019
fe9c288
Update gitignore for keystore temp files including sqlite wal/shm
Mar 21, 2019
efcafe8
Merge pull request #286 from CovenantSQL/feature/faucet_v2
xq262144 Mar 21, 2019
99cc4a1
Merge branch 'develop' into feature/sqlite3_pubkeystore
xq262144 Mar 21, 2019
625e974
Remove current keystore file only when backup already exists
Mar 21, 2019
12dfa79
Add kms public keystore recycle function for leak test
Mar 21, 2019
180d97d
Fix invalid format directive
Mar 20, 2019
d7a614b
Close opened public key store before init
Mar 21, 2019
4c65bae
Fix corner case in keystore unit test
Mar 21, 2019
cc9fbfc
Fix error on empty or file length shorted than sqlite magic files
Mar 21, 2019
d272202
Fix twopc import cycle bug
Mar 21, 2019
eea91b5
Recycle keystore file in unit test
Mar 21, 2019
aedcfda
Merge pull request #287 from CovenantSQL/feature/sqlite3_pubkeystore
leventeliu Mar 22, 2019
9d3ba9b
Remove dangling observer source code
Mar 20, 2019
3b17424
Update observer api prefix
Mar 20, 2019
2edbeee
Remove blank line in sqlchain/observer
Mar 21, 2019
45aa36b
Add mirror service
Mar 21, 2019
ac7cac1
Use caller interface in client connection caller
Mar 21, 2019
c2e4dd1
Add mirror server support for client package
Mar 21, 2019
bb47dc6
Support using mirror server in adapter
Mar 21, 2019
3a52377
Remove test binary flag in unit test
Mar 22, 2019
57156cf
Add observer suffix in test coverage file name
Mar 22, 2019
f9faf11
Add mirror feature integration test
Mar 22, 2019
5fca901
Enable log to stderr for mirror server
Mar 22, 2019
1e4b7ce
Add non-padding test
Mar 22, 2019
f82a55b
Add missing mirror config file
Mar 22, 2019
4f01e3a
Update cleanup db script
Mar 22, 2019
1e5489d
Use SIGINT instead of SIGTERM for integration test subprocess signal
Mar 22, 2019
9bd6f9f
Add integration test case coverage for bin/cql.test
Mar 22, 2019
697f7fb
Client dsn mirror option coverage
Mar 22, 2019
03c56e1
Add more rpc unit test
Mar 22, 2019
301aa44
Add use follower flag test in integration test
Mar 22, 2019
eec853e
Use SIGTERM instead of SIGINT in process exit control
Mar 22, 2019
943b3fc
Add missing return statement
Mar 22, 2019
bbae073
Remove useless err check
Mar 22, 2019
35e4643
Make cql mirror accept both dsn and database_id.
Mar 22, 2019
359a508
Merge pull request #288 from CovenantSQL/feature/client_readonly_cache
leventeliu Mar 22, 2019
bc3b272
Move 'cql-utils -tool rpc' func to 'cql rpc' command.
laodouya Mar 21, 2019
54864de
Add askDeletePath to cql program.
Mar 22, 2019
2f5b61d
Label cql drop as current not supported. Print config filepath if ini…
Mar 22, 2019
7865ca2
Add generate command. add generate addr func.
Mar 26, 2019
0406218
Rename 'cql generate addr' to 'cql generate wallet'. And use public k…
Mar 26, 2019
a8766b4
Delete addr gen func in cql-utils cmd
Mar 26, 2019
53b3947
Remove IsTestMode use UseTestMasterKey instead
Mar 26, 2019
b59b844
Fix client unit test
Mar 26, 2019
7b9120a
Remove Uint256 to IPv6 stuff, use https://github.com/CovenantSQL/beacon
Mar 26, 2019
7bfa51a
Remove DNSSEC for bootstrap
Mar 26, 2019
abab9c8
Add const PublicKeyBytesLen PublicKeyFormatHeader
Mar 26, 2019
98d4b18
Add 'cql generate public' func
Mar 26, 2019
2677712
Delete keytool func in cql-utils cmd
Mar 26, 2019
9d6e426
Add getPublic func for get existing public key
Mar 26, 2019
4d886bb
Simplify generated cql conf
Mar 26, 2019
1835b4b
Use UseTestMasterKey in yaml
Mar 26, 2019
c098b33
Cleanup all conf.GConf.IsTestMode
Mar 26, 2019
729d987
Move getPublic() to cql/cfg.go, remove 'cql generate nonce' type.
Mar 26, 2019
b42e42f
Remove DNSSEC stuff package
Mar 26, 2019
9b8147a
Add cql idminer command.
Mar 26, 2019
bfa6f04
Delete miner, nonce func in cql-utils cmd
Mar 26, 2019
49a1051
Remove cql-utils/keygen.go
Mar 26, 2019
31d9f33
Avoid PingBP with BP node info
Mar 26, 2019
d83b7dc
Add 'cql generate config' func.
Mar 26, 2019
6569f10
Remove cql-utils program.
Mar 26, 2019
a9de684
Update testnet test.
Mar 26, 2019
9425950
Update docs.
Mar 26, 2019
9bc50d6
client.Drop return nil anyway.
Mar 26, 2019
35aac94
Add DNSSeed.BPCount
Mar 26, 2019
dc95c01
Add default DNSSeed info for clients
Mar 26, 2019
d7bfc8b
Add TestGenTestNetDomain
Mar 26, 2019
85b0fca
Merge remote-tracking branch 'origin/develop' into feature/dns-bootstrap
Mar 26, 2019
50784cc
Fix IsTestMode
Mar 26, 2019
d76877d
Fix compatibility test
Mar 26, 2019
959cd8b
Remove default config.DNSSeed.Domain
Mar 26, 2019
2e1912e
Fix log typo
Mar 26, 2019
babcdba
Change integration test domain
Mar 26, 2019
7a73a10
Add default config.BPPeriod = 3s
Mar 26, 2019
f5b8f6c
Default BPPeriod = 10 * time.Second
Mar 26, 2019
23dee46
Fix IntergrationTestDomain
Mar 26, 2019
625e96d
Update cql rpc help info.
Mar 26, 2019
c475009
Fix TestStartBP_CallRPC
Mar 26, 2019
9899f0a
Make golint happy
Mar 26, 2019
3fa9a43
Keep testnet config existing known nodes
Mar 27, 2019
52db6cc
Merge pull request #290 from CovenantSQL/feature/dns-bootstrap
leventeliu Mar 27, 2019
7cd6afe
Merge remote-tracking branch 'origin/develop' into feature/cql_utils_…
Mar 27, 2019
38e860b
Fix merge conflict
Mar 27, 2019
81e7a61
Rename balance command to wallet -balance.
Mar 27, 2019
c0363d5
Update testnet testcase.
Mar 27, 2019
362076b
Use strings.EqualFold for user typing check.
Mar 27, 2019
0d058c6
Fix compatibility test.
Mar 27, 2019
18e650b
Merge pull request #291 from CovenantSQL/feature/cql_utils_refactor
auxten Mar 27, 2019
cda2a61
Merge remote-tracking branch 'origin/develop' into feature/beta_upstream
leventeliu Mar 27, 2019
e470313
Fix mirror test case waiting logic bug
Mar 27, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
test/
bin/cql*
conf/testnet*/*.keystore
*.cover.out
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ idminer
coverage.txt
analysisVendor.png
vendor/**/.gitignore
*.keystore
*.keystore*
node_*/
kayak_test
*.conf
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ before_deploy:
- make clean
- make use_all_cores
- mkdir -p build
- tar czvf build/CovenantSQL-$TRAVIS_TAG.$TRAVIS_OS_NAME-amd64.tar.gz $(ls bin/cql* | grep -v test)
- tar czvf build/CovenantSQL-$TRAVIS_TAG.$TRAVIS_OS_NAME-amd64.tar.gz bin/cql bin/cql-fuse bin/cql-minerd bin/cql-mysql-adapter bin/cql-utils

deploy:
provider: releases
Expand Down
58 changes: 11 additions & 47 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions Gopkg.toml
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,7 @@
[[constraint]]
name = "github.com/rakyll/statik"
version = "0.1.5"

[[constraint]]
branch = "master"
name = "github.com/CovenantSQL/beacon"
10 changes: 2 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,6 @@ bin/cql-minerd:
-o bin/cql-minerd \
github.com/CovenantSQL/CovenantSQL/cmd/cql-minerd

bin/cql-utils:
$(GOBUILD) \
-ldflags "$(ldflags_role_client_simple_log)" \
-o bin/cql-utils \
github.com/CovenantSQL/CovenantSQL/cmd/cql-utils

bin/cql:
$(GOBUILD) \
-ldflags "$(ldflags_role_client_simple_log)" \
Expand Down Expand Up @@ -181,7 +175,7 @@ bp: bin/cqld.test bin/cqld

miner: bin/cql-minerd.test bin/cql-minerd

client: bin/cql-utils bin/cql bin/cql.test bin/cql-fuse bin/cql-mysql-adapter bin/cql-faucet
client: bin/cql bin/cql.test bin/cql-fuse bin/cql-mysql-adapter bin/cql-faucet

all: bp miner client

Expand All @@ -191,5 +185,5 @@ clean:
rm -f coverage.txt

.PHONY: status start stop logs push push_testnet clean \
bin/cqld.test bin/cqld bin/cql-minerd.test bin/cql-minerd bin/cql-utils \
bin/cqld.test bin/cqld bin/cql-minerd.test bin/cql-minerd \
bin/cql bin/cql.test bin/cql-fuse bin/cql-mysql-adapter bin/cql-faucet
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ sql.Open("CovenantSQL", dbURI)
- Each Database has its own independent distributed engine.
- Mainly responsible for: database storage & encryption, query processing & signature, efficient indexing.

## How it works
[How CovenantSQL works(video)](https://youtu.be/2Mz5POxxaQM?t=106)

## Demos

- [CovenantForum](https://demo.covenantsql.io/forum/)
- [Twitter Bot @iBlockPin](https://twitter.com/iblockpin)
- [Weibo Bot @BlockPin](https://weibo.com/BlockPin)
- [Markdown Editor with CovenantSQL sync](https://github.com/CovenantSQL/stackedit)
- [Web Admin for CovenantSQL](https://github.com/CovenantSQL/adminer)

## Papers
Our team members published:

Expand Down Expand Up @@ -114,10 +125,8 @@ Watch us or [![follow on Twitter](https://img.shields.io/twitter/url/https/twitt

## Contact

- [Blog](https://medium.com/@covenant_labs)
- [YouTube](https://www.youtube.com/channel/UCe9P_TMiexSHW2GGV5qBmZw)
- [Mail](mailto:[email protected])
- [Forum](https://demo.covenantsql.io/forum/)
- <a href="https://twitter.com/intent/follow?screen_name=CovenantLabs">
<img src="https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40CovenantLabs"
alt="follow on Twitter"></a>

- [![Join the chat at https://gitter.im/CovenantSQL/CovenantSQL](https://badges.gitter.im/CovenantSQL/CovenantSQL.svg)](https://gitter.im/CovenantSQL/CovenantSQL?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
- <a href="https://twitter.com/intent/follow?screen_name=CovenantLabs"><img src="https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40CovenantLabs" alt="follow on Twitter"></a>
2 changes: 1 addition & 1 deletion alltest.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ main() {
# some benchmarks
go test -tags "${UNITTESTTAGS:-}" -bench=^BenchmarkPersistentCaller_Call$ -run ^$ ./rpc/
bash cleanupDB.sh || true
go test -tags "${UNITTESTTAGS:-}" -bench=^BenchmarkMinerTwo$ -benchtime=5s -run ^$ ./cmd/cql-minerd/
go test -tags "${UNITTESTTAGS:-}" -bench=^BenchmarkMiner$ -benchtime=5s -run ^$ ./cmd/cql-minerd/ -bench-miner-count=2
bash cleanupDB.sh || true
}

Expand Down
8 changes: 4 additions & 4 deletions bin/docker-entry.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/sh

echo nameserver 114.114.114.114 > /etc/resolv.conf
# echo nameserver 114.114.114.114 > /etc/resolv.conf

[ -s "${COVENANT_ALERT}" ] && [ -x "${COVENANT_ALERT}" ] && (eval "${COVENANT_ALERT}")

Expand All @@ -12,16 +12,16 @@ blockproducer)
exec /app/cqld -config "${COVENANT_CONF}" -metric-web "${METRIC_WEB_ADDR}" "${@}"
;;
observer)
exec /app/cql -config "${COVENANT_CONF}" -web "${COVENANTSQL_OBSERVER_ADDR}" "${@}"
exec /app/cql web -config "${COVENANT_CONF}" -no-password "${COVENANTSQL_OBSERVER_ADDR}" "${@}"
;;
adapter)
exec /app/cql -config "${COVENANT_CONF}" -adapter "${COVENANTSQL_ADAPTER_ADDR}" "${@}"
exec /app/cql adapter -config "${COVENANT_CONF}" -no-password "${COVENANTSQL_ADAPTER_ADDR}" "${@}"
;;
mysql-adapter)
exec /app/cql-mysql-adapter -config "${COVENANT_CONF}" "${@}"
;;
cli)
exec /app/cql -config ${COVENANT_CONF} "${@}"
exec /app/cql console -config ${COVENANT_CONF} -no-password "${@}"
;;
faucet)
exec /app/cql-faucet -config ${COVENANT_CONF} "${@}"
Expand Down
7 changes: 0 additions & 7 deletions blockproducer/metastate.go
Original file line number Diff line number Diff line change
Expand Up @@ -810,13 +810,6 @@ func (s *metaState) updatePermission(tx *types.UpdatePermission) (err error) {
}).WithError(ErrDatabaseNotFound).Error("unexpected error in updatePermission")
return ErrDatabaseNotFound
}
if !tx.Permission.IsValid() {
log.WithFields(log.Fields{
"permission": tx.Permission,
"dbID": tx.TargetSQLChain.DatabaseID(),
}).WithError(ErrInvalidPermission).Error("unexpected error in updatePermission")
return ErrInvalidPermission
}

// check whether sender has super privilege and find targetUser
numOfSuperUsers := 0
Expand Down
7 changes: 4 additions & 3 deletions blockproducer/metastate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1016,10 +1016,11 @@ func TestMetaState(t *testing.T) {
err = up.Sign(privKey1)
So(err, ShouldBeNil)
err = ms.apply(&up)
So(errors.Cause(err), ShouldEqual, ErrInvalidPermission)
So(err, ShouldBeNil)
// test permission update
// addr1(admin) update addr3 as admin
up.TargetUser = addr3
up.Nonce++
up.Permission = types.UserPermissionFromRole(types.Admin)
err = up.Sign(privKey1)
So(err, ShouldBeNil)
Expand Down Expand Up @@ -1052,7 +1053,7 @@ func TestMetaState(t *testing.T) {
err = ms.apply(&up)
So(errors.Cause(err), ShouldEqual, ErrNoSuperUserLeft)
// addr1(read) update addr3(admin) fail
up.Nonce = cd1.Nonce + 2
up.Nonce = cd1.Nonce + 3
err = up.Sign(privKey1)
So(err, ShouldBeNil)
err = ms.apply(&up)
Expand Down Expand Up @@ -1296,7 +1297,7 @@ func TestMetaState(t *testing.T) {
invalidIk3 := &types.IssueKeys{
IssueKeysHeader: types.IssueKeysHeader{
TargetSQLChain: dbAccount,
Nonce: 3,
Nonce: 4,
},
}
err = invalidIk3.Sign(privKey1)
Expand Down
4 changes: 2 additions & 2 deletions cleanupDB.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ cd ${PROJECT_DIR} && find . -name '*.db' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name '*.db-shm' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name '*.db-wal' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name 'db.meta' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name 'public.keystore' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name '*.public.keystore' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name 'public.keystore*' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -name '*.public.keystore*' -exec rm -vf {} \;
cd ${PROJECT_DIR} && find . -type d -name '*.ldb' -prune -exec rm -vrf {} \;
12 changes: 6 additions & 6 deletions client/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

```bash
$ go get github.com/CovenantSQL/CovenantSQL/client
$ go get github.com/CovenantSQL/CovenantSQL/cmd/cql-utils
$ go get github.com/CovenantSQL/CovenantSQL/cmd/cql
```

然后在你的 go 代码中 import 第一个 `client` 包。
Expand All @@ -18,14 +18,14 @@ $ go get github.com/CovenantSQL/CovenantSQL/cmd/cql-utils

### 生成默认的配置文件

运行以下 `cql-utils` 命令,输入 master key(类似密码)来生成本地密钥对。等待几十秒,会在 `conf` 文件夹中,生成一个私钥文件和一个名为 `config.yaml` 的配置文件。
运行以下 `cql` 命令,输入 master key(类似密码)来生成本地密钥对。等待几十秒,会在 `~/.cql` 文件夹中,生成一个私钥文件和一个名为 `config.yaml` 的配置文件。

```bash
$ cql-utils -tool confgen -root conf
$ cql generate config
Generating key pair...
Enter master key(press Enter for default: ""):
Private key file: conf/private.key
Private key file: ~/.cql/private.key
Public key's hex: 025abec9b0072615170f4acf4a2fa1162a13864bb66bc3f140b29f6bf50ceafc75
Generated key pair.
Generating nonce...
Expand All @@ -35,7 +35,7 @@ nonce: {{1450338416 0 0 0} 26 0000002dd8bdb50ba0270642e4c4bc593c1630ef7784653f31
node id: 0000002dd8bdb50ba0270642e4c4bc593c1630ef7784653f311b3c3d6374e514
Generated nonce.
Generating config file...
Generated nonce.
Generated config.
```

有了配置文件之后,可以通过以下 go 代码来初始化 CovenantSQL 客户端:
Expand Down Expand Up @@ -100,4 +100,4 @@ dsn, err = client.Create(meta)

### 完整示例

在以下目录中有一个简单示例和复杂示例可以参考 [示例](https://github.com/CovenantSQL/CovenantSQL/tree/develop/client/_example)
在以下目录中有一个简单示例和复杂示例可以参考 [示例](https://github.com/CovenantSQL/CovenantSQL/tree/develop/client/_example)
10 changes: 5 additions & 5 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Make sure that `$GOPATH/bin` is in your `$PATH`

```bash
$ go get github.com/CovenantSQL/CovenantSQL/client
$ go get github.com/CovenantSQL/CovenantSQL/cmd/cql-utils
$ go get github.com/CovenantSQL/CovenantSQL/cmd/cql
```

and import `client` package if you want to use it in your code.
Expand All @@ -18,14 +18,14 @@ You need to provide a config and a master key for initialization. The master key

### Generating Default Config File

Run `cql-utils` like below. Enter a master key (like a password) for generating local key pair. After that, it may take a few seconds with a private key file and config.yaml file generated in `conf` folder.
Run `cql` like below. Enter a master key (like a password) for generating local key pair. After that, it may take a few seconds with a private key file and config.yaml file generated in `~/.cql/` folder.

```bash
$ cql-utils -tool confgen -root conf
$ cql generate config
Generating key pair...
Enter master key(press Enter for default: ""):
Private key file: conf/private.key
Private key file: ~/.cql/private.key
Public key's hex: 025abec9b0072615170f4acf4a2fa1162a13864bb66bc3f140b29f6bf50ceafc75
Generated key pair.
Generating nonce...
Expand All @@ -35,7 +35,7 @@ nonce: {{1450338416 0 0 0} 26 0000002dd8bdb50ba0270642e4c4bc593c1630ef7784653f31
node id: 0000002dd8bdb50ba0270642e4c4bc593c1630ef7784653f311b3c3d6374e514
Generated nonce.
Generating config file...
Generated nonce.
Generated config.
```

After you prepare your master key and config file, CovenantSQL client can be initialized by:
Expand Down
Loading