Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions docs/about/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/archive/_category_.json

This file was deleted.

37 changes: 0 additions & 37 deletions docs/archive/community/community.todo

This file was deleted.

39 changes: 0 additions & 39 deletions docs/archive/technology/carpe-desktop-app.todo

This file was deleted.

8 changes: 0 additions & 8 deletions docs/community-programs/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/core-devs/_category_.json

This file was deleted.

8 changes: 0 additions & 8 deletions docs/edit-docs/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/faq/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# FAQ
1 change: 1 addition & 0 deletions docs/getting-started/install-open-libra-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Install Open Libra CLI
3 changes: 3 additions & 0 deletions docs/getting-started/install-wallet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Install Wallet

If you need a GUI wallet to send, receive, check balance for you accounts, you can use the Carpe wallet.
1 change: 1 addition & 0 deletions docs/glossary/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Glossary
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# community
# Activation

Community Wallet is a qualification an account can receive if it is composed of certain properties. Those properties are:

Expand All @@ -23,7 +23,7 @@ There are three steps in creating a community wallet account:

This step is irreversible. The current mnemonic will no longer work going forward. The only governance possible is that of the multisig, and any features added (Donor Voice).

## Using TXS Tool
## Using `txs` tool

To exemplify the usage of the TXS Tool, we will consider Alice (0x1000a), Bob (0x1000b), and Carol (0x1000c) as the ones invited to be the multisig authorities on Dave's (0x1000d) account, which will become the community wallet.

Expand All @@ -33,7 +33,7 @@ Dave simply provides the list of addresses and the signature threshold. The tran

_Note: this step does not commit the accounts as the authorities, it proposes the authority offer to the address list._

```
```bash
libra txs community gov-init -a 0x1000a -a 0x1000b -a 0x1000c -n 2
```

Expand All @@ -43,15 +43,15 @@ Each address owner invited to be an authority in the community wallet must claim

_Note: this will not make the address a multisig authority yet. After enough addresses claim the offer, the invited authorities need to wait for the donor's final action._

```
```bash
libra txs community gov-claim -a 0x1000d
```

### Step #3:

After enough addresses claim the offer, Dave can finalize and cages the account by providing the threshold number.

```
```bash
libra txs community gov-cage -n 2
```

Expand All @@ -67,7 +67,7 @@ This step also performs the same authority verification as `gov-init`.

To update the authority offer, the owner can use the following command:

```
```bash
libra txs community gov-offer -a 0x1000b -a 0x1000c -a 0x1000d -a 0x1000e -n 3
```

Expand All @@ -81,15 +81,15 @@ Additionally, this command can be used by the account owner to renew the offer's

V8 introduces CW reauthorization via donor authorization vote transactions that can be generated as follows:

```
```bash
export CW_ADDR=<CW ADDRESS>
export CW_ADDR=0x2B0E8325DEA5BE93D856CFDE2D0CBA12 # Example wallet address
libra txs community reauthorize --community-wallet $CW_ADDR # Submit a vote for reauthorization
```

Current reauthorization status for a community wallet can be viewed like this:

```
```bash
libra query view -f 0x1::donor_voice_governance::get_reauth_tally -a $CW_ADDR
{
"body": [
Expand Down
1 change: 1 addition & 0 deletions docs/guides/community-wallet-ops/reauthorize-in-v8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Reauthorize a dormant CW in V8
2 changes: 2 additions & 0 deletions docs/guides/community-wallet-ops/rituals-and-standards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Standards that the CW must follow

1 change: 1 addition & 0 deletions docs/guides/community-wallet-ops/send-coins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Sending Coins
1 change: 1 addition & 0 deletions docs/guides/community-wallet-ops/setup-multisig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Setup Signers (Multisig)
1 change: 1 addition & 0 deletions docs/guides/contribute/contribute-to-openlibra-repos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contribute to Open Libra Repositories
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# sidebar_label: 'My Title'

# GOOD: if I want to propose an order to the menu
# sidebar_position: 5
# adjust the order in sidebars.js

# GOOD: shall we hide this page in the menu?
# hidden: true
Expand Down
1 change: 1 addition & 0 deletions docs/guides/contribute/pledge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Participants and Contributors Pledge
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Libra Move Dev Quick Start
# Quick Start

## Install

### You must install `libra` cli tool to your PATH.

```
```bash
# in this repo
cargo build --release -p libra

Expand All @@ -22,7 +22,7 @@ libra version
```

### Export some environment variables
```
```bash
# Add to your $HOME/.bashrc, or $HOME/.zshrc

##### Must export to see debug prints from Move VM
Expand All @@ -44,7 +44,7 @@ This is the file necessary for network genesis for mainnet and testnet.
NOTE: because it is the genesis file, the smoke tests (which simulate running networks) requires this file.


