W3Block Docs
  • 🚀Start here
    • Welcome to the Docs
    • Integrated Blockchains
  • 👨‍💻Dev Docs
    • API
      • Getting Started
      • Authentication
      • Commerce API services
        • Company Administration
          • Companies (Admin)
          • Assets (Admin)
          • Tags (Admin)
          • Products (Admin)
            • Order Rules (Admin)
          • Orders (Admin)
          • Faq (Admin)
          • Webhooks (Admin)
        • Products
        • Orders
        • Webhooks
        • Faq
        • Globals
      • Key API Services
        • Authentication
        • Companies
        • Tokens
          • Contracts
            • External Contacts
            • Royalty Eligible
          • Categories
            • Subcategories
          • Token Collections
            • Token Editions
          • Metadata
        • Blockchain
        • Cloudinary
        • Integration
          • Ecommerce
            • Associate Tokens
            • Hooks
        • Users
        • Vouchers
  • 📘Knowledge Base
    • First Steps
    • FAQ
    • Glossary
Powered by GitBook
On this page
  1. Dev Docs
  2. API
  3. Key API Services
  4. Tokens

Contracts

This module helps you administer your contracts in the blockchain

PreviousTokensNextExternal Contacts

Last updated 2 years ago

Contracts are what you use to create your tokens inside the blockchain. You can create your own contracts and use them however you like.

Service Methods

Creating a Draft

Before you do anything you need to create a draft for the contract. You will set all the parameters you will need to publishing the contract.

Get all contracts from your company

Get a contract's details

Patch a Contract Draft

Publishing a Contract

After you have created a draft you can publish the contract. Be careful as you will not be able to change the contract details after publishing it.

Estimate gas to publish a contract

Grant a wallet a role for your contract

Grant a wallets role in your contract

👨‍💻
get

Get all contract from a company

Authorizations
Path parameters
companyIdstringrequired
Query parameters
pagenumberoptionalDefault: 1
limitnumberoptionalDefault: 1000
searchstringoptional
sortBystringoptional
orderBystring · enumoptionalDefault: DESCAvailable options:
statusstring · enumoptionalAvailable options:
contractNamestringoptional
minDatestringoptionalExample: 2022-02-15T10:30:05-03:00
maxDatestringoptionalExample: 2022-02-15T10:30:05-03:00
contactIdstringoptional
participantNamestringoptional
walletAddressesstring[]optional
Responses
application/json
get
curl -L \
  --url '/{companyId}/contracts' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
200
401
{
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  },
  "links": {
    "first": "http://example.com?page=1",
    "prev": "http://example.com?page=1",
    "next": "http://example.com?page=2",
    "last": "http://example.com?page=3"
  },
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "royalty": {},
      "royaltyId": "123e4567-e89b-12d3-a456-426614174000",
      "address": "text",
      "chainId": 1,
      "name": "text",
      "symbol": "text",
      "description": "text",
      "image": "text",
      "externalLink": "text",
      "operators": [
        "text"
      ],
      "roles": [
        []
      ],
      "status": "draft",
      "contractAction": {
        "id": "text",
        "companyId": "text",
        "status": "started",
        "type": "factoryERC721A",
        "chainId": 80001,
        "sender": "text",
        "txHash": "text",
        "txId": "text",
        "metadata": {},
        "request": {},
        "executeAt": "2025-04-10T15:37:06.321Z",
        "deletedAt": "2025-04-10T15:37:06.321Z",
        "createdAt": "2025-04-10T15:37:06.321Z",
        "updatedAt": "2025-04-10T15:37:06.321Z"
      },
      "contractActionId": "text",
      "features": [
        "admin:minter"
      ],
      "deletedAt": "2025-04-10T15:37:06.321Z",
      "createdAt": "2025-04-10T15:37:06.321Z",
      "updatedAt": "2025-04-10T15:37:06.321Z",
      "transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
      "minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
      "maxSupply": 1
    }
  ]
}
get

Get a contract by id

Authorizations
Path parameters
idstringrequired
companyIdstringrequired
Responses
application/json
get
curl -L \
  --url '/{companyId}/contracts/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
