@solana-mobile/dapp-store-publishing-tools 0.16.0 → 1.0.0

package/lib/publish/PublishCoreSubmit.js

@@ -118,125 +118,15 @@ function _ts_generator(thisArg, body) {
         };
     }
 }
-import { createAttestationPayload } from "./PublishCoreAttestation.js";
-import { CONTACT_OBJECT_ID, CONTACT_PROPERTY_COMPANY, CONTACT_PROPERTY_EMAIL, CONTACT_PROPERTY_WEBSITE, submitRequestToSolanaDappPublisherPortal, TICKET_OBJECT_ID, TICKET_PROPERTY_ALPHA_TEST, TICKET_PROPERTY_ALPHA_TESTERS, TICKET_PROPERTY_ATTESTATION_PAYLOAD, TICKET_PROPERTY_AUTHORIZED_REQUEST, TICKET_PROPERTY_DAPP_COLLECTION_ACCOUNT_ADDRESS, TICKET_PROPERTY_DAPP_RELEASE_ACCOUNT_ADDRESS, TICKET_PROPERTY_GOOGLE_PLAY_STORE_PACKAGE_NAME, TICKET_PROPERTY_POLICY_COMPLIANT, TICKET_PROPERTY_REQUEST_UNIQUE_ID, TICKET_PROPERTY_TESTING_INSTRUCTIONS, URL_FORM_SUBMIT } from "./dapp_publisher_portal.js";
-var createSubmitRequest = function(connection, sign, appMintAddress, releaseMintAddress, publisherDetails, solanaMobileDappPublisherPortalDetails, compliesWithSolanaDappStorePolicies, requestorIsAuthorized, alphaTest) {
+import { deprecateLegacyPublishSurface } from '../portal/compat.js';
+export var publishSubmit = function(_publishSolanaNetworkInput, _input, _dryRun) {
     return _async_to_generator(function() {
-        var _ref, attestationPayload, requestUniqueId, request;
         return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    return [
-                        4,
-                        createAttestationPayload(connection, sign)
-                    ];
-                case 1:
-                    _ref = _state.sent(), attestationPayload = _ref.attestationPayload, requestUniqueId = _ref.requestUniqueId;
-                    request = {
-                        fields: [
-                            {
-                                objectTypeId: CONTACT_OBJECT_ID,
-                                name: CONTACT_PROPERTY_COMPANY,
-                                value: publisherDetails.name
-                            },
-                            {
-                                objectTypeId: CONTACT_OBJECT_ID,
-                                name: CONTACT_PROPERTY_EMAIL,
-                                value: publisherDetails.email
-                            },
-                            {
-                                objectTypeId: CONTACT_OBJECT_ID,
-                                name: CONTACT_PROPERTY_WEBSITE,
-                                value: publisherDetails.website
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_ATTESTATION_PAYLOAD,
-                                value: attestationPayload
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_DAPP_COLLECTION_ACCOUNT_ADDRESS,
-                                value: appMintAddress
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_DAPP_RELEASE_ACCOUNT_ADDRESS,
-                                value: releaseMintAddress
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_REQUEST_UNIQUE_ID,
-                                value: requestUniqueId
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_AUTHORIZED_REQUEST,
-                                value: requestorIsAuthorized
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_POLICY_COMPLIANT,
-                                value: compliesWithSolanaDappStorePolicies
-                            }
-                        ]
-                    };
-                    if (solanaMobileDappPublisherPortalDetails.google_store_package !== undefined) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_GOOGLE_PLAY_STORE_PACKAGE_NAME,
-                            value: solanaMobileDappPublisherPortalDetails.google_store_package
-                        });
-                    }
-                    if (alphaTest) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_ALPHA_TEST,
-                            value: true
-                        });
-                    }
-                    if (solanaMobileDappPublisherPortalDetails.testing_instructions !== undefined) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_TESTING_INSTRUCTIONS,
-                            value: solanaMobileDappPublisherPortalDetails.testing_instructions
-                        });
-                    }
-                    if (solanaMobileDappPublisherPortalDetails.alpha_testers !== undefined && solanaMobileDappPublisherPortalDetails.alpha_testers.length > 0) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_ALPHA_TESTERS,
-                            value: solanaMobileDappPublisherPortalDetails.alpha_testers.map(function(tester) {
-                                return tester.address;
-                            }).toString()
-                        });
-                    }
-                    return [
-                        2,
-                        request
-                    ];
-            }
-        });
-    })();
-};
-export var publishSubmit = function(publishSolanaNetworkInput, param, dryRun) {
-    var appMintAddress = param.appMintAddress, releaseMintAddress = param.releaseMintAddress, publisherDetails = param.publisherDetails, solanaMobileDappPublisherPortalDetails = param.solanaMobileDappPublisherPortalDetails, compliesWithSolanaDappStorePolicies = param.compliesWithSolanaDappStorePolicies, requestorIsAuthorized = param.requestorIsAuthorized, alphaTest = param.alphaTest;
-    return _async_to_generator(function() {
-        var submitRequest;
-        return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    return [
-                        4,
-                        createSubmitRequest(publishSolanaNetworkInput.connection, publishSolanaNetworkInput.sign, appMintAddress, releaseMintAddress, publisherDetails, solanaMobileDappPublisherPortalDetails, compliesWithSolanaDappStorePolicies, requestorIsAuthorized, alphaTest)
-                    ];
-                case 1:
-                    submitRequest = _state.sent();
-                    return [
-                        2,
-                        submitRequestToSolanaDappPublisherPortal(submitRequest, URL_FORM_SUBMIT, dryRun)
-                    ];
-            }
+            deprecateLegacyPublishSurface('publishSubmit');
+            return [
+                2,
+                undefined
+            ];
         });
     })();
 };

