Add smart gate contract to allow only tribe members to jump
This commit is contained in:
commit
65582d2c11
11 changed files with 4096 additions and 0 deletions
18
.env.example
Normal file
18
.env.example
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# This .env file is for demonstration purposes only.
|
||||||
|
#
|
||||||
|
# This should usually be excluded via .gitignore and the env vars attached to
|
||||||
|
# your deployment environment, but we're including this here for ease of local
|
||||||
|
# development. Please do not commit changes to this file!
|
||||||
|
#
|
||||||
|
# Enable debug logs for MUD CLI
|
||||||
|
DEBUG=mud:*
|
||||||
|
|
||||||
|
# EVE Frontier world address. This is a value published by CCP.
|
||||||
|
WORLD_ADDRESS=0xcDb380e0Cd3949cAF70C45c67079f2e27A77fC47
|
||||||
|
|
||||||
|
# Your namespace to deploy the system. Set your own value here.
|
||||||
|
MUD_NAMESPACE=test
|
||||||
|
|
||||||
|
# You can convert 12-word into private key with command like
|
||||||
|
# cast wallet private-key --mnemonic-interactive
|
||||||
|
PRIVATE_KEY=0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
|
||||||
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
/.env
|
||||||
|
/out/
|
||||||
|
/cache/
|
||||||
|
/node_modules/
|
||||||
|
/broadcast/
|
||||||
|
/deploys/
|
||||||
|
/worlds.json
|
||||||
|
/.mud/
|
||||||
|
/src/codegen
|
||||||
176
LICENSE
Normal file
176
LICENSE
Normal file
|
|
@ -0,0 +1,176 @@
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
19
README.md
Normal file
19
README.md
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# Smart Gate configuration for EVE Frontier
|
||||||
|
|
||||||
|
This repository contains a smart contract for EVE Frontier.
|
||||||
|
It allows only the owner's tribe members to use the gate.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
You need to have an account in EVE Frontier to use these tools.
|
||||||
|
|
||||||
|
Install `pnpm` and `foundry`. Look at [EVE Frontier documentation](https://docs.evefrontier.com/Tools) for more details.
|
||||||
|
|
||||||
|
Run `pnpm install` to install dependencies.
|
||||||
|
|
||||||
|
Copy the `.env.example` file to `.env` and change the MUD_NAMESPACE and PRIVATE_KEY fields.
|
||||||
|
|
||||||
|
Run `pnpm run deploy` to deploy the contract.
|
||||||
|
You may check on the [EVE Datacore] that your namespace was created successfully and contains the `TribeGateSystem` in the systems list.
|
||||||
|
|
||||||
|
Open Smart Gate in the game, copy the ID, and run `pnpm run configure <ID>`.
|
||||||
6
foundry.toml
Normal file
6
foundry.toml
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
[profile.default]
|
||||||
|
eth_rpc_url = "https://pyrope-external-sync-node-rpc.live.tech.evefrontier.com"
|
||||||
|
chain_id = 695569
|
||||||
|
|
||||||
|
script_execution_protection = false
|
||||||
|
extra_output_files = ["abi", "evm.bytecode"]
|
||||||
9
mud.config.ts
Normal file
9
mud.config.ts
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
import { defineWorld } from "@latticexyz/world";
|
||||||
|
|
||||||
|
if (!process.env.MUD_NAMESPACE) {
|
||||||
|
throw new Error("MUD_NAMESPACE environment variable must be set");
|
||||||
|
}
|
||||||
|
|
||||||
|
export default defineWorld({
|
||||||
|
namespace: process.env.MUD_NAMESPACE,
|
||||||
|
});
|
||||||
22
package.json
Normal file
22
package.json
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
{
|
||||||
|
"name": "tribe-gate",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"private": true,
|
||||||
|
"license": "Apache-2.0",
|
||||||
|
"scripts": {
|
||||||
|
"deploy": ". ./.env && mud deploy --worldAddress ${WORLD_ADDRESS:-$1}",
|
||||||
|
"configure": ". ./.env && forge script ./scripts/ConfigureGate.s.sol:ConfigureSmartGate --sig \"run(uint256)\" -vvv --broadcast --fork-url https://pyrope-external-sync-node-rpc.live.tech.evefrontier.com --private-key \"$PRIVATE_KEY\""
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@eveworld/smart-object-framework-v2": "0.1.2",
|
||||||
|
"@eveworld/world-v2": "0.1.2",
|
||||||
|
"@latticexyz/store": "2.2.22-7367a813d9b394415ba70678c4295cc90562c304",
|
||||||
|
"@latticexyz/schema-type": "2.2.22-7367a813d9b394415ba70678c4295cc90562c304",
|
||||||
|
"@latticexyz/world": "2.2.22-7367a813d9b394415ba70678c4295cc90562c304"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^20.14.8",
|
||||||
|
"forge-std": "https://github.com/foundry-rs/forge-std.git#77041d2ce690e692d6e03cc812b57d1ddaa4d505",
|
||||||
|
"@latticexyz/cli": "2.2.22-7367a813d9b394415ba70678c4295cc90562c304"
|
||||||
|
}
|
||||||
|
}
|
||||||
3783
pnpm-lock.yaml
generated
Normal file
3783
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load diff
3
remappings.txt
Normal file
3
remappings.txt
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
@eveworld/=node_modules/@eveworld/
|
||||||
|
@latticexyz/=node_modules/@latticexyz/
|
||||||
|
forge-std/=node_modules/forge-std/
|
||||||
27
scripts/ConfigureGate.s.sol
Normal file
27
scripts/ConfigureGate.s.sol
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
pragma solidity ^0.8.24;
|
||||||
|
|
||||||
|
import {console} from "forge-std/src/console.sol";
|
||||||
|
import {Script} from "forge-std/src/Script.sol";
|
||||||
|
import {StoreSwitch} from "@latticexyz/store/src/StoreSwitch.sol";
|
||||||
|
import {ResourceId} from "@latticexyz/store/src/ResourceId.sol";
|
||||||
|
import {WorldResourceIdLib} from "@latticexyz/world/src/WorldResourceId.sol";
|
||||||
|
import {RESOURCE_SYSTEM} from "@latticexyz/world/src/worldResourceTypes.sol";
|
||||||
|
import {SmartGateSystem, smartGateSystem} from "@eveworld/world-v2/src/namespaces/evefrontier/codegen/systems/SmartGateSystemLib.sol";
|
||||||
|
|
||||||
|
contract ConfigureSmartGate is Script {
|
||||||
|
function run(uint256 smartGateId) public {
|
||||||
|
address worldAddress = vm.envAddress("WORLD_ADDRESS");
|
||||||
|
string memory namespace = vm.envString("MUD_NAMESPACE");
|
||||||
|
|
||||||
|
StoreSwitch.setStoreAddress(worldAddress);
|
||||||
|
ResourceId systemId = WorldResourceIdLib.encode({
|
||||||
|
typeId: RESOURCE_SYSTEM,
|
||||||
|
namespace: bytes14(bytes(namespace)),
|
||||||
|
name: "TribeGateSystem"
|
||||||
|
});
|
||||||
|
console.logBytes32(systemId.unwrap());
|
||||||
|
vm.startBroadcast();
|
||||||
|
smartGateSystem.configureGate(smartGateId, systemId);
|
||||||
|
vm.stopBroadcast();
|
||||||
|
}
|
||||||
|
}
|
||||||
24
src/TribeGateSystem.sol
Normal file
24
src/TribeGateSystem.sol
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
pragma solidity ^0.8.24;
|
||||||
|
|
||||||
|
import {System} from "@latticexyz/world/src/System.sol";
|
||||||
|
import {Characters} from "@eveworld/world-v2/src/namespaces/evefrontier/codegen/tables/Characters.sol";
|
||||||
|
import {CharactersByAccount} from "@eveworld/world-v2/src/namespaces/evefrontier/codegen/tables/CharactersByAccount.sol";
|
||||||
|
import {ownershipSystem} from "@eveworld/world-v2/src/namespaces/evefrontier/codegen/systems/OwnershipSystemLib.sol";
|
||||||
|
|
||||||
|
contract TribeGateSystem is System {
|
||||||
|
function canJump(
|
||||||
|
uint256 characterId,
|
||||||
|
uint256 sourceGateId,
|
||||||
|
uint256 // destinationGateId
|
||||||
|
) public view returns (bool) {
|
||||||
|
address owner = ownershipSystem.owner(sourceGateId);
|
||||||
|
uint256 ownerCharacterId = CharactersByAccount.getSmartObjectId(owner);
|
||||||
|
uint256 ownerTribe = Characters.getTribeId(ownerCharacterId);
|
||||||
|
uint256 characterTribe = Characters.getTribeId(characterId);
|
||||||
|
if (ownerTribe == characterTribe) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue