Skip to content

Commit 67de44f

Browse files
Rebrand (#709)
* replace starknet-devnet-rs with starknet-devnet * format * toml rebrand * changes
1 parent fb5b581 commit 67de44f

File tree

31 files changed

+77
-77
lines changed

31 files changed

+77
-77
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To read about PR expectations, check out the [Pull requests](#pull-requests) sec
1010
1111
### Should you create a PR?
1212

13-
It is advised to [create an issue](https://github.com/0xSpaceShard/starknet-devnet-rs/issues/new/choose) before creating a PR. Creating an issue is the best way to reach somebody with repository-specific experience who can provide more info on how a problem/idea can be addressed and if a PR is needed.
13+
It is advised to [create an issue](https://github.com/0xSpaceShard/starknet-devnet/issues/new/choose) before creating a PR. Creating an issue is the best way to reach somebody with repository-specific experience who can provide more info on how a problem/idea can be addressed and if a PR is needed.
1414

1515
### Checklist
1616

@@ -23,7 +23,7 @@ Once a PR is created, somebody from the team will review it. When a reviewer lea
2323
- a request for clarification from the reviewer
2424
- a link to the commit which addresses the reviewer's observation (simply pasting the sha-digest is enough)
2525

26-
This is an example of a good author-reviewer correspondence: [link](https://github.com/0xSpaceShard/starknet-devnet-rs/pull/310#discussion_r1457142002).
26+
This is an example of a good author-reviewer correspondence: [link](https://github.com/0xSpaceShard/starknet-devnet/pull/310#discussion_r1457142002).
2727

2828
#### Note to reviewers
2929

@@ -35,7 +35,7 @@ $ git remote add <CONTRIBUTOR> <CONTRIBUTOR_GIT_FORK_URL>
3535
$ git fetch <CONTRIBUTOR>
3636
$ git checkout -b <CONTRIBUTOR>/<BRANCH> <CONTRIBUTOR>/<BRANCH>
3737
38-
$ git remote set-url --push <CONTRIBUTOR> [email protected]:0xSpaceShard/starknet-devnet-rs.git
38+
$ git remote set-url --push <CONTRIBUTOR> [email protected]:0xSpaceShard/starknet-devnet.git
3939
$ git push <CONTRIBUTOR> HEAD
4040
```
4141

.github/pull_request_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@
1919
- [ ] Rebased to the latest commit of the target branch (or merged it into my branch)
2020
- Once you make the PR reviewable, please avoid force-pushing
2121
- [ ] Updated the docs if needed - `./website/README.md`
22-
- [ ] Linked the [issues](https://github.com/0xSpaceShard/starknet-devnet-rs/issues) resolvable by this PR - [linking info](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
23-
- [ ] Updated the tests if needed; all passing - [execution info](https://github.com/0xSpaceShard/starknet-devnet-rs/blob/main/.github/CONTRIBUTING.md#test-execution)
22+
- [ ] Linked the [issues](https://github.com/0xSpaceShard/starknet-devnet/issues) resolvable by this PR - [linking info](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
23+
- [ ] Updated the tests if needed; all passing - [execution info](https://github.com/0xSpaceShard/starknet-devnet/blob/main/.github/CONTRIBUTING.md#test-execution)

Cargo.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ panic = "unwind"
1414
[workspace.package]
1515
authors = ["Mario"]
1616
edition = "2021"
17-
repository = "https://github.com/0xSpaceShard/starknet-devnet-rs"
17+
repository = "https://github.com/0xSpaceShard/starknet-devnet"
1818
license-file = "LICENSE"
19-
homepage = "https://0xspaceshard.github.io/starknet-devnet-rs"
19+
homepage = "https://0xspaceshard.github.io/starknet-devnet"
2020
description = "A local testnet for Starknet"
2121
readme = "README.md"
22-
documentation = "https://0xspaceshard.github.io/starknet-devnet-rs/docs/intro"
22+
documentation = "https://0xspaceshard.github.io/starknet-devnet/docs/intro"
2323

2424
exclude = [".github/**", ".devcontainer/**", ".circleci/**"]
2525

@@ -129,5 +129,5 @@ listeners = "0.2.1"
129129
parity-scale-codec = "=3.6.12"
130130
parity-scale-codec-derive = "=3.6.12"
131131

132-
# https://app.circleci.com/pipelines/github/0xSpaceShard/starknet-devnet-rs/3033/workflows/3f93463c-7550-432b-8868-9bb0bf96dc10/jobs/5012
132+
# https://app.circleci.com/pipelines/github/0xSpaceShard/starknet-devnet/3033/workflows/3f93463c-7550-432b-8868-9bb0bf96dc10/jobs/5012
133133
cargo-platform = "=0.1.8"

crates/starknet-devnet/src/cli.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ use crate::{REQUEST_LOG_ENV_VAR, RESPONSE_LOG_ENV_VAR};
2929
author,
3030
version,
3131
about = "A local testnet for Starknet... in Rust!",
32-
long_about = "Documentation: https://0xspaceshard.github.io/starknet-devnet-rs",
32+
long_about = "Documentation: https://0xspaceshard.github.io/starknet-devnet",
3333
propagate_version = true
3434
)]
3535
pub(crate) struct Args {
@@ -216,8 +216,8 @@ Sending POST /create_block is also an option in modes other than \"demand\".")]
216216
#[arg(env = "RESTRICTIVE_MODE")]
217217
#[arg(num_args = 0..)]
218218
#[arg(help = "Use Devnet in restrictive mode; You can specify the methods that will be \
219-
forbidden with whitespace-separated values (https://0xspaceshard.github.io/starknet-devnet-rs/docs/restrictive#with-a-list-of-methods). If nothing is specified for this \
220-
argument, then default restricted methods are used (https://0xspaceshard.github.io/starknet-devnet-rs/docs/restrictive#default-restricted-methods).")]
219+
forbidden with whitespace-separated values (https://0xspaceshard.github.io/starknet-devnet/docs/restrictive#with-a-list-of-methods). If nothing is specified for this \
220+
argument, then default restricted methods are used (https://0xspaceshard.github.io/starknet-devnet/docs/restrictive#default-restricted-methods).")]
221221
restricted_methods: Option<Vec<String>>,
222222
}
223223

website/docs/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Both Starknet's and Devnet's JSON-RPC API are reachable at `/rpc` and `/`. E.g.
1010

1111
### Starknet API
1212

13-
Unlike Pythonic Devnet, which also supported Starknet's gateway and feeder gateway API, Devnet in Rust supports [Starknet's JSON-RPC API](https://github.com/starkware-libs/starknet-specs/tree/master/api). Since JSON-RPC v0.6.0, to find out which JSON-RPC version is supported by which Devnet version, check out the [releases page](https://github.com/0xspaceshard/starknet-devnet-rs/releases).
13+
Unlike Pythonic Devnet, which also supported Starknet's gateway and feeder gateway API, Devnet in Rust supports [Starknet's JSON-RPC API](https://github.com/starkware-libs/starknet-specs/tree/master/api). Since JSON-RPC v0.6.0, to find out which JSON-RPC version is supported by which Devnet version, check out the [releases page](https://github.com/0xspaceshard/starknet-devnet/releases).
1414

1515
### Devnet API
1616

17-
Devnet has many additional features which are available via their own endpoints and JSON-RPC. The RPC methods are documented throughout the documentation in their corresponding pages, but are also aggregated [here](https://github.com/0xSpaceShard/starknet-devnet-rs/blob/main/website/static/devnet_api.json).
17+
Devnet has many additional features which are available via their own endpoints and JSON-RPC. The RPC methods are documented throughout the documentation in their corresponding pages, but are also aggregated [here](https://github.com/0xSpaceShard/starknet-devnet/blob/main/website/static/devnet_api.json).
1818

1919
:::warning Deprecation notice
2020

website/docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ You may now proceed with [running Devnet](./running/install) and checking out th
2323

2424
# Limits
2525

26-
As mentioned [here](https://docs.starknet.io/tools/limits-and-triggers/), "Starknet currently has a number of limits in place in order to keep the network stable and optimized for the best performance." Devnet uses the limits defined on that page and, for block-level limits, values defined [here (provided by the Blockifier team)](https://github.com/0xSpaceShard/starknet-devnet-rs/blob/main/crates/starknet-devnet-core/src/utils.rs). The block-level limits are considered only when executing transactions, not when constructing the blocks themselves. I.e. if a transaction's usage of a resource exceeds its defined block-level limit, it will be reverted; but if the cumulative usage of all transactions in a block of one resource exceeds the block limit, the block will still be generated.
26+
As mentioned [here](https://docs.starknet.io/tools/limits-and-triggers/), "Starknet currently has a number of limits in place in order to keep the network stable and optimized for the best performance." Devnet uses the limits defined on that page and, for block-level limits, values defined [here (provided by the Blockifier team)](https://github.com/0xSpaceShard/starknet-devnet/blob/main/crates/starknet-devnet-core/src/utils.rs). The block-level limits are considered only when executing transactions, not when constructing the blocks themselves. I.e. if a transaction's usage of a resource exceeds its defined block-level limit, it will be reverted; but if the cumulative usage of all transactions in a block of one resource exceeds the block limit, the block will still be generated.

website/docs/running/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ $ cargo install starknet-devnet
3030
- Preferably familiarize yourself with the `cargo install` command ([docs](https://doc.rust-lang.org/cargo/commands/cargo-install.html#dealing-with-the-lockfile)).
3131

3232
```
33-
$ cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked
33+
$ cargo install --git https://github.com/0xSpaceShard/starknet-devnet.git --locked
3434
```
3535

3636
### Install with `asdf`
@@ -71,16 +71,16 @@ $ starknet-devnet
7171

7272
## Fetch a pre-compiled binary executable
7373

74-
If you want to save time and skip project compilation on installation, since Devnet v0.0.5, the Assets section of each [GitHub release](https://github.com/0xSpaceShard/starknet-devnet-rs/releases) contains a set of platform-specific pre-compiled binary executables. Extract and run with:
74+
If you want to save time and skip project compilation on installation, since Devnet v0.0.5, the Assets section of each [GitHub release](https://github.com/0xSpaceShard/starknet-devnet/releases) contains a set of platform-specific pre-compiled binary executables. Extract and run with:
7575

7676
```
77-
$ curl -sSfL https://github.com/0xSpaceShard/starknet-devnet-rs/releases/download/<VERSION>/<COMPRESSED_ARCHIVE> | tar -xvz -C <TARGET_DIR>
77+
$ curl -sSfL https://github.com/0xSpaceShard/starknet-devnet/releases/download/<VERSION>/<COMPRESSED_ARCHIVE> | tar -xvz -C <TARGET_DIR>
7878
$ <TARGET_DIR>/starknet-devnet
7979
```
8080

8181
## Run from source
8282

83-
To install the project from source, after [git-cloning](https://github.com/git-guides/git-clone) the [Devnet repository](https://github.com/0xSpaceShard/starknet-devnet-rs), running the following command will install, build and start Devnet:
83+
To install the project from source, after [git-cloning](https://github.com/git-guides/git-clone) the [Devnet repository](https://github.com/0xSpaceShard/starknet-devnet), running the following command will install, build and start Devnet:
8484

8585
```
8686
$ cargo run

website/docusaurus.config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { themes as prismThemes } from 'prism-react-renderer';
22
import type { Config } from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

5-
const GITHUB_REPO_URL = 'https://github.com/0xSpaceShard/starknet-devnet-rs';
5+
const GITHUB_REPO_URL = 'https://github.com/0xSpaceShard/starknet-devnet';
66

77
const config: Config = {
88
title: 'Starknet Devnet',
@@ -13,13 +13,13 @@ const config: Config = {
1313
url: 'https://0xspaceshard.github.io',
1414
// Set the /<baseUrl>/ pathname under which your site is served
1515
// For GitHub pages deployment, it is often '/<projectName>/'
16-
baseUrl: '/starknet-devnet-rs/',
16+
baseUrl: '/starknet-devnet/',
1717
trailingSlash: false,
1818

1919
// GitHub pages deployment config.
2020
// If you aren't using GitHub pages, you don't need these.
2121
organizationName: '0xSpaceShard', // Usually your GitHub org/user name.
22-
projectName: 'starknet-devnet-rs', // Usually your repo name.
22+
projectName: 'starknet-devnet', // Usually your repo name.
2323
deploymentBranch: 'gh-pages',
2424

2525
onBrokenLinks: 'throw',

website/versioned_docs/version-0.0.6/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Starknet API
44

5-
Unlike Pythonic Devnet, which also supported Starknet's gateway and feeder gateway API, Devnet in Rust supports Starknet's JSON-RPC API. Since JSON-RPC v0.6.0, to find out which JSON-RPC version is supported by which Devnet version, check out the [releases page](https://github.com/0xspaceshard/starknet-devnet-rs/releases).
5+
Unlike Pythonic Devnet, which also supported Starknet's gateway and feeder gateway API, Devnet in Rust supports Starknet's JSON-RPC API. Since JSON-RPC v0.6.0, to find out which JSON-RPC version is supported by which Devnet version, check out the [releases page](https://github.com/0xSpaceShard/starknet-devnet/releases).
66

77
The JSON-RPC API is reachable via `/rpc` and `/` (e.g. if spawning Devnet with default settings, these URLs are functionally equivalent: `http://127.0.0.1:5050/rpc` and `http://127.0.0.1:5050/`)
88

website/versioned_docs/version-0.0.6/running/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ $ cargo install starknet-devnet
3030
- Preferably familiarize yourself with the `cargo install` command ([docs](https://doc.rust-lang.org/cargo/commands/cargo-install.html#dealing-with-the-lockfile)).
3131

3232
```
33-
$ cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked
33+
$ cargo install --git https://github.com/0xSpaceShard/starknet-devnet.git --locked
3434
```
3535

3636
### Run the installed executable
@@ -43,16 +43,16 @@ $ starknet-devnet
4343

4444
## Fetch a pre-compiled binary executable
4545

46-
If you want to save time and skip project compilation on installation, since Devnet v0.0.5, the Assets section of each [GitHub release](https://github.com/0xSpaceShard/starknet-devnet-rs/releases) contains a set of platform-specific pre-compiled binary executables. Extract and run with:
46+
If you want to save time and skip project compilation on installation, since Devnet v0.0.5, the Assets section of each [GitHub release](https://github.com/0xSpaceShard/starknet-devnet/releases) contains a set of platform-specific pre-compiled binary executables. Extract and run with:
4747

4848
```
49-
$ curl https://github.com/0xSpaceShard/starknet-devnet-rs/releases/download/<VERSION>/<COMPRESSED_ARCHIVE> | tar -xvzf -C <TARGET_DIR>
49+
$ curl https://github.com/0xSpaceShard/starknet-devnet/releases/download/<VERSION>/<COMPRESSED_ARCHIVE> | tar -xvzf -C <TARGET_DIR>
5050
$ <TARGET_DIR>/starknet-devnet
5151
```
5252

5353
## Run from source
5454

55-
To install the project from source, after [git-cloning](https://github.com/git-guides/git-clone) the [Devnet repository](https://github.com/0xSpaceShard/starknet-devnet-rs), running the following command will install, build and start Devnet:
55+
To install the project from source, after [git-cloning](https://github.com/git-guides/git-clone) the [Devnet repository](https://github.com/0xSpaceShard/starknet-devnet), running the following command will install, build and start Devnet:
5656

5757
```
5858
$ cargo run

0 commit comments

Comments
 (0)