200
401
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "royalty": {},
  "royaltyId": "123e4567-e89b-12d3-a456-426614174000",
  "address": "text",
  "chainId": 1,
  "name": "text",
  "symbol": "text",
  "description": "text",
  "image": "text",
  "externalLink": "text",
  "operators": [
    "text"
  ],
  "roles": [
    []
  ],
  "status": "draft",
  "contractAction": {
    "id": "text",
    "companyId": "text",
    "status": "started",
    "type": "factoryERC721A",
    "chainId": 80001,
    "sender": "text",
    "txHash": "text",
    "txId": "text",
    "metadata": {},
    "request": {},
    "executeAt": "2025-04-10T15:37:06.321Z",
    "deletedAt": "2025-04-10T15:37:06.321Z",
    "createdAt": "2025-04-10T15:37:06.321Z",
    "updatedAt": "2025-04-10T15:37:06.321Z"
  },
  "contractActionId": "text",
  "features": [
    "admin:minter"
  ],
  "deletedAt": "2025-04-10T15:37:06.321Z",
  "createdAt": "2025-04-10T15:37:06.321Z",
  "updatedAt": "2025-04-10T15:37:06.321Z",
  "transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
  "minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
  "maxSupply": 1
}
patch

Publish a contract on the blockchain

Authorizations
Path parameters
idstringrequired
companyIdstringrequired
Responses
patch
curl -L \
  --request PATCH \
  --url '/{companyId}/contracts/{id}/publish' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
204
401
No Content
get

Estimate gas to publish a contract

Authorizations
Path parameters
idstringrequired
companyIdstringrequired
Responses
application/json
get
curl -L \
  --url '/{companyId}/contracts/{id}/estimate-gas' \
  --header 'x-w3block-api-key: YOUR_API_KEY'
200
401
{
  "totalGas": 1,
  "totalGasPrice": {
    "safe": "text",
    "proposed": "text",
    "fast": "text"
  }
}
  • Service Methods
  • Creating a Draft
  • POST/{companyId}/contracts
  • Get all contracts from your company
  • GET/{companyId}/contracts
  • Get a contract's details
  • GET/{companyId}/contracts/{id}
  • Patch a Contract Draft
  • PATCH/{companyId}/contracts/{id}
  • Publishing a Contract
  • PATCH/{companyId}/contracts/{id}/publish
  • Estimate gas to publish a contract
  • GET/{companyId}/contracts/{id}/estimate-gas
  • Grant a wallet a role for your contract
  • PATCH/{companyId}/contracts/grant-role
  • Grant a wallets role in your contract
  • PATCH/{companyId}/contracts/has-role
post

Create a new contract draft

Authorizations
Path parameters
companyIdstringrequired
Body
namestringrequiredExample: Contract Example
symbolstringrequiredExample: CE
chainIdstring · enumrequiredDefault: 1Example: 1Available options:
descriptionobjectoptional
imageobjectoptionalExample: https://dummyimage.com/600x400/fff/000
externalLinkobjectoptionalExample: https://stg.pixway.io
participantsobject[]required

featuresstring · enum[]optionalExample: ["admin:mover","admin:minter","admin:burner","user:burner","user:mover"]

transferWhitelistIdobject · uuidoptional
minterWhitelistIdobject · uuidoptional
Responses
application/json
post
curl -L \
  --request POST \
  --url '/{companyId}/contracts' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Contract Example",
    "symbol": "CE",
    "chainId": 1,
    "description": {},
    "image": "https://dummyimage.com/600x400/fff/000",
    "externalLink": "https://stg.pixway.io",
    "participants": [
      {
        "contactId": null,
        "share": 2.5,
        "name": "Participant 1",
        "payee": "0x095358452C33916513a3827a2D086da1aCEd7EE0"
      }
    ],
    "features": [
      "admin:mover",
      "admin:minter",
      "admin:burner",
      "user:burner",
      "user:mover"
    ],
    "transferWhitelistId": {},
    "minterWhitelistId": {}
  }'
201
401
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "royalty": {},
  "royaltyId": "123e4567-e89b-12d3-a456-426614174000",
  "address": "text",
  "chainId": 1,
  "name": "text",
  "symbol": "text",
  "description": "text",
  "image": "text",
  "externalLink": "text",
  "operators": [
    "text"
  ],
  "roles": [
    []
  ],
  "status": "draft",
  "contractAction": {
    "id": "text",
    "companyId": "text",
    "status": "started",
    "type": "factoryERC721A",
    "chainId": 80001,
    "sender": "text",
    "txHash": "text",
    "txId": "text",
    "metadata": {},
    "request": {},
    "executeAt": "2025-04-10T15:37:06.321Z",
    "deletedAt": "2025-04-10T15:37:06.321Z",
    "createdAt": "2025-04-10T15:37:06.321Z",
    "updatedAt": "2025-04-10T15:37:06.321Z"
  },
  "contractActionId": "text",
  "features": [
    "admin:minter"
  ],
  "deletedAt": "2025-04-10T15:37:06.321Z",
  "createdAt": "2025-04-10T15:37:06.321Z",
  "updatedAt": "2025-04-10T15:37:06.321Z",
  "transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
  "minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
  "maxSupply": 1
}
patch

