Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds mainnet deployment script #265

Merged
merged 9 commits into from
Sep 10, 2024
Merged

Conversation

loothero
Copy link
Member

@loothero loothero commented Sep 10, 2024

Summary by CodeRabbit

  • New Features

    • Introduced an automated deployment script for launching the game on the StarkNet blockchain, streamlining the process.
    • Added flexible management for token claims related to various game entities, enhancing the game's economy.
  • Improvements

    • Enhanced security by sourcing environment variables from a specified file, ensuring sensitive information is managed properly.

@loothero loothero self-assigned this Sep 10, 2024
Copy link

vercel bot commented Sep 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
loot-survivor ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 10, 2024 2:10pm

Copy link

coderabbitai bot commented Sep 10, 2024

Warning

Rate limit exceeded

@loothero has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 38 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between fb1a5a8 and 98a6bab.

Walkthrough

The pull request introduces a new script, deploy_mainnet.sh, which automates the deployment of a game contract and its components on the StarkNet blockchain. It defines essential addresses and parameters for the deployment process, manages token claims for various entities, and securely sources environment variables. The script builds the game contract and deploys it alongside the renderer using the starkli tool, encapsulating the entire deployment workflow.

Changes

Files Change Summary
scripts/deploy_mainnet.sh Added a new script to automate the deployment of game contracts on StarkNet, including various addresses and claims per token.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant StarkNet

    User->>Script: Execute deploy_mainnet.sh
    Script->>Script: Define addresses and parameters
    Script->>Script: Source environment variables
    Script->>Script: Build game contract using scarb
    Script->>StarkNet: Deploy renderer and game contracts
    StarkNet-->>Script: Confirm deployment
    Script-->>User: Deployment complete
Loading

Poem

🐇 In the meadow, contracts bloom,
A script to chase away the gloom.
With tokens claimed and games to play,
On StarkNet's stage, we'll leap and sway!
Hops of joy, a launch so bright,
Let’s celebrate this wondrous night! 🌙✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)
scripts/deploy_mainnet.sh (1)

51-57: Update settings and correct comment syntax in scripts/deploy_mainnet.sh.

The TODO comment indicating that settings need to be updated before the full release is still present in the file. Please ensure these settings are finalized. Additionally, replace // with # for comments in bash scripts.

  • Location: scripts/deploy_mainnet.sh, lines 51-57
Analysis chain

Update the settings and use # for comments before the full release.

The comment block contains TODO and temporary settings for the launch tournament and free VRF promotion. Please ensure to update these settings with the final values before the full release.

Also, use # instead of // for comments in bash scripts.

Ensure that the settings are updated before the full release by running the following script:

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the settings are updated before the full release.

# Test: Search for the TODO comment. Expect: No occurrences.
rg --type sh $'// TODO: UPDATE THESE SETTINGS BEFORE FULL RELEASE'

Length of output: 144

Tools
Shellcheck

[error] 51-51: Was this intended as a comment? Use # in sh.

(SC1127)


[error] 52-52: Was this intended as a comment? Use # in sh.

(SC1127)


[error] 53-53: Was this intended as a comment? Use # in sh.

(SC1127)


[error] 55-55: Was this intended as a comment? Use # in sh.

(SC1127)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e9349c2 and fb1a5a8.

Files selected for processing (1)
  • scripts/deploy_mainnet.sh (1 hunks)
Additional context used
Gitleaks
scripts/deploy_mainnet.sh

11-12: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

Shellcheck
scripts/deploy_mainnet.sh

[error] 51-51: Was this intended as a comment? Use # in sh.

(SC1127)


[error] 52-52: Was this intended as a comment? Use # in sh.

(SC1127)


[error] 53-53: Was this intended as a comment? Use # in sh.

(SC1127)


[error] 55-55: Was this intended as a comment? Use # in sh.

(SC1127)


[warning] 60-60: ShellCheck can't follow non-constant source. Use a directive to specify location.

(SC1090)


[warning] 63-63: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)


[warning] 73-73: renderer_class_hash is referenced but not assigned.

(SC2154)


[warning] 76-76: game_contract appears unused. Verify use (or export if used externally).

(SC2034)


[warning] 76-76: launch_tournament_duration_seconds is referenced but not assigned.

(SC2154)


[warning] 76-76: game_start_delay is referenced but not assigned.

(SC2154)

Additional comments not posted (2)
scripts/deploy_mainnet.sh (2)

59-60: LGTM!

Sourcing environment variables from a file is a good practice for security and maintainability.

Tools
Shellcheck

[warning] 60-60: ShellCheck can't follow non-constant source. Use a directive to specify location.

(SC1090)


67-76: LGTM!

The deployment commands look good. The script correctly declares and deploys the renderer and game contracts using the starkli tool, capturing the necessary class hashes and addresses in variables.

Tools
Shellcheck

[warning] 73-73: renderer_class_hash is referenced but not assigned.

(SC2154)


[warning] 76-76: game_contract appears unused. Verify use (or export if used externally).

(SC2034)


[warning] 76-76: launch_tournament_duration_seconds is referenced but not assigned.

(SC2154)


[warning] 76-76: game_start_delay is referenced but not assigned.

(SC2154)

source $ENV_FILE

# build game contract
cd /workspaces/loot-survivor/contracts/
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handle the case where cd fails.

Please use cd ... || exit to handle the case where cd fails. This will ensure that the script exits if it cannot change to the correct directory, preventing unexpected behavior.

Apply this diff to fix the issue:

-cd /workspaces/loot-survivor/contracts/
+cd /workspaces/loot-survivor/contracts/ || exit 1
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
cd /workspaces/loot-survivor/contracts/
cd /workspaces/loot-survivor/contracts/ || exit 1
Tools
Shellcheck

[warning] 63-63: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.

(SC2164)

@loothero loothero merged commit ea02a9d into main Sep 10, 2024
9 checks passed
@loothero loothero deleted the add-mainnet-deployment-script branch September 10, 2024 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants