@dcl/protocol 1.0.0-4982121558.commit-4b98e1a → 1.0.0-4982615619.commit-96dba07

package/README.md

@@ -20,21 +20,39 @@ protoc \
 ```
 
 # Style Guidelines
+
 1. All .proto files are snake_case.proto.
 2. For pascal or camel case usage, please make a deterministic one from the snake case. Example: nft_shape will transform to NftShape.
 3. See https://docs.buf.build/best-practices/style-guide. The most of other styles are taken from there, the Buf configuration is in proto/buf.yml.
 4. Use public/ folder only for .proto with protocol exposing, that is only for files with `import public`. This folder is not processed by the linter.
 
 # Dev with Decentraland Repositories
+
 Many repositories depend on this protocol definition and that sometimes implies some merge order. We don't have to worry much about compatibility because the checks are running with each PR, if you break something, the CI will warn you. But, in some cases, it's desirable to merge the implementation in a specific order to avoid unexpected behavior in the corner cases (multiple repositories are waiting for the build at the same time).
 
+> **Important Note: Avoid Merging Protocol PR Without Completed Unity Implementation**
+>
+> Please don't merge a protocol PR into the main branch unless the corresponding implementation in Unity has been completed. This is important to avoid any potential issues or build failures in Unity.
+>
+> The ideal order for introducing breaking changes in the protocol is as follows:
+>
+> 1. Create a PR in the Protocol repository.
+> 2. Use the npm test link from the CI of the protocol PR in the protocol-dependent application for development.
+> 3. Once both the protocol PR and the protocol-dependent application (e.g. unity-renderer) PR are ready for merging, synchronize their merging as follows:
+>    1. Merge the protocol PR.
+>    2. Modify protocol-dependent application PR to use the `@dcl/protocol@next` package to stop using the PR npm test link.
+>    3. Merge the protocol-dependent application PR.
+
 Some dev-cases are described here:
-## SDK: New component or component modification 
+
+## SDK: New component or component modification
+
 Repositories: [unity-renderer](https://github.com/decentraland/unity-renderer/) and [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/)
 
 At the protocol level both operations shouldn't be a problem, but `js-sdk-toolchain` CI will fail if the component is not tested. This can happen if the PR **`A`** from the protocol is merged, and you update your PR **`B`** from `js-sdk-toolchain` with the changes before the PR **`A`** from `js-sdk-toolchain` is merged.
 
 Some guidelines and testing before merge:
+
 - The protocol package is uploaded to S3 while developing in a PR. This can be used in the target repositories
 - Testing in the playground: Playground allows us to test by adding query parameters: `https://playground.decentraland.org/?&renderer-branch=**feat/my-new-component**&sdk-branch=**feat/new-component-approach**`
 - Testing locally: you can write an example scene and install the package `@dcl/sdk` uploaded to S3 commented in the PR comments.
@@ -42,16 +60,20 @@ Some guidelines and testing before merge:
 - Start merging when the three PRs are already to merge: first merge the Protocol one, then update the other two with the version @next and merge them at the same time.
 
 ## SDK: New APIs or APIs modifications