Update a draft contract by id

Authorizations
Path parameters
idstringrequired
companyIdstringrequired
Body
namestringoptionalExample: Contract Example
symbolstringoptionalExample: CE
chainIdstring · enumoptionalDefault: 1Example: 1Available options:
descriptionobjectoptional
imageobjectoptionalExample: https://dummyimage.com/600x400/fff/000
externalLinkobjectoptionalExample: https://stg.pixway.io
participantsobject[]optional

featuresstring · enum[]optionalExample: ["admin:mover","admin:minter","admin:burner","user:burner","user:mover"]

transferWhitelistIdobject · uuidoptional
minterWhitelistIdobject · uuidoptional
Responses
application/json
patch
curl -L \
  --request PATCH \
  --url '/{companyId}/contracts/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Contract Example",
    "symbol": "CE",
    "chainId": 1,
    "description": {},
    "image": "https://dummyimage.com/600x400/fff/000",
    "externalLink": "https://stg.pixway.io",
    "participants": [
      {
        "contactId": null,
        "share": 2.5,
        "name": "Participant 1",
        "payee": "0x095358452C33916513a3827a2D086da1aCEd7EE0"
      }
    ],
    "features": [
      "admin:mover",
      "admin:minter",
      "admin:burner",
      "user:burner",
      "user:mover"
    ],
    "transferWhitelistId": {},
    "minterWhitelistId": {}
  }'
200
401
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "royalty": {},
  "royaltyId": "123e4567-e89b-12d3-a456-426614174000",
  "address": "text",
  "chainId": 1,
  "name": "text",
  "symbol": "text",
  "description": "text",
  "image": "text",
  "externalLink": "text",
  "operators": [
    "text"
  ],
  "roles": [
    []
  ],
  "status": "draft",
  "contractAction": {
    "id": "text",
    "companyId": "text",
    "status": "started",
    "type": "factoryERC721A",
    "chainId": 80001,
    "sender": "text",
    "txHash": "text",
    "txId": "text",
    "metadata": {},
    "request": {},
    "executeAt": "2025-04-10T15:37:06.321Z",
    "deletedAt": "2025-04-10T15:37:06.321Z",
    "createdAt": "2025-04-10T15:37:06.321Z",
    "updatedAt": "2025-04-10T15:37:06.321Z"
  },
  "contractActionId": "text",
  "features": [
    "admin:minter"
  ],
  "deletedAt": "2025-04-10T15:37:06.321Z",
  "createdAt": "2025-04-10T15:37:06.321Z",
  "updatedAt": "2025-04-10T15:37:06.321Z",
  "transferWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
  "minterWhitelistId": "123e4567-e89b-12d3-a456-426614174000",
  "maxSupply": 1
}
patch

Grant role by wallet address in an NFT contract

Authorizations
Path parameters
companyIdstringrequired
Body
addressstringrequiredExample: 0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188
chainIdstring · enumrequiredDefault: 1Example: 1Available options:
rolestring · enumrequiredDefault: moverExample: moverAvailable options:
contractAddressstringrequiredExample: 0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188
Responses
patch
curl -L \
  --request PATCH \
  --url '/{companyId}/contracts/grant-role' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188",
    "chainId": 1,
    "role": "mover",
    "contractAddress": "0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188"
  }'
204
401
No Content
patch

Check address role

Authorizations
Path parameters
companyIdstringrequired
Body
addressstringrequiredExample: 0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188
chainIdstring · enumrequiredDefault: 1Example: 1Available options:
rolestring · enumrequiredDefault: moverExample: moverAvailable options:
contractAddressstringrequiredExample: 0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188
Responses
application/json
patch
curl -L \
  --request PATCH \
  --url '/{companyId}/contracts/has-role' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188",
    "chainId": 1,
    "role": "mover",
    "contractAddress": "0xDAA50a02340cBcFA1a6F4c02765430Ffe411b188"
  }'
200
401
{
  "hasRole": true
}