package/lib/publish/PublishCoreSupport.js

@@ -118,94 +118,15 @@ function _ts_generator(thisArg, body) {
         };
     }
 }
-import { createAttestationPayload } from "./PublishCoreAttestation.js";
-import { CONTACT_OBJECT_ID, CONTACT_PROPERTY_COMPANY, CONTACT_PROPERTY_EMAIL, CONTACT_PROPERTY_WEBSITE, submitRequestToSolanaDappPublisherPortal, TICKET_OBJECT_ID, TICKET_PROPERTY_ATTESTATION_PAYLOAD, TICKET_PROPERTY_AUTHORIZED_REQUEST, TICKET_PROPERTY_CONTENT, TICKET_PROPERTY_DAPP_COLLECTION_ACCOUNT_ADDRESS, TICKET_PROPERTY_DAPP_RELEASE_ACCOUNT_ADDRESS, TICKET_PROPERTY_REQUEST_UNIQUE_ID, URL_FORM_SUPPORT } from "./dapp_publisher_portal.js";
-var createSupportRequest = function(connection, sign, appMintAddress, releaseMintAddress, publisherDetails, requestorIsAuthorized, requestDetails) {
+import { deprecateLegacyPublishSurface } from '../portal/compat.js';
+export var publishSupport = function(_publishSolanaNetworkInput, _input, _dryRun) {
     return _async_to_generator(function() {
-        var _ref, attestationPayload, requestUniqueId;
         return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    return [
-                        4,
-                        createAttestationPayload(connection, sign)
-                    ];
-                case 1:
-                    _ref = _state.sent(), attestationPayload = _ref.attestationPayload, requestUniqueId = _ref.requestUniqueId;
-                    return [
-                        2,
-                        {
-                            fields: [
-                                {
-                                    objectTypeId: CONTACT_OBJECT_ID,
-                                    name: CONTACT_PROPERTY_COMPANY,
-                                    value: publisherDetails.name
-                                },
-                                {
-                                    objectTypeId: CONTACT_OBJECT_ID,
-                                    name: CONTACT_PROPERTY_EMAIL,
-                                    value: publisherDetails.email
-                                },
-                                {
-                                    objectTypeId: CONTACT_OBJECT_ID,
-                                    name: CONTACT_PROPERTY_WEBSITE,
-                                    value: publisherDetails.website
-                                },
-                                {
-                                    objectTypeId: TICKET_OBJECT_ID,
-                                    name: TICKET_PROPERTY_ATTESTATION_PAYLOAD,
-                                    value: attestationPayload
-                                },
-                                {
-                                    objectTypeId: TICKET_OBJECT_ID,
-                                    name: TICKET_PROPERTY_CONTENT,
-                                    value: requestDetails
-                                },
-                                {
-                                    objectTypeId: TICKET_OBJECT_ID,
-                                    name: TICKET_PROPERTY_DAPP_COLLECTION_ACCOUNT_ADDRESS,
-                                    value: appMintAddress
-                                },
-                                {
-                                    objectTypeId: TICKET_OBJECT_ID,
-                                    name: TICKET_PROPERTY_DAPP_RELEASE_ACCOUNT_ADDRESS,
-                                    value: releaseMintAddress
-                                },
-                                {
-                                    objectTypeId: TICKET_OBJECT_ID,
-                                    name: TICKET_PROPERTY_REQUEST_UNIQUE_ID,
-                                    value: requestUniqueId
-                                },
-                                {
-                                    objectTypeId: TICKET_OBJECT_ID,
-                                    name: TICKET_PROPERTY_AUTHORIZED_REQUEST,
-                                    value: requestorIsAuthorized
-                                }
-                            ]
-                        }
-                    ];
-            }
-        });
-    })();
-};
-export var publishSupport = function(publishSolanaNetworkInput, param, dryRun) {
-    var appMintAddress = param.appMintAddress, releaseMintAddress = param.releaseMintAddress, publisherDetails = param.publisherDetails, requestorIsAuthorized = param.requestorIsAuthorized, requestDetails = param.requestDetails;
-    return _async_to_generator(function() {
-        var supportRequest;
-        return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    return [
-                        4,
-                        createSupportRequest(publishSolanaNetworkInput.connection, publishSolanaNetworkInput.sign, appMintAddress, releaseMintAddress, publisherDetails, requestorIsAuthorized, requestDetails)
-                    ];
-                case 1:
-                    supportRequest = _state.sent();
-                    return [
-                        2,
-                        submitRequestToSolanaDappPublisherPortal(supportRequest, URL_FORM_SUPPORT, dryRun)
-                    ];
-            }
+            deprecateLegacyPublishSurface('publishSupport');
+            return [
+                2,
+                undefined
+            ];
         });
     })();
 };

