Transfer / Accept collection ownership

What you'll need:

• An Enjin Platform Account.
• If you are transferring collection ownership, you also need to own a Collection.

Collection ownership on the Enjin Blockchain grants specific permissions and control over a collection and its tokens. The collection owner is the only account authorized to make changes to the collection or any tokens within it. This includes the exclusive ability to mint new tokens or mint additional supply of existing tokens in the collection.

Transferring collection ownership is a two-step process: the current owner submits a transfer request, and the new owner accepts it.

SDKs are not yet available

The C# and C++ SDK examples below are out of date and will not work against the current Enjin Platform API. This section will be updated once new SDKs are published. Until then, use the GraphQL, cURL, Javascript, Node.js, or Python examples.

Step #1: Sending a transfer ownership request with the Enjin API

To send a transfer ownership request, use the mutateCollection discriminator action on CreateTransaction and set the owner field to the new owner's address:

GraphQL

mutation SendTransferOwnershipRequest {
  CreateTransaction(
    network: ENJIN  # or CANARY for testnet
    chain: MATRIX
    transaction: {
      mutateCollection: {
        collectionId: 36105
        owner: "cxLU94nRz1en6gHnXnYPyTdtcZZ9dqBasexvexjArj4V1Qr8f"
      }
    }
  ) {
    uuid
    action
    state
  }
}

cURL

curl --location 'https://platform.beta.enjin.io/graphql' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-d '{"query":"mutation SendTransferOwnershipRequest($collectionId: BigInt!, $newOwner: String!) {\r\n  CreateTransaction(\r\n    network: ENJIN\r\n    chain: MATRIX\r\n    transaction: { mutateCollection: { collectionId: $collectionId, owner: $newOwner } }\r\n  ) {\r\n    uuid\r\n    action\r\n    state\r\n  }\r\n}","variables":{"collectionId":36105,"newOwner":"cxLU94nRz1en6gHnXnYPyTdtcZZ9dqBasexvexjArj4V1Qr8f"}}'

c# SDK

using System.Text.Json;
using Enjin.Platform.Sdk;

// Set up the collection mutation input.
var collectionMutationInput = new CollectionMutationInput()
    .SetOwner("cxLU94nRz1en6gHnXnYPyTdtcZZ9dqBasexvexjArj4V1Qr8f"); // Set the new owner account of the collection.

// Set up the mutation
var mutateCollection = new MutateCollection()
    .SetCollectionId(36105) // Specify the collection ID.
    .SetMutation(collectionMutationInput); // Specify the mutation input.

// Define and assign the return data fragment to the mutation
var transactionFragment = new TransactionFragment()
    .WithId()
    .WithMethod()
    .WithState();

mutateCollection.Fragment(transactionFragment);

// Create and auth a client to send the request to the platform
var client = PlatformClient.Builder()
    .SetBaseAddress("https://platform.beta.enjin.io")
    .Build();
client.Auth("Your_Platform_Token_Here");

// Send the request and write the output to the console.
// Only the fields that were requested in the fragment will be filled in,
// other fields which weren't requested in the fragment will be set to null.
var response = await client.SendMutateCollection(mutateCollection);
Console.WriteLine(JsonSerializer.Serialize(response.Result.Data));

C++ SDK

Work in progress

Javascript

fetch('https://platform.beta.enjin.io/graphql', {
  method: 'POST',
  headers: {'Content-Type': 'application/json','Authorization': 'Bearer YOUR_API_TOKEN'},
  body: JSON.stringify({
    query: `
      mutation SendTransferOwnershipRequest($collectionId: BigInt!, $newOwner: String!) {
        CreateTransaction(
          network: ENJIN
          chain: MATRIX
          transaction: {
            mutateCollection: {
              collectionId: $collectionId
              owner: $newOwner
            }
          }
        ) {
          uuid
          action
          state
        }
      }
    `,
    variables: {
      collectionId: 36105,
      newOwner: "cxLU94nRz1en6gHnXnYPyTdtcZZ9dqBasexvexjArj4V1Qr8f"
    }
  }),
})
.then(response => response.json())
.then(data => console.log(data));

Node.js

const axios = require('axios');

