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

update NETWORK_SUBGRAPH_MAINNET & add api-key to CLI #1760

Merged
merged 5 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion packages/cli/src/commands/publish.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ export default class PublishCommand extends Command {
required: false,
default: 'https://cli.thegraph.com/publish',
}),
'api-key': Flags.string({
summary: 'The API key to use for the Subgraph queries.',
required: false,
}),
};

/**
Expand All @@ -56,11 +60,13 @@ export default class PublishCommand extends Command {
webapp,
subgraphId,
protocolNetwork,
apiKey,
}: {
ipfsHash: string;
webapp: string;
subgraphId: string | undefined;
protocolNetwork: string | undefined;
apiKey: string | undefined;
}) {
const answer = await ux.prompt(
`Press ${chalk.green(
Expand All @@ -84,6 +90,9 @@ export default class PublishCommand extends Command {
if (protocolNetwork) {
searchParams.set('network', protocolNetwork);
}
if (apiKey) {
searchParams.set('apiKey', apiKey);
}

url.search = searchParams.toString();

Expand All @@ -105,11 +114,25 @@ export default class PublishCommand extends Command {
ipfs,
'subgraph-id': subgraphId,
'protocol-network': protocolNetwork,
'api-key': apiKey,
},
} = await this.parse(PublishCommand);

if (subgraphId && !apiKey) {
ux.error(
'API key is required to publish to an existing subgraph (`--api-key`).\nSee https://thegraph.com/docs/en/deploying/subgraph-studio-faqs/#2-how-do-i-create-an-api-key',
{ exit: 1 },
);
}

if (ipfsHash) {
await this.publishWithBrowser({ ipfsHash, webapp: webUiUrl, subgraphId, protocolNetwork });
await this.publishWithBrowser({
ipfsHash,
webapp: webUiUrl,
subgraphId,
protocolNetwork,
apiKey,
});
return;
}

Expand Down Expand Up @@ -146,6 +169,7 @@ export default class PublishCommand extends Command {
webapp: webUiUrl,
subgraphId,
protocolNetwork,
apiKey,
});
return;
}
Expand Down
22 changes: 5 additions & 17 deletions website/src/lib/graphql.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,13 @@
import { print } from 'graphql';
import { TypedDocumentNode } from '@graphql-typed-document-node/core';

export const NETWORK_SUBGRAPH_MAINNET =
'https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum';
'https://gateway.thegraph.com/api/{api-key}/subgraphs/id/DZz4kDTdmzWLWsV373w2bSmoar3umKKH9y82SUKr5qmp';
export const NETWORK_SUBGRAPH_SEPOLIA =
'https://api.thegraph.com/subgraphs/name/graphprotocol/graph-network-arbitrum-sepolia';
'https://gateway.thegraph.com/api/{api-key}/subgraphs/id/3xQHhMudr1oh69ut36G2mbzpYmYxwqCeU6wwqyCDCnqV';

export async function networkSubgraphExecute<Result = unknown, Variables = unknown>(
query: TypedDocumentNode<Result, Variables>,
variables: Variables,
{
endpoint,
}: {
endpoint: string;
},
): Promise<Result> {
const response = await fetch(endpoint, {
export async function networkSubgraphExecute(query: string, endpoint: string, apiKey: string) {
const response = await fetch(endpoint.replace('{api-key}', apiKey), {
method: 'POST',
body: JSON.stringify({
query: print(query),
variables,
query,
}),
});
return (await response.json()).data;
Expand Down
59 changes: 42 additions & 17 deletions website/src/routes/publish.lazy.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { useState } from 'react';
import { ConnectKitButton, useModal } from 'connectkit';
import { graphql } from 'gql.tada';
import { useForm } from 'react-hook-form';
import semver from 'semver';
import { Address } from 'viem';
Expand Down Expand Up @@ -129,9 +128,9 @@ const Manifest = z.object({
repository: z.string().describe('An optional link to where the subgraph lives.').optional(),
});

const GetSubgraphInfo = graphql(/* GraphQL */ `
query GetSubgraphInfo($subgraphId: ID!) {
subgraph(id: $subgraphId) {
const GetSubgraphInfo = (subgraphId: string) => `
{
subgraph(id: "${subgraphId}") {
id
owner {
id
Expand All @@ -155,7 +154,7 @@ const GetSubgraphInfo = graphql(/* GraphQL */ `
}
}
}
`);
`;

function getEtherscanUrl({ chainId, hash }: { chainId: number; hash: string }) {
switch (chainId) {
Expand All @@ -172,10 +171,12 @@ function DeploySubgraph({
deploymentId,
subgraphId,
network,
apiKey,
}: {
deploymentId: string;
subgraphId: string | undefined;
network: (typeof CHAINS)[number] | undefined;
apiKey: string | undefined;
}) {
const { writeContractAsync, isPending, error: contractError } = useWriteContract({});
const { setOpen } = useModal();
Expand Down Expand Up @@ -214,20 +215,32 @@ function DeploySubgraph({
const chain = form.watch('chain');

const { data: subgraphInfo } = useQuery({
queryKey: ['subgraph-info', subgraphId, chain, chainId],
queryKey: ['subgraph-info', subgraphId, chain, chainId, apiKey],
queryFn: async () => {
if (!subgraphId) return;
if (!subgraphId) {
toast({
description: 'Subgraph ID is missing. Please add it to the URL params and try again.',
variant: 'destructive',
});
return;
}
if (!apiKey) {
toast({
description:
'apiKey is missing in URL params. Please add it to the URL params and try again.',
variant: 'destructive',
});
return;
}

const subgraphEndpoint = chain ? getChainInfo(chain)?.subgraph : null;

if (!subgraphEndpoint) return;

const data = await networkSubgraphExecute(
GetSubgraphInfo,
{ subgraphId },
{
endpoint: subgraphEndpoint,
},
GetSubgraphInfo(subgraphId),
subgraphEndpoint,
apiKey,
);

const metadata = data.subgraph?.metadata;
Expand All @@ -251,6 +264,11 @@ function DeploySubgraph({
if (metadata.displayName) {
form.setValue('displayName', metadata.displayName);
}

if (data.subgraph.versions?.length > 0) {
const version = data.subgraph.versions[data.subgraph.versions.length - 1];
form.setValue('versionLabel', version.metadata?.label ?? '');
}
}

return data;
Expand All @@ -264,7 +282,7 @@ function DeploySubgraph({
const version = form.watch('versionLabel');

const versionInfo = subgraphInfo.subgraph?.versions.find(
({ metadata }) => metadata?.label === version,
({ metadata }: { metadata: { label: string } }) => metadata?.label === version,
);

if (!versionInfo) return false;
Expand All @@ -280,7 +298,9 @@ function DeploySubgraph({

const version = form.watch('versionLabel');

return !subgraphInfo.subgraph?.versions.some(({ metadata }) => metadata?.label === version);
return !subgraphInfo.subgraph?.versions.some(
({ metadata }: { metadata: { label: string } }) => metadata?.label === version,
);
}

function isOwner() {
Expand Down Expand Up @@ -375,7 +395,7 @@ function DeploySubgraph({
if (e?.name === 'ContractFunctionExecutionError') {
if (e.cause.name === 'ContractFunctionRevertedError') {
toast({
description: e.cause.reason,
description: e.cause.message,
variant: 'destructive',
});
return;
Expand Down Expand Up @@ -565,7 +585,7 @@ function DeploySubgraph({
}

function Page() {
const { id, subgraphId, network } = Route.useSearch();
const { id, subgraphId, network, apiKey } = Route.useSearch();

const protocolNetwork = network
? // @ts-expect-error we want to compare if it is a string or not
Expand All @@ -581,7 +601,12 @@ function Page() {
<ConnectKitButton />
</nav>
{id ? (
<DeploySubgraph deploymentId={id} subgraphId={subgraphId} network={protocolNetwork} />
<DeploySubgraph
deploymentId={id}
subgraphId={subgraphId}
network={protocolNetwork}
apiKey={apiKey}
/>
) : (
<div className="flex justify-center items-center min-h-screen -mt-16">
Unable to find the Deployment ID. Go back to CLI
Expand Down
3 changes: 2 additions & 1 deletion website/src/routes/publish.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export const Route = createFileRoute('/publish')({
subgraphId: z.string().optional(),
// Transforming string to enum here doesn't actually work
network: z.string().optional(),
id: z.string(),
id: z.string().optional(),
apiKey: z.string().optional(),
}),
});
Loading