package/lib/publish/PublishCoreUpdate.js

@@ -118,125 +118,15 @@ function _ts_generator(thisArg, body) {
         };
     }
 }
-import { createAttestationPayload } from "./PublishCoreAttestation.js";
-import { CONTACT_OBJECT_ID, CONTACT_PROPERTY_COMPANY, CONTACT_PROPERTY_EMAIL, CONTACT_PROPERTY_WEBSITE, submitRequestToSolanaDappPublisherPortal, TICKET_OBJECT_ID, TICKET_PROPERTY_ALPHA_TEST, TICKET_PROPERTY_ALPHA_TESTERS, TICKET_PROPERTY_ATTESTATION_PAYLOAD, TICKET_PROPERTY_AUTHORIZED_REQUEST, TICKET_PROPERTY_CRITICAL_UPDATE, TICKET_PROPERTY_DAPP_COLLECTION_ACCOUNT_ADDRESS, TICKET_PROPERTY_DAPP_RELEASE_ACCOUNT_ADDRESS, TICKET_PROPERTY_POLICY_COMPLIANT, TICKET_PROPERTY_REQUEST_UNIQUE_ID, TICKET_PROPERTY_TESTING_INSTRUCTIONS, URL_FORM_UPDATE } from "./dapp_publisher_portal.js";
-var createUpdateRequest = function(connection, sign, appMintAddress, releaseMintAddress, publisherDetails, solanaMobileDappPublisherPortalDetails, compliesWithSolanaDappStorePolicies, requestorIsAuthorized, criticalUpdate, alphaTest) {
+import { deprecateLegacyPublishSurface } from '../portal/compat.js';
+export var publishUpdate = function(_publishSolanaNetworkInput, _input, _dryRun) {
     return _async_to_generator(function() {
-        var _ref, attestationPayload, requestUniqueId, request;
         return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    return [
-                        4,
-                        createAttestationPayload(connection, sign)
-                    ];
-                case 1:
-                    _ref = _state.sent(), attestationPayload = _ref.attestationPayload, requestUniqueId = _ref.requestUniqueId;
-                    request = {
-                        fields: [
-                            {
-                                objectTypeId: CONTACT_OBJECT_ID,
-                                name: CONTACT_PROPERTY_COMPANY,
-                                value: publisherDetails.name
-                            },
-                            {
-                                objectTypeId: CONTACT_OBJECT_ID,
-                                name: CONTACT_PROPERTY_EMAIL,
-                                value: publisherDetails.email
-                            },
-                            {
-                                objectTypeId: CONTACT_OBJECT_ID,
-                                name: CONTACT_PROPERTY_WEBSITE,
-                                value: publisherDetails.website
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_ATTESTATION_PAYLOAD,
-                                value: attestationPayload
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_DAPP_COLLECTION_ACCOUNT_ADDRESS,
-                                value: appMintAddress
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_DAPP_RELEASE_ACCOUNT_ADDRESS,
-                                value: releaseMintAddress
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_REQUEST_UNIQUE_ID,
-                                value: requestUniqueId
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_AUTHORIZED_REQUEST,
-                                value: requestorIsAuthorized
-                            },
-                            {
-                                objectTypeId: TICKET_OBJECT_ID,
-                                name: TICKET_PROPERTY_POLICY_COMPLIANT,
-                                value: compliesWithSolanaDappStorePolicies
-                            }
-                        ]
-                    };
-                    if (criticalUpdate) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_CRITICAL_UPDATE,
-                            value: criticalUpdate
-                        });
-                    }
-                    if (alphaTest) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_ALPHA_TEST,
-                            value: true
-                        });
-                    }
-                    if (solanaMobileDappPublisherPortalDetails.testing_instructions !== undefined) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_TESTING_INSTRUCTIONS,
-                            value: solanaMobileDappPublisherPortalDetails.testing_instructions
-                        });
-                    }
-                    if (solanaMobileDappPublisherPortalDetails.alpha_testers !== undefined && solanaMobileDappPublisherPortalDetails.alpha_testers.length > 0) {
-                        request.fields.push({
-                            objectTypeId: TICKET_OBJECT_ID,
-                            name: TICKET_PROPERTY_ALPHA_TESTERS,
-                            value: solanaMobileDappPublisherPortalDetails.alpha_testers.map(function(tester) {
-                                return tester.address;
-                            }).toString()
-                        });
-                    }
-                    return [
-                        2,
-                        request
-                    ];
-            }
-        });
-    })();
-};
-export var publishUpdate = function(publishSolanaNetworkInput, param, dryRun) {
-    var appMintAddress = param.appMintAddress, releaseMintAddress = param.releaseMintAddress, publisherDetails = param.publisherDetails, solanaMobileDappPublisherPortalDetails = param.solanaMobileDappPublisherPortalDetails, compliesWithSolanaDappStorePolicies = param.compliesWithSolanaDappStorePolicies, requestorIsAuthorized = param.requestorIsAuthorized, criticalUpdate = param.criticalUpdate, alphaTest = param.alphaTest;
-    return _async_to_generator(function() {
-        var updateRequest;
-        return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    return [
-                        4,
-                        createUpdateRequest(publishSolanaNetworkInput.connection, publishSolanaNetworkInput.sign, appMintAddress, releaseMintAddress, publisherDetails, solanaMobileDappPublisherPortalDetails, compliesWithSolanaDappStorePolicies, requestorIsAuthorized, criticalUpdate, alphaTest)
-                    ];
-                case 1:
-                    updateRequest = _state.sent();
-                    return [
-                        2,
-                        submitRequestToSolanaDappPublisherPortal(updateRequest, URL_FORM_UPDATE, dryRun)
-                    ];
-            }
+            deprecateLegacyPublishSurface('publishUpdate');
+            return [
+                2,
+                undefined
+            ];
         });
     })();
 };