axios.post('https://platform.beta.enjin.io/graphql', {
  query: `
    mutation SendTransferOwnershipRequest($collectionId: BigInt!, $newOwner: String!) {
      CreateTransaction(
        network: ENJIN
        chain: MATRIX
        transaction: {
          mutateCollection: {
            collectionId: $collectionId
            owner: $newOwner
          }
        }
      ) {
        uuid
        action
        state
      }
    }
  `,
  variables: {
    collectionId: 36105,
    newOwner: "cxLU94nRz1en6gHnXnYPyTdtcZZ9dqBasexvexjArj4V1Qr8f"
  }
}, {
  headers: {'Content-Type': 'application/json','Authorization': 'Bearer YOUR_API_TOKEN'}
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

Python

import requests

query = '''
mutation SendTransferOwnershipRequest($collectionId: BigInt!, $newOwner: String!) {
  CreateTransaction(
    network: ENJIN
    chain: MATRIX
    transaction: {
      mutateCollection: {
        collectionId: $collectionId
        owner: $newOwner
      }
    }
  ) {
    uuid
    action
    state
  }
}
'''

variables = {
  'collectionId': 36105,
  'newOwner': 'cxLU94nRz1en6gHnXnYPyTdtcZZ9dqBasexvexjArj4V1Qr8f'
}

response = requests.post('https://platform.beta.enjin.io/graphql',
  json={'query': query, 'variables': variables},
  headers={'Content-Type': 'application/json', 'Authorization': 'Bearer YOUR_API_TOKEN'}
)
print(response.json())

Once the transaction is confirmed, the new owner needs to approve the ownership transfer request for the collection ownership to actually move.

Cancelling a pending transfer

If you need to undo a pending transfer before the new owner has accepted it, submit a cancelCollectionTransfer action with the same collection id:

mutation CancelTransferOwnershipRequest {
  CreateTransaction(
    network: ENJIN
    chain: MATRIX
    transaction: {
      cancelCollectionTransfer: { id: 36105 }
    }
  ) {
    uuid
    action
    state
  }
}

Step #2: Accepting a transfer ownership request with the Enjin API

To accept a transfer ownership request, the new owner calls the acceptCollectionTransfer discriminator action with the collection's id:

GraphQL

mutation AcceptTransferOwnershipRequest {
  CreateTransaction(
    network: ENJIN  # or CANARY for testnet
    chain: MATRIX
    transaction: {
      acceptCollectionTransfer: { id: 36105 }
    }
  ) {
    uuid
    action
    state
  }
}

cURL

curl --location 'https://platform.beta.enjin.io/graphql' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-d '{"query":"mutation AcceptTransferOwnershipRequest($id: BigInt!) {\r\n  CreateTransaction(\r\n    network: ENJIN\r\n    chain: MATRIX\r\n    transaction: { acceptCollectionTransfer: { id: $id } }\r\n  ) {\r\n    uuid\r\n    action\r\n    state\r\n  }\r\n}","variables":{"id":36105}}'

c# SDK

using System.Text.Json;
using Enjin.Platform.Sdk;

// Set up the mutation
var acceptCollectionTransfer = new AcceptCollectionTransfer()
    .SetCollectionId(36105); // Specify the collection ID.

// Define and assign the return data fragment to the mutation
var transactionFragment = new TransactionFragment()
    .WithId()
    .WithMethod()
    .WithState();

acceptCollectionTransfer.Fragment(transactionFragment);

// Create and auth a client to send the request to the platform
var client = PlatformClient.Builder()
    .SetBaseAddress("https://platform.beta.enjin.io")
    .Build();
client.Auth("Your_Platform_Token_Here");

// Send the request and write the output to the console.
// Only the fields that were requested in the fragment will be filled in,
// other fields which weren't requested in the fragment will be set to null.
var response = await client.SendAcceptCollectionTransfer(acceptCollectionTransfer);
Console.WriteLine(JsonSerializer.Serialize(response.Result.Data));

C++ SDK

Work in progress

Javascript

fetch('https://platform.beta.enjin.io/graphql', {
  method: 'POST',
  headers: {'Content-Type': 'application/json','Authorization': 'Bearer YOUR_API_TOKEN'},
  body: JSON.stringify({
    query: `
      mutation AcceptTransferOwnershipRequest($id: BigInt!) {
        CreateTransaction(
          network: ENJIN
          chain: MATRIX
          transaction: {
            acceptCollectionTransfer: { id: $id }
          }
        ) {
          uuid
          action
          state
        }
      }
    `,
    variables: { id: 36105 }
  }),
})
.then(response => response.json())
.then(data => console.log(data));

Node.js

const axios = require('axios');

axios.post('https://platform.beta.enjin.io/graphql', {
  query: `
    mutation AcceptTransferOwnershipRequest($id: BigInt!) {
      CreateTransaction(
        network: ENJIN
        chain: MATRIX
        transaction: {
          acceptCollectionTransfer: { id: $id }
        }
      ) {
        uuid
        action
        state
      }
    }
  `,
  variables: { id: 36105 }
}, {
  headers: {'Content-Type': 'application/json','Authorization': 'Bearer YOUR_API_TOKEN'}
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

Python

import requests

query = '''
mutation AcceptTransferOwnershipRequest($id: BigInt!) {
  CreateTransaction(
    network: ENJIN
    chain: MATRIX
    transaction: {
      acceptCollectionTransfer: { id: $id }
    }
  ) {
    uuid
    action
    state
  }
}
'''

variables = {'id': 36105}

response = requests.post('https://platform.beta.enjin.io/graphql',
  json={'query': query, 'variables': variables},
  headers={'Content-Type': 'application/json', 'Authorization': 'Bearer YOUR_API_TOKEN'}
)
print(response.json())

Once the transaction is confirmed, the collection ownership will be transferred to the new owner. An event is emitted on FINALIZED confirming the change — see Working with Events for how to read it.