-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52 from holaplex/espi/mcc-import-solana-collectio…
…n-api-docs API Docs for Collections, Compression, 1:1 Mints, and Import Collections
- Loading branch information
Showing
39 changed files
with
1,021 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
id: create-collection-input | ||
title: CreateCollectionInput | ||
hide_table_of_contents: true | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
|
||
|
||
export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}> ● </span></> | ||
|
||
export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></> | ||
|
||
export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></> | ||
|
||
|
||
No description | ||
|
||
```graphql | ||
input CreateCollectionInput { | ||
project: UUID! | ||
blockchain: Blockchain! | ||
creators: [CreatorInput!]! | ||
metadataJson: MetadataJsonInput! | ||
} | ||
``` | ||
|
||
|
||
### Fields | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreateCollectionInput.<b>project</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreateCollectionInput.<b>blockchain</b></code>](#)<Bullet />[`Blockchain!`](/api/enums/blockchain) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="enum"/> | ||
> | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreateCollectionInput.<b>creators</b></code>](#)<Bullet />[`[CreatorInput!]!`](/api/inputs/creator-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/> | ||
> | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreateCollectionInput.<b>metadataJson</b></code>](#)<Bullet />[`MetadataJsonInput!`](/api/inputs/metadata-json-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/> | ||
> | ||
> | ||
|
||
|
||
|
||
### Member of | ||
|
||
[`createCollection`](/api/mutations/create-collection) <Badge class="secondary" text="mutation"/> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
id: creator-input | ||
title: CreatorInput | ||
hide_table_of_contents: true | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
|
||
|
||
export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}> ● </span></> | ||
|
||
export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></> | ||
|
||
export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></> | ||
|
||
|
||
An attributed creator for a collection or mint. | ||
|
||
```graphql | ||
input CreatorInput { | ||
address: String! | ||
verified: Boolean | ||
share: Int! | ||
} | ||
``` | ||
|
||
|
||
### Fields | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreatorInput.<b>address</b></code>](#)<Bullet />[`String!`](/api/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> The wallet address of the creator. | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreatorInput.<b>verified</b></code>](#)<Bullet />[`Boolean`](/api/scalars/boolean) <Badge class="secondary" text="scalar"/> | ||
> This field indicates whether the creator has been verified. This feature is only supported on the Solana blockchain. | ||
## References | ||
[Metaplex Token Metadata - Verify creator instruction](https://docs.metaplex.com/programs/token-metadata/instructions#verify-a-creator) | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>CreatorInput.<b>share</b></code>](#)<Bullet />[`Int!`](/api/scalars/int) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> The share of royalties payout the creator should receive. | ||
> | ||
|
||
|
||
|
||
### Member of | ||
|
||
[`CreateCollectionInput`](/api/inputs/create-collection-input) <Badge class="secondary" text="input"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input) <Badge class="secondary" text="input"/><Bullet />[`MintToCollectionInput`](/api/inputs/mint-to-collection-input) <Badge class="secondary" text="input"/><Bullet />[`PatchCollectionInput`](/api/inputs/patch-collection-input) <Badge class="secondary" text="input"/><Bullet />[`PatchDropInput`](/api/inputs/patch-drop-input) <Badge class="secondary" text="input"/> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
id: import-collection-input | ||
title: ImportCollectionInput | ||
hide_table_of_contents: true | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
|
||
|
||
export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}> ● </span></> | ||
|
||
export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></> | ||
|
||
export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></> | ||
|
||
|
||
Input object for importing a collection. | ||
|
||
```graphql | ||
input ImportCollectionInput { | ||
project: UUID! | ||
collection: String! | ||
} | ||
``` | ||
|
||
|
||
### Fields | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>ImportCollectionInput.<b>project</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>ImportCollectionInput.<b>collection</b></code>](#)<Bullet />[`String!`](/api/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> | ||
> | ||
|
||
|
||
|
||
### Member of | ||
|
||
[`importSolanaCollection`](/api/mutations/import-solana-collection) <Badge class="secondary" text="mutation"/> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
id: mint-to-collection-input | ||
title: MintToCollectionInput | ||
hide_table_of_contents: true | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
|
||
|
||
export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}> ● </span></> | ||
|
||
export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></> | ||
|
||
export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></> | ||
|
||
|
||
Represents input data for `mint_to_collection` mutation with a collection ID, recipient, metadata, and optional seller fee basis points as fields | ||
|
||
```graphql | ||
input MintToCollectionInput { | ||
collection: UUID! | ||
recipient: String! | ||
metadataJson: MetadataJsonInput! | ||
sellerFeeBasisPoints: Int | ||
creators: [CreatorInput!]! | ||
compressed: Boolean | ||
} | ||
``` | ||
|
||
|
||
### Fields | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>MintToCollectionInput.<b>collection</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> The ID of the collection to mint to | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>MintToCollectionInput.<b>recipient</b></code>](#)<Bullet />[`String!`](/api/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> The recipient of the mint | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>MintToCollectionInput.<b>metadataJson</b></code>](#)<Bullet />[`MetadataJsonInput!`](/api/inputs/metadata-json-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/> | ||
> The metadata of the mint | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>MintToCollectionInput.<b>sellerFeeBasisPoints</b></code>](#)<Bullet />[`Int`](/api/scalars/int) <Badge class="secondary" text="scalar"/> | ||
> The optional seller fee basis points | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>MintToCollectionInput.<b>creators</b></code>](#)<Bullet />[`[CreatorInput!]!`](/api/inputs/creator-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/> | ||
> The creators to be assigned to the NFT. | ||
For Solana, this can be up to five creators. If the project treasury wallet is set as a creator and verified set to true the creator will be verified on chain. | ||
For Polygon, this can be only 1 creator. | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>MintToCollectionInput.<b>compressed</b></code>](#)<Bullet />[`Boolean`](/api/scalars/boolean) <Badge class="secondary" text="scalar"/> | ||
> | ||
> | ||
|
||
|
||
|
||
### Member of | ||
|
||
[`mintToCollection`](/api/mutations/mint-to-collection) <Badge class="secondary" text="mutation"/> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
id: patch-collection-input | ||
title: PatchCollectionInput | ||
hide_table_of_contents: true | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
|
||
|
||
export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}> ● </span></> | ||
|
||
export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></> | ||
|
||
export const Badge = (props) => <><span className={'badge badge--' + props.class}>{props.text}</span></> | ||
|
||
|
||
Input object for patching a collection by ID. | ||
|
||
```graphql | ||
input PatchCollectionInput { | ||
id: UUID! | ||
metadataJson: MetadataJsonInput | ||
creators: [CreatorInput!] | ||
} | ||
``` | ||
|
||
|
||
### Fields | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>PatchCollectionInput.<b>id</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/> | ||
> The unique identifier of the drop | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>PatchCollectionInput.<b>metadataJson</b></code>](#)<Bullet />[`MetadataJsonInput`](/api/inputs/metadata-json-input) <Badge class="secondary" text="input"/> | ||
> The new metadata JSON for the drop | ||
> | ||
|
||
#### [<code style={{ fontWeight: 'normal' }}>PatchCollectionInput.<b>creators</b></code>](#)<Bullet />[`[CreatorInput!]`](/api/inputs/creator-input) <Badge class="secondary" text="list"/> <Badge class="secondary" text="input"/> | ||
> The creators of the drop | ||
> | ||
|
||
|
||
|
||
### Member of | ||
|
||
[`patchCollection`](/api/mutations/patch-collection) <Badge class="secondary" text="mutation"/> | ||
|
||
|
||
|
Oops, something went wrong.