Skip to main content
Version: V2

Set subscribe relationship

Subscribing to a profile means is that the user will mint an SubscribeNFT deployed by the profile (ProfileNFT) they wish to subscribe to. Implementing a subscribe option in your dApp only requires one signature & one transaction (which can be either relayed (for gasless experience) or executed directly by the user onto the contract (if you'd like the user to pay the gas).

Workflow​

caution

All typedData mutations require an Authorization header with the Bearer token. You can learn how to get a bearer token in the User Login section.

1. Generate Typed Data​

First, data should be presented to the user in a readable format when signing from the wallet. To do that you’ll need to call the createSubscribeTypedData API that takes care of this.

If you’re unfamiliar with typed data, you can read more about it here.

2. Get User Signature ✍️​

Once you received data in a readable format, you’ll need to get the user’s signature (eth_signTypedData_v4) for it. Basically, you’ll need to write a function and pass it a message as a param and return the signature that is necessary for the next step.

Ethers library is one option that can quickly help you write a function to get the user’s signature for a specific message. In this our case the message represents the typed data from step 1.

3. Call relay and get relayActionID​

caution

In order to call the relay mutation, you must include your X-API-KEY in the header. You can learn more about how to get one here.

You’ll have to call the relay API that will broadcast the transaction and mint the subscribe NFT, you will need to put as params the typedDataID you received from createSubscribeTypedData mutation call and the user's signature.

4. Call relayActionStatus to receive txHash​

Finally you poll the relayActionStatus API using the relayActionId returned from the previous step to get the status of the related transaction. There are three possible response types:

  1. RelayActionStatusResult
  2. RelayActionQueued
  3. RelayActionError

You can now verify the transaction by looking up the txHash from the response on bscscan. That’s it! You’re all done!

Designed by