package/lib/publish/index.js

@@ -1,3 +1,4 @@
+export * from "./PublishCoreAttestation.js";
 export * from "./PublishCoreRemove.js";
 export * from "./PublishCoreSubmit.js";
 export * from "./PublishCoreSupport.js";

package/lib/schemas/releaseJsonMetadata.json

@@ -72,8 +72,7 @@
                   "pattern": "^https://"
                 },
                 "copyright_url": {
-                  "type": "string",
-                  "pattern": "^https://"
+                  "type": "string"
                 },
                 "privacy_policy_url": {
                   "type": "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana-mobile/dapp-store-publishing-tools",
-  "version": "0.16.0",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,
@@ -26,17 +26,15 @@
   "devDependencies": {
     "@types/debug": "^4.1.7",
     "@types/mime": "^3.0.1",
-    "@types/node-fetch": "^2.6.2",
     "get-video-dimensions": "^1.0.0",
     "json-schema-to-typescript": "^11.0.2",
     "shx": "^0.3.4"
   },
   "dependencies": {
     "@metaplex-foundation/js": "0.20.0",
+    "@metaplex-foundation/mpl-token-metadata": "2.13.0",
     "@solana/web3.js": "1.68.0",
     "ajv": "^8.11.0",
-    "axios": "1.1.3",
-    "chokidar": "^3.5.3",
     "debug": "^4.3.4",
     "image-size": "^1.0.2",
     "mime": "^3.0.0"

package/src/CoreUtils.ts

@@ -10,12 +10,6 @@ import { ComputeBudgetProgram } from "@solana/web3.js";
 export class Constants {
   static PUBLISHING_SCHEMA_VER = "0.4.0";
 }
-export const truncateAddress = (address: string) => {
-  return `${address.slice(0, 4)}...${address.slice(
-    address.length - 4,
-    address.length
-  )}`;
-};
 
 type JsonMetadataMetaplexFile = Omit<JsonMetadata, "image"> & {
   image: string | MetaplexFile;

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from './portal/index.js';
 export * from "./create/index.js";
 export * from "./publish/index.js";
 export * from "./validate/CoreValidation.js";

package/src/portal/attestation.ts

@@ -0,0 +1,76 @@
+import type {
+  PublicationAttestationBlockData,
+  PublicationAttestationClient,
+  PublicationSigner,
+} from './types.js';
+
+export type PublicationAttestation = {
+  slot_number: number;
+  blockhash: string;
+  request_unique_id: string;
+};
+
+export type PublicationAttestationResult = {
+  payload: string;
+  attestationPayload: string;
+  requestUniqueId: string;
+  attestation: PublicationAttestation;
+};
+
+export const createRequestUniqueId = () => {
+  const requestUniqueIdLength = 32;
+  const charset = '0123456789';
+
+  return Array(requestUniqueIdLength)
+    .fill(undefined)
+    .map(() => charset.charAt(Math.floor(Math.random() * charset.length)))
+    .join('');
+};
+
+export const createAttestationPayload = async (
+  blockData: PublicationAttestationBlockData,
+  signer: Pick<PublicationSigner, 'signMessage'>,
+): Promise<PublicationAttestationResult> => {
+  const requestUniqueId = createRequestUniqueId();
+  const attestation: PublicationAttestation = {
+    slot_number: blockData.slot,
+    blockhash: blockData.blockhash,
+    request_unique_id: requestUniqueId,
+  };
+
+  const attestationBuffer = new TextEncoder().encode(
+    JSON.stringify(attestation),
+  );
+  const signedMessageFromSigner = await signer.signMessage(attestationBuffer);
+  const signedMessageBuffer =
+    signedMessageFromSigner.length === 64
+      ? (() => {
+          const payload = new Uint8Array(64 + attestationBuffer.length);
+          payload.set(signedMessageFromSigner, 0);
+          payload.set(attestationBuffer, 64);
+          return payload;
+        })()
+      : signedMessageFromSigner;
+  const signature = signedMessageBuffer.slice(0, 64);
+
+  if (signature.length !== 64) {
+    throw new Error(
+      `Invalid signature length: expected 64, got ${signature.length}`,
+    );
+  }
+
+  return {
+    payload: Buffer.from(signedMessageBuffer).toString('base64'),
+    attestationPayload: Buffer.from(signedMessageBuffer).toString('base64'),
+    requestUniqueId,
+    attestation,
+  };
+};
+
+export const createAttestationPayloadFromClient = async (
+  client: PublicationAttestationClient,
+  signer: Pick<PublicationSigner, 'signMessage'>,
+): Promise<PublicationAttestationResult> => {
+  const blockData = await client.getBlockData();
+  return createAttestationPayload(blockData, signer);
+};

package/src/portal/compat.ts

@@ -0,0 +1,5 @@
+export const deprecateLegacyPublishSurface = (surface: string): void => {
+  console.warn(
+    `${surface} is deprecated and now a no-op. Use the portal-driven publication workflow exports from @solana-mobile/dapp-store-publishing-tools instead.`,
+  );
+};

package/src/portal/index.ts

@@ -0,0 +1,5 @@
+export * from './attestation.js';
+export * from './compat.js';
+export * from './signer.js';
+export * from './types.js';
+export * from './workflow.js';