Skip to content

Commit

Permalink
Remove some references to of the old repo in comments/docs (#133)
Browse files Browse the repository at this point in the history
  • Loading branch information
texuf authored Jun 12, 2024
1 parent 5ad9e83 commit 97b7354
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 28 deletions.
4 changes: 2 additions & 2 deletions core/node/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Current logger is saved into variable `log` and logging statement takes a messag
log.Debug("Starting new snapshot", "streamId", streamId, "blockNumber", curBlockNum)
```

There is wrapper called [dlog](https://github.com/HereNotThere/harmony/tree/main/core/node/dlog) which
There is wrapper called [dlog](./dlog) which
provides coloring and better formatting for types we user frequently (protos, binary arrays).

Normally logger is passed in [context](https://pkg.go.dev/context) and retrieved using `dlog.FromCtx`:
Expand Down Expand Up @@ -40,7 +40,7 @@ be to augment the returned error with extra information instead.
## Errors

For all errors generated in node use RiverError. If there is no matching error code add new code in
[protocol.proto](https://github.com/HereNotThere/harmony/blob/main/core/proto/protocol.proto).
[protocol.proto](../../protocol/protocol.proto).
Arguments are `errorCode`, `message`, optional key-value pairs:

```go
Expand Down
2 changes: 1 addition & 1 deletion core/node/protocol/protocol_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ func TestInceptionPayload(t *testing.T) {
}
// pro tip, if you cast nil to an interface type, it's still nil
assert.Nil(t, spaceMembership.GetInceptionPayload())
// but it's not equal to nil! this is a test to make sure we don't regress see: https://github.com/HereNotThere/harmony/pull/2808
// but it's not equal to nil!
assert.True(t, spaceMembership.GetInceptionPayload() == nil)
}
27 changes: 2 additions & 25 deletions core/xchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,10 @@ This XChain Node resides in a monorepo and interfaces with the `EntitlementCheck

## Installation and Deployment

1. **Clone the Monorepo:**
1. **Run Start Dev to configure and start servers:**

```bash
git clone https://github.com/HereNotThere/harmony.git
```

2. **Navigate to Monorepo:**
```bash
cd harmony
```
3. **Deploy Contracts:**
```bash
./scripts/deploy-entitlement-checker.sh
../../scripts/start_dev.sh
```

---
Expand Down Expand Up @@ -109,20 +100,6 @@ This XChain Node resides in a monorepo and interfaces with the `EntitlementCheck
./scripts/start_dev.sh
```

1. **Create Multi-Instance Configs:**

```bash
export RIVER_ENV="local_single"
./create_multi.sh
```

This will create five instance configurations in `./core/xchain/instance_1-5` using the template in `./core/node/config-template.yaml`.

1. **Launch Multiple Instances:**
```bash
./launch-multi.sh
```

---

## API Specification for talking to the EntitlementChecker contract
Expand Down

0 comments on commit 97b7354

Please sign in to comment.