```
```bash
cd ./framework
libra move framework release
```
Expand All @@ -56,10 +56,10 @@ Your release will be in `./releases/head.mrb`, you will need this for genesis an
## Run tests

#### Framework unit tests
```

```bash
# run framework tests with:
# rememeber export DIEM_MOVE_DEBUG=true envvar for debug prints from Move VM
# remember export DIEM_MOVE_DEBUG=true envvar for debug prints from Move VM
cd ./framework/libra-framework
libra move test

Expand All @@ -70,7 +70,7 @@ libra move test

### Formal verification tests

```
```bash
# run formal verification with
libra move prove
```
Expand All @@ -82,7 +82,8 @@ Note for smoke tests: you must regenerate the .mrb file EVERYTIME YOU MAKE A CHA
See instructions on environment variables above. Remember to export DIEM_FORGE_NODE_BIN_PATH, otherwise nothing will happen. For some tests (upgrade, rescue) the RUST_MIN_STACK needs to be set higher than the default for rust. That's because some tests have higher memory requirements when having multiple recompiliations for the move source.

Note that the Move VM `[debug]` prints do not appear in the terminal, they will appear in the log files of the individual simulated nodes.
```

```bash
# run smoke tests (using cargo)
cd ./smoke-tests
cargo test
Expand All @@ -100,7 +101,7 @@ If you encounter the following error:

You can resolve this issue by building with the following flag:

```
```bash
RUSTFLAGS="--cfg tokio_unstable" cargo build --profile cli -p diem-node --target-dir ~/.cargo/bin
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ boogie system libraries.
1) get the libra cli with standard Move tools

Compile the `libra` cli app, and have it in your executable PATH.
```
```bash
cargo b --profile cli -p libra
cp target/cli/libra ~/.cargo/bin
chmod +x ~/.cargo/bin/libra
Expand All @@ -31,32 +31,30 @@ The `dev_setup.sh` can be run with these options:

> -p update $HOME/.profile or ./bashrc

```
```bash
# run the installer
bash util/dev_setup.sh -yp

# you may need to restart your shell, after env variables are set
# or .bashrc, or .zshrc

bash ~/.profile

```

Whatever terminal shell (or .zshrc) you are using you should check that these variable are exported:
```
```bash
export DOTNET_ROOT="$HOME/.dotnet"
export Z3_EXE="$HOME/bin/z3"
export CVC5_EXE="$HOME/bin/cvc5"
export BOOGIE_EXE="$HOME/.dotnet/tools/boogie"
export SOLC_EXE="$HOME/bin/solc"
```

3) check it all works
3) Check if it all works
you'll be running formal verification specs against `libra-framework` move
source.

So test it on something we know to work
```
```bash
cd framework/libra-framework

# test the guid.move module
Expand All @@ -65,7 +63,7 @@ libra move prove -f guid

If you get a response without errors similar to the message below you are ready to
start.
```
```bash
[INFO] 0.903s build, 2.585s trafo, 0.019s gen, 1.313s verify, total 4.820s
```

Expand All @@ -79,19 +77,19 @@ start.
Formal verification priority for Libra should mainly check that the network does
not halt in operations conducted by the VM.

1. epoch_boundary.move
Should never halt on reconfigure()
1. `epoch_boundary.move`
Should never halt on `reconfigure()`
THough there are many downstream modules and functions from here, the largest
ones being:

a. stake.move
a. `stake.move`

b. proof_of_fee.move
b. `proof_of_fee.move`

2. coin.move
2. `coin.move`
a. Transactions by VM should not halt

3. slow_wallet.move
3. `slow_wallet.move`
a. no transactions should bypass the slow wallet tracker. If there is a slow
wallet struct, a transaction should always alter it.
b. no account, not even the VM can withdraw above the unlocked limit.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ description: 'Developing on the 0L Network'
# Getting Started
---

## Community
The 0L project is radically open source in that every aspect of the project is open to community contributors. The software that operates the network is not managed by a foundation or by a governance token. Instead, the community manages the technical infrastructure by developing software and making pull requests. Where decisions are not reducible to software, open source-like workflows are used to define, complete and review diverse forms of labor.

## Tech Strategy
The tech strategy in line with overall community goals: optimize for being opinionated about economic policy, and having long-term optionality in picking infrastructure vendors.

Expand Down Expand Up @@ -81,4 +84,4 @@ When we must change an upstream dependency:

## Easy Rebases
- on our fork we consider our master branch `libra-framework`, which contains all of our changes. The changes should be linear so to be *rebased* without conflict.
- the fork keeps the `main` branch which can be synced, and the changes are rebased onto `libra-framework` branch.
- the fork keeps the `main` branch which can be synced, and the changes are rebased onto `libra-framework` branch.
Loading