Skip to content

Commit

Permalink
Merge pull request #52 from holaplex/espi/mcc-import-solana-collectio…
Browse files Browse the repository at this point in the history
…n-api-docs

API Docs for Collections, Compression, 1:1 Mints, and Import Collections
  • Loading branch information
kespinola authored Aug 4, 2023
2 parents 85448ce + 5b26a83 commit def6aae
Show file tree
Hide file tree
Showing 39 changed files with 1,021 additions and 40 deletions.
20 changes: 20 additions & 0 deletions docs/api/enums/action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ enum Action {
RETRY_DROP
RETRY_MINT
TRANSFER_ASSET
CREATE_COLLECTION
RETRY_COLLECTION
MINT
MINT_COMPRESSED
}
```

Expand Down Expand Up @@ -55,6 +59,22 @@ enum Action {
>
>
#### [<code style={{ fontWeight: 'normal' }}>Action.<b>CREATE_COLLECTION</b></code>](#)
>
>
#### [<code style={{ fontWeight: 'normal' }}>Action.<b>RETRY_COLLECTION</b></code>](#)
>
>
#### [<code style={{ fontWeight: 'normal' }}>Action.<b>MINT</b></code>](#)
>
>
#### [<code style={{ fontWeight: 'normal' }}>Action.<b>MINT_COMPRESSED</b></code>](#)
>
>


### Member of
Expand Down
2 changes: 1 addition & 1 deletion docs/api/enums/blockchain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ enum Blockchain {

### Member of

[`BlockchainCost`](/api/objects/blockchain-cost) <Badge class="secondary" text="object"/><Bullet />[`Collection`](/api/objects/collection) <Badge class="secondary" text="object"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input) <Badge class="secondary" text="input"/>
[`BlockchainCost`](/api/objects/blockchain-cost) <Badge class="secondary" text="object"/><Bullet />[`Collection`](/api/objects/collection) <Badge class="secondary" text="object"/><Bullet />[`CreateCollectionInput`](/api/inputs/create-collection-input) <Badge class="secondary" text="input"/><Bullet />[`CreateDropInput`](/api/inputs/create-drop-input) <Badge class="secondary" text="input"/>



2 changes: 1 addition & 1 deletion docs/api/enums/creation-status.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ enum CreationStatus {

### Member of

[`Collection`](/api/objects/collection) <Badge class="secondary" text="object"/><Bullet />[`CollectionMint`](/api/objects/collection-mint) <Badge class="secondary" text="object"/><Bullet />[`Drop`](/api/objects/drop) <Badge class="secondary" text="object"/><Bullet />[`Purchase`](/api/objects/purchase) <Badge class="secondary" text="object"/>
[`Collection`](/api/objects/collection) <Badge class="secondary" text="object"/><Bullet />[`CollectionMint`](/api/objects/collection-mint) <Badge class="secondary" text="object"/><Bullet />[`Drop`](/api/objects/drop) <Badge class="secondary" text="object"/><Bullet />[`ImportCollectionPayload`](/api/objects/import-collection-payload) <Badge class="secondary" text="object"/><Bullet />[`MintHistory`](/api/objects/mint-history) <Badge class="secondary" text="object"/>



10 changes: 10 additions & 0 deletions docs/api/enums/filter-type.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ enum FilterType {
DROP_CREATED
DROP_MINTED
MINT_TRANSFERED
COLLECTION_CREATED
MINTED_TO_COLLECTION
}
```

Expand Down Expand Up @@ -65,6 +67,14 @@ enum FilterType {
> Event triggered when a mint has been successfully transfered
>
#### [<code style={{ fontWeight: 'normal' }}>FilterType.<b>COLLECTION_CREATED</b></code>](#)
> Event triggered when a new collection is created
>
#### [<code style={{ fontWeight: 'normal' }}>FilterType.<b>MINTED_TO_COLLECTION</b></code>](#)
> Event triggered when an NFT is minted to a collection
>


### Member of
Expand Down
55 changes: 55 additions & 0 deletions docs/api/inputs/create-collection-input.mdx
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)' }}>&nbsp;&nbsp;</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"/>



4 changes: 2 additions & 2 deletions docs/api/inputs/create-drop-input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ input CreateDropInput {
startTime: DateTime
endTime: DateTime
blockchain: Blockchain!
creators: [CollectionCreatorInput!]!
creators: [CreatorInput!]!
metadataJson: MetadataJsonInput!
}
```
Expand Down Expand Up @@ -62,7 +62,7 @@ input CreateDropInput {
>
>

#### [<code style={{ fontWeight: 'normal' }}>CreateDropInput.<b>creators</b></code>](#)<Bullet />[`[CollectionCreatorInput!]!`](/api/inputs/collection-creator-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
#### [<code style={{ fontWeight: 'normal' }}>CreateDropInput.<b>creators</b></code>](#)<Bullet />[`[CreatorInput!]!`](/api/inputs/creator-input) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="input"/>
>
>

Expand Down
52 changes: 52 additions & 0 deletions docs/api/inputs/creator-input.mdx
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)' }}>&nbsp;&nbsp;</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"/>



45 changes: 45 additions & 0 deletions docs/api/inputs/import-collection-input.mdx
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)' }}>&nbsp;&nbsp;</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"/>



2 changes: 1 addition & 1 deletion docs/api/inputs/metadata-json-input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ input MetadataJsonInput {

### Member of

[`CreateDropInput`](/api/inputs/create-drop-input) <Badge class="secondary" text="input"/><Bullet />[`PatchDropInput`](/api/inputs/patch-drop-input) <Badge class="secondary" text="input"/>
[`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"/>



4 changes: 2 additions & 2 deletions docs/api/inputs/mint-drop-input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ input MintDropInput {
### Fields

#### [<code style={{ fontWeight: 'normal' }}>MintDropInput.<b>drop</b></code>](#)<Bullet />[`UUID!`](/api/scalars/uuid) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
>
> The ID of the drop to mint to
>

#### [<code style={{ fontWeight: 'normal' }}>MintDropInput.<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
>


Expand Down
67 changes: 67 additions & 0 deletions docs/api/inputs/mint-to-collection-input.mdx
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)' }}>&nbsp;&nbsp;</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"/>



50 changes: 50 additions & 0 deletions docs/api/inputs/patch-collection-input.mdx
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)' }}>&nbsp;&nbsp;</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"/>



Loading

0 comments on commit def6aae

Please sign in to comment.