-Repositories: [kernel](https://github.com/decentraland/kernel/), [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/) and [scene-runtime](https://github.com/decentraland/scene-runtime/) 
+
+Repositories: [kernel](https://github.com/decentraland/kernel/), [js-sdk-toolchain](https://github.com/decentraland/js-sdk-toolchain/) and [scene-runtime](https://github.com/decentraland/scene-runtime/)
 In this case, there is no problem with when each PR is merged. It's recommendable to merge first the rpc server-side (in this case, Kernel), second the `scene-runtime` (and this would require a second update from `kernel`) and last the `js-sdk-toolchain`.
 
 ## Renderer protocol (RPC)
+
 Repositories: [kernel](https://github.com/decentraland/kernel/) and [unity-renderer](https://github.com/decentraland/unity-renderer/)
 
 TODO
 
 ## BFF
+
 TODO
 
-## Comms 
+## Comms
+
 TODO

package/out-js/decentraland/sdk/components/nft_shape.gen.d.ts

@@ -33,15 +33,15 @@ export declare function nftFrameTypeToJSON(object: NftFrameType): string;
 /**
  * The NftShape component renders a framed picture from an NFT. It supports PNG, JPEG and GIF files.
  *
- * The `src` field is the URI of the NFT, which includes its parent contract and index, using
- * the `https:` or `ethereum:` schemes.
+ * The `urn` field is the URI of the NFT, and must follow the format 'urn:decentraland:<CHAIN>:<CONTRACT_STANDARD>:<CONTRACT_ADDRESS>:<TOKEN_ID>'
+ * Example: 'urn:decentraland:ethereum:erc721:0x00000000:123'
  *
  * The picture frame can have several different styles, plus a background color for images that have
  * transparent pixels.
  */
 export interface PBNftShape {
     /** the URI of the NFT */
-    src: string;
+    urn: string;
     /** the frame style (default NFT_CLASSIC) */
     style?: NftFrameType | undefined;
     /** RGB background (default [0.6404918, 0.611472, 0.8584906]) */

package/out-js/decentraland/sdk/components/nft_shape.gen.js

@@ -169,13 +169,13 @@ function nftFrameTypeToJSON(object) {
 }
 exports.nftFrameTypeToJSON = nftFrameTypeToJSON;
 function createBasePBNftShape() {
-    return { src: "", style: undefined, color: undefined };
+    return { urn: "", style: undefined, color: undefined };
 }
 var PBNftShape;
 (function (PBNftShape) {
     function encode(message, writer = minimal_1.default.Writer.create()) {
-        if (message.src !== "") {
-            writer.uint32(10).string(message.src);
+        if (message.urn !== "") {
+            writer.uint32(10).string(message.urn);
         }
         if (message.style !== undefined) {
             writer.uint32(16).int32(message.style);
@@ -197,7 +197,7 @@ var PBNftShape;
                     if (tag !== 10) {
                         break;
                     }
-                    message.src = reader.string();
+                    message.urn = reader.string();
                     continue;
                 case 2:
                     if (tag !== 16) {
@@ -222,7 +222,7 @@ var PBNftShape;
     PBNftShape.decode = decode;
     function fromJSON(object) {
         return {
-            src: isSet(object.src) ? String(object.src) : "",
+            urn: isSet(object.urn) ? String(object.urn) : "",
             style: isSet(object.style) ? nftFrameTypeFromJSON(object.style) : undefined,
             color: isSet(object.color) ? colors_gen_1.Color3.fromJSON(object.color) : undefined,
         };
@@ -230,7 +230,7 @@ var PBNftShape;
     PBNftShape.fromJSON = fromJSON;
     function toJSON(message) {
         const obj = {};
-        message.src !== undefined && (obj.src = message.src);
+        message.urn !== undefined && (obj.urn = message.urn);
         message.style !== undefined &&
             (obj.style = message.style !== undefined ? nftFrameTypeToJSON(message.style) : undefined);
         message.color !== undefined && (obj.color = message.color ? colors_gen_1.Color3.toJSON(message.color) : undefined);
@@ -244,7 +244,7 @@ var PBNftShape;
     function fromPartial(object) {
         var _a, _b;
         const message = createBasePBNftShape();
-        message.src = (_a = object.src) !== null && _a !== void 0 ? _a : "";
+        message.urn = (_a = object.urn) !== null && _a !== void 0 ? _a : "";
         message.style = (_b = object.style) !== null && _b !== void 0 ? _b : undefined;
         message.color = (object.color !== undefined && object.color !== null)
             ? colors_gen_1.Color3.fromPartial(object.color)

package/out-ts/decentraland/sdk/components/nft_shape.gen.ts

@@ -167,15 +167,15 @@ export function nftFrameTypeToJSON(object: NftFrameType): string {
 /**
  * The NftShape component renders a framed picture from an NFT. It supports PNG, JPEG and GIF files.
  *
- * The `src` field is the URI of the NFT, which includes its parent contract and index, using
- * the `https:` or `ethereum:` schemes.
+ * The `urn` field is the URI of the NFT, and must follow the format 'urn:decentraland:<CHAIN>:<CONTRACT_STANDARD>:<CONTRACT_ADDRESS>:<TOKEN_ID>'
+ * Example: 'urn:decentraland:ethereum:erc721:0x00000000:123'
  *
  * The picture frame can have several different styles, plus a background color for images that have
  * transparent pixels.
  */
 export interface PBNftShape {
   /** the URI of the NFT */
-  src: string;
+  urn: string;
   /** the frame style (default NFT_CLASSIC) */
   style?:
     | NftFrameType
@@ -185,13 +185,13 @@ export interface PBNftShape {
 }
 
 function createBasePBNftShape(): PBNftShape {
-  return { src: "", style: undefined, color: undefined };
+  return { urn: "", style: undefined, color: undefined };
 }
 
 export namespace PBNftShape {
   export function encode(message: PBNftShape, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.src !== "") {
-      writer.uint32(10).string(message.src);
+    if (message.urn !== "") {
+      writer.uint32(10).string(message.urn);
     }
     if (message.style !== undefined) {
       writer.uint32(16).int32(message.style);
@@ -214,7 +214,7 @@ export namespace PBNftShape {
             break;
           }
 
-          message.src = reader.string();
+          message.urn = reader.string();
           continue;
         case 2:
           if (tag !== 16) {
@@ -241,7 +241,7 @@ export namespace PBNftShape {
 
   export function fromJSON(object: any): PBNftShape {
     return {
-      src: isSet(object.src) ? String(object.src) : "",
+      urn: isSet(object.urn) ? String(object.urn) : "",
       style: isSet(object.style) ? nftFrameTypeFromJSON(object.style) : undefined,
       color: isSet(object.color) ? Color3.fromJSON(object.color) : undefined,
     };
@@ -249,7 +249,7 @@ export namespace PBNftShape {
 
   export function toJSON(message: PBNftShape): unknown {
     const obj: any = {};
-    message.src !== undefined && (obj.src = message.src);
+    message.urn !== undefined && (obj.urn = message.urn);
     message.style !== undefined &&
       (obj.style = message.style !== undefined ? nftFrameTypeToJSON(message.style) : undefined);
     message.color !== undefined && (obj.color = message.color ? Color3.toJSON(message.color) : undefined);
@@ -262,7 +262,7 @@ export namespace PBNftShape {
 
   export function fromPartial<I extends Exact<DeepPartial<PBNftShape>, I>>(object: I): PBNftShape {
     const message = createBasePBNftShape();
-    message.src = object.src ?? "";
+    message.urn = object.urn ?? "";
     message.style = object.style ?? undefined;
     message.color = (object.color !== undefined && object.color !== null)
       ? Color3.fromPartial(object.color)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/protocol",
-  "version": "1.0.0-4982121558.commit-4b98e1a",
+  "version": "1.0.0-4982615619.commit-96dba07",
   "description": "",
   "repository": "decentraland/protocol.git",
   "homepage": "https://github.com/decentraland/protocol#readme",
@@ -29,5 +29,5 @@
     "out-js",
     "public"
   ],
-  "commit": "4b98e1a92f062036595ca092becc2a48f99be50d"
+  "commit": "96dba079e43c49ba396b15cd7c0cfefb3a268d51"
 }

package/proto/decentraland/sdk/components/nft_shape.proto

@@ -9,13 +9,13 @@ option (common.ecs_component_id) = 1040;
 
 // The NftShape component renders a framed picture from an NFT. It supports PNG, JPEG and GIF files.
 //
-// The `src` field is the URI of the NFT, which includes its parent contract and index, using
-// the `https:` or `ethereum:` schemes.
+// The `urn` field is the URI of the NFT, and must follow the format 'urn:decentraland:<CHAIN>:<CONTRACT_STANDARD>:<CONTRACT_ADDRESS>:<TOKEN_ID>'
+// Example: 'urn:decentraland:ethereum:erc721:0x00000000:123'
 //
 // The picture frame can have several different styles, plus a background color for images that have
 // transparent pixels.
 message PBNftShape {
-  string src = 1;                                // the URI of the NFT
+  string urn = 1;                                // the URI of the NFT
   optional NftFrameType style = 2;               // the frame style (default NFT_CLASSIC)
   optional decentraland.common.Color3 color = 3; // RGB background (default [0.6404918, 0.611472, 0.8584906])
 }