Skip to content

Commit

Permalink
chore: delete solecs package (#1340)
Browse files Browse the repository at this point in the history
  • Loading branch information
holic authored Aug 22, 2023
1 parent e3de1a3 commit ce7125a
Show file tree
Hide file tree
Showing 66 changed files with 19 additions and 3,677 deletions.
8 changes: 8 additions & 0 deletions .changeset/chilled-chicken-repair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@latticexyz/cli": patch
"@latticexyz/recs": patch
"@latticexyz/solecs": major
"@latticexyz/std-client": patch
---

Removes `solecs` package. These were v1 contracts, now entirely replaced by our v2 tooling. See the [MUD docs](https://mud.dev/) for building with v2 or create a new project from our v2 templates with `pnpm create mud@next your-app-name`.
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,13 @@ More more information on how to get started, have a look at the [MUD documentati

MUD consists of several libraries. They can be used independently, but are best used together.

| Package | Version |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **[@latticexyz/solecs](/packages/solecs)** <br />Solidity Entity Component System library | [![npm version](https://img.shields.io/npm/v/@latticexyz/solecs.svg)](https://www.npmjs.org/package/@latticexyz/solecs) |
| **[@latticexyz/network](/packages/network)** <br />TypeScript networking library for automatic contract/client state sync | [![npm version](https://img.shields.io/npm/v/@latticexyz/network.svg)](https://www.npmjs.org/package/@latticexyz/network) |
| **[@latticexyz/recs](/packages/recs)** <br />TypeScript Reactive Entity Component System library | [![npm version](https://img.shields.io/npm/v/@latticexyz/recs.svg)](https://www.npmjs.org/package/@latticexyz/recs) |
| **[@latticexyz/services](/packages/services)** <br />Go services for indexer, faucet, message relay | [![npm version](https://img.shields.io/npm/v/@latticexyz/services.svg)](https://www.npmjs.org/package/@latticexyz/services) |
| **[@latticexyz/cli](/packages/cli)** <br />Command line interface for types, testing, faucet, deployment and more | [![npm version](https://img.shields.io/npm/v/@latticexyz/cli.svg)](https://www.npmjs.org/package/@latticexyz/cli) |
| **[@latticexyz/std-contracts](/packages/std-contracts)** <br />Solidity standard library | [![npm version](https://img.shields.io/npm/v/@latticexyz/std-contracts.svg)](https://www.npmjs.org/package/@latticexyz/std-contracts) |
| **[@latticexyz/std-client](/packages/std-client)** <br />Typescript standard library | [![npm version](https://img.shields.io/npm/v/@latticexyz/std-client.svg)](https://www.npmjs.org/package/@latticexyz/std-client) |
| **[@latticexyz/noise](/packages/noise)** <br />Solidity and AssemblyScript implementations of Perlin noise | [![npm version](https://img.shields.io/npm/v/@latticexyz/noise.svg)](https://www.npmjs.org/package/@latticexyz/noise) |
| Package | Version |
| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| **[@latticexyz/recs](/packages/recs)** <br />TypeScript Reactive Entity Component System library | [![npm version](https://img.shields.io/npm/v/@latticexyz/recs.svg)](https://www.npmjs.org/package/@latticexyz/recs) |
| **[@latticexyz/services](/packages/services)** <br />Go services for indexer, faucet, message relay | [![npm version](https://img.shields.io/npm/v/@latticexyz/services.svg)](https://www.npmjs.org/package/@latticexyz/services) |
| **[@latticexyz/cli](/packages/cli)** <br />Command line interface for types, testing, faucet, deployment and more | [![npm version](https://img.shields.io/npm/v/@latticexyz/cli.svg)](https://www.npmjs.org/package/@latticexyz/cli) |
| **[@latticexyz/std-client](/packages/std-client)** <br />Typescript standard library | [![npm version](https://img.shields.io/npm/v/@latticexyz/std-client.svg)](https://www.npmjs.org/package/@latticexyz/std-client) |
| **[@latticexyz/noise](/packages/noise)** <br />Solidity and AssemblyScript implementations of Perlin noise | [![npm version](https://img.shields.io/npm/v/@latticexyz/noise.svg)](https://www.npmjs.org/package/@latticexyz/noise) |

## Contribute

Expand Down
1 change: 0 additions & 1 deletion examples/minimal/packages/contracts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"@latticexyz/cli": "link:../../../../packages/cli",
"@latticexyz/config": "link:../../../../packages/config",
"@latticexyz/schema-type": "link:../../../../packages/schema-type",
"@latticexyz/solecs": "link:../../../../packages/solecs",
"@latticexyz/store": "link:../../../../packages/store",
"@latticexyz/world": "link:../../../../packages/world",
"@solidstate/contracts": "^0.0.52",
Expand Down
3 changes: 0 additions & 3 deletions examples/minimal/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
"@latticexyz/protocol-parser": "workspace:*",
"@latticexyz/schema-type": "workspace:*",
"@latticexyz/services": "workspace:*",
"@latticexyz/solecs": "workspace:*",
"@latticexyz/store": "workspace:*",
"@latticexyz/utils": "workspace:*",
"@latticexyz/world": "workspace:*",
Expand Down
2 changes: 1 addition & 1 deletion packages/recs/src/Component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ function getComponentName(component: Component<any, any, any>) {
* @param schema {@link Schema} of component values. Uses Type enum as bridge between typescript types and javascript accessible values.
* @param options Optional: {
* id: descriptive id for this component (otherwise an autogenerated id is used),
* metadata: arbitrary metadata (eg. contractId for solecs mapped components),
* metadata: arbitrary metadata,
* indexed: if this flag is set, an indexer is applied to this component (see {@link createIndexer})
* }
* @returns Component object linked to the provided World
Expand Down
2 changes: 1 addition & 1 deletion packages/recs/src/Entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Component, ComponentValue, Entity, EntitySymbol, World } from "./types"
* @param components Array of [{@link defineComponent Component}, {@link ComponentValue}] tuples to be added to this entity.
* (Use {@link withValue} to generate these tuples with type safety.)
* @param options Optional: {
* id: {@link Entity} for this entity. Use this for entities that were created outside of recs, eg. in the corresponding solecs contracts.
* id: {@link Entity} for this entity. Use this for entities that were created outside of recs.
* idSuffix: string to be appended to the auto-generated id. Use this for improved readability. Do not use this if the `id` option is provided.
* }
* @returns index of this entity in the {@link World}. This {@link Entity} is used to refer to this entity in other recs methods (eg {@link setComponent}).
Expand Down
1 change: 0 additions & 1 deletion packages/recs/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export type Schema = {

/**
* Used to add arbitrary metadata to components.
* (Eg `contractId` for components that have a corresponding solecs component contract.)
*/
export type Metadata =
| {
Expand Down
10 changes: 0 additions & 10 deletions packages/solecs/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions packages/solecs/.npmignore

This file was deleted.

8 changes: 0 additions & 8 deletions packages/solecs/.solhint.json

This file was deleted.

Loading

0 comments on commit ce7125a

Please sign in to comment.