The STACS Platform Suite comprises of 2 platforms
\nThis 1-stop service provides API access to both the STACS Blockchain and the key management infrastructure required for managing wallets and authenticating transactions on the blockchain.
\nBoth platforms are using OAuth2.0 Authorization Code Grant for authentication and authorization.\nThe authorization code flow is a 3-legged configuration where the end user is provided with an authorization code that is exchanged for an access token.\nMore details can be found on the OAuth security setup from this AWS Cognito article.
\nThe STACS Managed Account Service (KMS) is a cloud-based user account and private key management solution that enables easy interaction with the STACS Blockchain platform. \nUser accounts can be created and mapped to multiple wallets belonging to the same user.
\nSignature generation from a user wallet is also managed by the Account Service and is mandatory when interfacing with the STACS Blockchain for authentication and authorization.
\nSignatures can be generated by sending the txData payload of the blockchain API to the /KMSService/sign endpoint which returns the txSignature field.
A wallet comprises of an asymmetric key-pair which has a public key and a private key. \nThe STACS Managed Account Service leverages on the security and resiliency of AWS KMS to manage the full lifecycle of private keys ranging from key creation to signature generation.
\nAPIs listed here also provide a simple way to manage accounts with AWS Cognito. Private keys are safely kept within AWS KMS where they are never exposed.\nEach account created is able to support multiple wallet addresess and corresponding private keys (32-byte string of random characters).
\nPrivate keys for the STACS Blockchain are created using the the Elliptic Curve Digital Signature Algorithm (ECDSA) which utlizes the secp256k1 algorithm provided by AWS KMS.
\nSignatures for API requests sent to the STACS blockchain are generated with the /KMSService/sign endpoint for registered users. The payload sent to this endpoint is the entire txData payload for relevant Blockchain APIs and the txSignature field is returned synchronously to be combined with the txData as a JSON field for submission to the STACS Blockchain platform.
\nNote that user creation requires an admin role user that is not part of the scope of these APIs.
\nThe STACS Managed Account Service will be available in the future as a simple AWS deployment package that you could setup within your AWS environment.
\nThe STACS Blockchain Platform is a private permissioned network running on the STACS Blockchain technology (Enhanced Ethereum).
\nWhile the STACS Blockchain utilizes the standard Ethereum Virtual Machine (EVM), enhancements have been made to core layers ranging from Consensus (removal of the energy intensive Proof of Work), addition of an Access Control Management layer and On-Chain Functions which offload complex processing from the smart contract layer into the node.
\nSolidity Smart Contracts can be deployed as is on the STACS Blockchain with the highest supported version of Solidity being 0.7.9.
\nAsynchronous callbacks are also supported where confirmation of transactions on the blockchain are sent to the registered subscribers.
\nOnce you have secured the components as stated in the Pre-requisite section, you can test connectivity by calling the endpoint /block/latestHeight.\nA HTTP 200 response with the latest block number in the Studios environment reflected indicates that your setup is successful.
The STACS Blockchain implements an Access Control layer where you are first required to create
\nOnce the Access Control layer elements have been created, you can proceed to deploy the smart contract template code to the blockchain. \nFor future deployments of the same smart contract template code, you may reuse the same Wallet Permission Tags and SCA.
\nYou will need to define 1 or more Wallet Permission Tags that indicate a group of wallet addresses are eligible to interact with the functions of the smart contract code you are about to deploy.
\n/nodefunction/permission./nodefunction/permission/walletAddress/add./nodefunction/permission/walletAddressSmart Contract code is uploaded to the node directly by node operators and provided as templates for API users.
\n/smartcontracts/templates and note down the templateId/smartcontracts/contracts/{templateId} for later use.SCA definition requires a wallet permission tag to be pre-created and the list of public functions of the smart contract template you are deploying.\nYou may leave the Policy field blank to utilize the default Network Governance Policy setting.
\n/nodefunction/contractAccess to create a SCA template and note down the scaId/nodefunction/contractAccess/confirmationThis newly created SCA can be reused for deploying smart contracts of the same template.
\nAs you have selected your smart contract in the previous step and noted down the template Id, construct the request field according to your needs.
\n/smartcontracts/create to deploy the smart contract code template with your SCA/smartcontracts/create/confirmationCongratulations!
\nYou have deployed your first smart contract!
\nTo interact with your smart contract, proceed to use either the /smartcontracts/invoke endpoint to update the smart contract state (e.g. transfer of tokens) or the /smartcontracts/query to retrieve the latest smart contract state details (e.g. wallet balance).
Each platform will require its own API Key and OAuth2.0 setup on your end.
\nThe API Key will be required to be submitted in the header as 'x-api-key'\nFor OAuth2.0, you will need:
\nPlease contact us at info@stacs.io for more information on the onboarding process for the Studios Environment.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11548940","collectionId":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","publishedId":"UVyxRE45","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-05-13T06:56:57.000Z"},"item":[{"name":"User","item":[{"name":"/user - create new user","id":"aa62b0de-ebb8-4447-be6d-1c53dcbae1dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"(Required) API key is required for all API requests on top of OAuth2.0
\n","key":"x-api-key","value":"e399d80b-ab6d-40c0-6909-6a03910c9f6e"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"xyz@email.com\",\n \"username\": \"test_user\",\n \"initialPassword\": \"$]$rfOuKnyOt>\"\n}","options":{"raw":{"language":"json"}}},"url":"https://kmsservice-studios.stacs.io/KMSService/user","description":"For administrators only - create new user in a managed AWS Cognito user pool
\n","urlObject":{"protocol":"https","path":["KMSService","user"],"host":["kmsservice-studios","stacs","io"],"query":[],"variable":[]}},"response":[{"id":"21b0ea71-b37e-467e-9d10-2646b0210286","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"A user is created and managed in AWS Cognito that can contain multiple wallet addresses.
\nEach wallet address has a private key that is generated from within AWS KMS and safekept within AWS KMS throughout the entire lifecycle.
\n","_postman_id":"ecf78f04-ef5d-4b36-8522-de5729834972","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Wallet","item":[{"name":"/user/walletAddress - create new Wallet Address","id":"bd853f43-f777-44ca-a9e3-3dc9fa0985db","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"(Required) API key is required for all API requests on top of OAuth2.0
\n","key":"x-api-key","value":"e399d80b-ab6d-40c0-6909-6a03910c9f6e"},{"key":"Accept","value":"application/json"}],"url":"https://kmsservice-studios.stacs.io/KMSService/user/walletAddress","description":"create new wallet address and generate private key in AWS KMS
\n","urlObject":{"protocol":"https","path":["KMSService","user","walletAddress"],"host":["kmsservice-studios","stacs","io"],"query":[],"variable":[]}},"response":[{"id":"0f640f01-753e-453a-9a0c-4bb6fb7793ff","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"(Required) API key is required for all API requests on top of OAuth2.0
\n","key":"x-api-key","value":"e399d80b-ab6d-40c0-6909-6a03910c9f6e"},{"key":"Accept","value":"application/json"}],"url":"https://kmsservice-studios.stacs.io/KMSService/user/walletAddress","description":"get all wallet addresses belonging to the user
\n","urlObject":{"protocol":"https","path":["KMSService","user","walletAddress"],"host":["kmsservice-studios","stacs","io"],"query":[],"variable":[]}},"response":[{"id":"98bcbeb6-5a0d-4653-81e4-edb91a8adaf5","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Each user can have multiple wallet addresses.
\nCreation of new wallet address is specified here as well as the retrieval of all wallet addresses.
\n","_postman_id":"67f6dab1-3099-40e5-9629-f5e20ad9a7e4","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Signing","item":[{"name":"/sign - create signature","id":"3a82e19f-97b4-4841-a943-5cfe121e0715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"description":"(Required) API key is required for all API requests on top of OAuth2.0
\n","key":"x-api-key","value":"e399d80b-ab6d-40c0-6909-6a03910c9f6e"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"payload\": \"nulla\",\n \"wallet\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\"\n}","options":{"raw":{"language":"json"}}},"url":"https://kmsservice-studios.stacs.io/KMSService/sign","description":"create signature using private key stored in KMS with payload
\n","urlObject":{"protocol":"https","path":["KMSService","sign"],"host":["kmsservice-studios","stacs","io"],"query":[],"variable":[]}},"response":[{"id":"661b1054-eb79-43cf-8ee0-f9fc09881adb","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"In order to authorize transactions, API calls to the STACS blockchain must be signed.
\nThis API serves to create signatures using the private key stored in AWS KMS.
\n","_postman_id":"741a9214-c4c6-4c1e-a9cf-1285c824c067","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Block","item":[{"name":"/block/latestHeight - get latest block height","id":"1488c067-c453-44ef-821d-569ae32e111e","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://studios-api.stacs.io/chain/node-a/block/latestHeight","description":"retrieves the latest confirmed block height number from the blockchain
\n","urlObject":{"path":["block","latestHeight"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"5d8adda3-daac-4870-8c8f-faac01d445f5","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"48ed49f7-05c4-420a-bb83-0aaaddc5bba9","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"retrieves all transactions and their details within the specified block height
\n","urlObject":{"path":["block","transactions"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"8d727b58-1341-464c-83b1-bcd632240933","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"dd877d23-8f3b-4cb0-8465-7b045d51ee47","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"retrieves all block headers which does not contain detailed information for each block
\n","urlObject":{"path":["block","headers"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[{"description":{"content":"Number of items to skip before returning the results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Maximum number of items to return.
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"sorting order by timestamp, either ascending (ASC) or descending (DESC). defaults to DESC if unspecified.
\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[{"id":"c57ad5a0-3779-47d9-b083-054e86d28a5f","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"42da478d-7b75-4cc6-ba51-c3737364f472","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"retrieves all transaction headers
\n","urlObject":{"path":["transactions","headers"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[{"description":{"content":"Number of items to skip before returning the results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Maximum number of items to return.
\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"sorting order by timestamp, either ascending (ASC) or descending (DESC). defaults to DESC if unspecified.
\n","type":"text/plain"},"key":"order","value":"desc"}],"variable":[{"id":"7ba8c7b1-14d5-4745-a9f5-fadb4f265231","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"557ac9d1-1b0a-4b8d-8e29-2053f9669501","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Transactions are hashed into a block on the STACS Blockchain. API calls to block-level information is provided here.
\n","_postman_id":"7fb00ba3-f8e7-4ecb-883a-496fa1dd6b3f","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Transaction","item":[{"name":"/transactions - get details of a transaction by txId","id":"3f8bc6bc-d22a-4beb-9640-4d828db78fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"txData\": {\n \"submitterAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\",\n \"submitterTimestamp\": \"1984-04-17T10:15:07.468Z\",\n \"txId\": \"000001787d889b5fcd610266208411895b8b3d19\"\n },\n \"txSignature\": \"00c2494600d72bbc7dd3f71dc1710308e561d4cce2de579f3046399d0046f4832f503894a2271bdfc49e2e318f5bb3ee98cdfbfc730bcb5ce9051c50ffba5a940d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://studios-api.stacs.io/chain/node-a/transactions","description":"Retrieves details of a single transaction based on txId.\nFor APIs that return a txId in their response, this endpoint can be called in a polling fashion to confirm the state of the transaction and block on the blockchain.
\nThe callback setup will return messages following the same data format specified in this endpoint.
\n","urlObject":{"path":["transactions"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"3914aec5-35e9-4c40-ab0f-c79b477cc28d","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"83e1e22d-f3de-414a-8925-b1273c0f56b3","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"retrieves all transactions and their details based on a specified wallet address
\n","urlObject":{"path":["transactions","wallet"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"5d0e21a5-5b8d-48c3-8965-920c59eb1a9e","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"7a2dd830-1091-4197-a2b9-bc5ce8319b35","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"retrieves all transactions and their details belonging to a contract address
\n","urlObject":{"path":["transactions","contract"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"b93255e0-eaa0-42f0-acd8-0d1b25a59c41","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"bea81a7b-f086-4449-9f0a-0dc71e159844","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Smart Contract actions and node functions such as Wallet Profile Identity are recorded and hashed on the STACS Blockchain as a Transaction. \nAPI calls involving Transaction-level information is provided here.
\n","_postman_id":"57ff14db-6ed3-4d43-8ba9-4bf090b4d0ae","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Node and Network","item":[{"name":"/node/status - get status of the node","id":"174e5d9b-bf83-447b-b8aa-bb374c5089d1","request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://studios-api.stacs.io/chain/node-a/node/status","description":"get the status of the blockchain node
\n","urlObject":{"path":["node","status"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"965bf447-487c-4667-9847-78de2acad5bc","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"ac2ca18b-4127-456a-a5f3-188771064c6c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"get the state of all nodes and their domains (organizations) from within the permissioned network.
\n","urlObject":{"path":["node","gatekeeper"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"b2bd46de-d084-40b5-afef-0e0fdb0c7914","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"3417b37f-09d9-4b6c-9307-d822f186c3a7","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Generic node and permissioned network details can be obtained through API calls listed here.
\n","_postman_id":"6423fc6b-5a1c-4a8d-822b-0a5369aaa109","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Smart Contract","item":[{"name":"/smartcontracts/contracts - get contracts used by wallet address","id":"4cbb2098-9364-483b-87d2-287863193374","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"txData\": {\n \"submitterAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\",\n \"submitterTimestamp\": \"1990-05-11T13:40:35.882Z\",\n \"walletAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\",\n \"offsetParam\": 0,\n \"limitParam\": 20,\n \"orderParam\": \"DESC\"\n },\n \"txSignature\": \"00c2494600d72bbc7dd3f71dc1710308e561d4cce2de579f3046399d0046f4832f503894a2271bdfc49e2e318f5bb3ee98cdfbfc730bcb5ce9051c50ffba5a940d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://studios-api.stacs.io/chain/node-a/smartcontracts/contracts","description":"retrieves all contracts and their details based on a specified wallet address
\n","urlObject":{"path":["smartcontracts","contracts"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"c648a48a-0f53-42da-977b-33c01a055d84","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"807c7b97-e65a-4ae1-b7a1-cf4467db788f","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"gets all invocable functions within the smart contract template, can be used to create new Smart Contract Access.
\n","urlObject":{"path":["smartcontracts","contracts",":templateId"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"8790b4cc-74b3-4e13-a8bf-48a7065d88f3","description":{"content":"(Required) templateId of the smart contract to be deployed
\n","type":"text/plain"},"type":"any","value":"m","key":"templateId"},{"id":"5ee6b85e-0422-4a4f-9fd1-0f4fe543edb9","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"b927fb0a-93aa-457f-bb83-3d43482a5b79","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"retrieves all smart contract templates stored locally on the specified node. Smart Contract Solidity code is uploaded to the node and made available as templates for use via this API.
\n","urlObject":{"path":["smartcontracts","templates"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[{"description":{"content":"Number of items to skip before returning the results.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Maximum number of items to return.
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[{"id":"8819a706-56ef-488f-a6de-f300cc86afe4","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"67614cd9-861a-40bb-ab8a-d130643c32fd","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Create smart contract instance and deploys onto the chain, includes minting a brand new token and deploying a contract on the blockchain.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"dc0e329b-53db-4d37-a4cb-cbcbf2d04895","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Create smart contract instance and deploys onto the chain, includes minting a brand new token and deploying a contract on the blockchain.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"1cab64fc-9fde-490a-8368-9c1ec1d339ed","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Create smart contract instance and deploys onto the chain, includes minting a brand new token and deploying a contract on the blockchain.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"85d54dd6-5b0c-4e5e-a80e-550461ff1d2d","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Invoke specific functions that changes state of a smart contract based on contract address.
\nThe STACS blockchain enables smart contract code to conduct validation checks against Wallet Profile Identities recorded on the chain.\nValidation check will require custom code within the smart contract to be executed.
\nValidation checks are specified in the API call using the validateConditions attribute which specifies the index position of the validation input argument within the functionParameters field.
\nValidation Check Example:
\nThe smart contract input parameter should take in EL expressions that enable conditional checks against the Wallet Profile Identity.
\nThe following is an example of just such a conditional check:eq(country:[Singapore]) AND ( lt(rating:[3]) OR eq(type:[accredited]) )
The above validation check would be successful for the following Wallet Profile Identities:\n{country:Singapore,rating:2,type:accredited}{country:Singapore,rating:2,type:retail}{country:Singapore,rating:5,type:accredited}
To confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"caa6dd5b-e677-45ee-924a-c2505ad88de6","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"invoke specific query (read-only) function of a smart contract based on contract address
\n","urlObject":{"path":["smartcontracts","query"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"2bd2d839-e107-4a2f-86ac-44f7d819be19","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"51b02e82-b9fb-4f6b-b702-6a43f5fac2ad","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"invoke a specific query (read-only) function that exists on multiple smart contracts instances. Main use case is to find the balance of a wallet address for all tokens held.
\n","urlObject":{"path":["smartcontracts","contracts","batchQuery"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"5b05172c-3ebc-4749-ba70-6f6041e2f30c","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"12c544eb-5d36-4fe4-976b-6a510dd4d331","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"returns true if contract symbol was previously used and recorded on the chain
\n","urlObject":{"path":["smartcontracts","valid",":contractSymbol"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"173ac525-9fe6-434c-900e-b44212acd152","description":{"content":"(Required) contract symbol on the blockchain
\n","type":"text/plain"},"type":"any","value":"m","key":"contractSymbol"},{"id":"2ceb83e6-891a-403e-98fc-8502faefa167","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"6d7a2e57-7d1b-4af1-82b2-1eb36dc48be4","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Solidity Smart Contracts run within the EVM of all nodes within the STACS Blockchain network.
\nThis section describes the generic APIs that interface with any Smart Contract. \nDeployment of smart contracts onto the chain will require Smart Contract Access (SCA) to be first defined to enforce network access control and security.
\nSpecific example usage of APIs here can apply to Smart Contract interfaces such as ERC standards.
\n","_postman_id":"3266c7bf-8448-46f4-a750-b70ba091a194","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Node On-Chain Functions","item":[],"id":"685878b3-0eff-4fd4-a0e8-9b24f3f473b5","description":"Multiple Enhanced on-chain features have been built directly into the STACS Blockchain nodes.
\nThis take advantage of the raw processing power of the node to offload generic processing work that typically rely on a smart contract at the EVM back to the node. \nThese features append information to the underlying blockchain ledger for future usage by Smart Contracts or by the network.
\nSmart Contracts can utilize the following on-chain functions such as the versatile Data Feed, SWIFT Messages for later affirmation, and Wallet Profile Identity which enables nodes to ensure compliance and pre-checks can be enforced at the node level.
\nSmart Contract Access (SCA) and Wallet Permission Tags are on-chain functions that provide Access Control and Management of the network.
\n","_postman_id":"685878b3-0eff-4fd4-a0e8-9b24f3f473b5","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Smart Contract Access (SCA)","item":[{"name":"/nodefunction/contractAccess - specify access control and permission for contract functions","id":"7dadd255-2224-48e8-92ff-17cf5a5aff9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"txData\": {\n \"scaCode\": \"APACAccess\",\n \"description\": \"contract access for erc20 for APAC region\",\n \"permission\": \"SamplePermissionTag\",\n \"functions\": [\n {\n \"functionMethod\": \"(bool) transfer(address,uint256)\",\n \"name\": \"transfer\",\n \"description\": \"Contract\",\n \"policyId\": \"DEFAULT_SYNC_POLICY\",\n \"permission\": \"SamplePermissionTag\"\n },\n {\n \"functionMethod\": \"(bool) transfer(address,uint256)\",\n \"name\": \"transfer\",\n \"description\": \"Contract\",\n \"policyId\": \"DEFAULT_SYNC_POLICY\",\n \"permission\": \"SamplePermissionTag\"\n }\n ],\n \"scaId\": \"SampleSCA\",\n \"submitterAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\",\n \"policyId\": \"DEFAULT_SYNC_POLICY\"\n },\n \"txSignature\": \"00c2494600d72bbc7dd3f71dc1710308e561d4cce2de579f3046399d0046f4832f503894a2271bdfc49e2e318f5bb3ee98cdfbfc730bcb5ce9051c50ffba5a940d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://studios-api.stacs.io/chain/node-a/nodefunction/contractAccess","description":"Granular access control and permission setting for smart contracts defined at the function level. Whitelist user groups (Permission) and set governance for each function in your smart contract.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"280d4850-745f-47b9-9025-ed736eea792b","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"get all Contract Access created by the submitter
\n","urlObject":{"path":["nodefunction","contractAccess","details"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"635621af-f14f-49ea-926f-04bf12313df6","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"66045452-1185-40d0-af9a-62c11362ed6d","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Smart Contract Access (SCA) is a granular Access Control Management feature that is required before deployment of any Smart Contract in the permissioned network.
\nFor each publicly invocable function within the Smart Contract, groups of wallet addresses that are allowed to trigger the function has to be defined using Wallet Permission Tags.
\nIf a different Network Governance Policy is required, that can be specified at the function level as well.
\nA single SCA is a template that can be reused for deployment of the same smart contract code template.
\n","_postman_id":"0d362d78-54ac-4713-a5c1-3eb611a86a97","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Wallet Permission Tag","item":[{"name":"/nodefunction/permission - create a new Permission tag","id":"7db68632-55b6-4719-a948-ad7fbf20abc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"txData\": {\n \"permissionGroupId\": \"APAC_INSTITUTIONAL\",\n \"scaId\": \"SampleSCA\",\n \"submitterAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\"\n },\n \"txSignature\": \"00c2494600d72bbc7dd3f71dc1710308e561d4cce2de579f3046399d0046f4832f503894a2271bdfc49e2e318f5bb3ee98cdfbfc730bcb5ce9051c50ffba5a940d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://studios-api.stacs.io/chain/node-a/nodefunction/permission","description":"Permission is a tag that can be mapped to multiple wallet addresses (users) It is used in Contract Access to determine if those wallet addresses are eligbile for specific smart contract functions, i.e. transfer of tokens for a whitelisted set of users.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"bd0bee82-fe27-4c9d-9c52-e87ef5628649","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Add multiple permission tags to a single wallet addresses.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"391abfae-4cdf-47d0-9c1b-c78511a27687","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Remove multiple permission tags of a single wallet addresses.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"9f056739-2041-4b32-af65-b7d48d88dc8a","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"get the latest permission tags of a wallet address
\n","urlObject":{"path":["nodefunction","permission","walletAddress"],"host":["https://studios-api.stacs.io/chain/node-a"],"query":[],"variable":[{"id":"f45dd012-f48c-4955-bb5c-da4b58c610a9","description":{"content":"(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"02244fc4-f80b-4643-a137-7d8bea9066f5","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Permission tags enable grouping of wallet profiles to be authorized for specific actions such as transfer of tokens as required in SCA.
\nWallet Permission Tags are highly versatile and can be applied in any number of scenarios such as geographic restrictions, investor accredition level, investor risk levels and many others.
\n","_postman_id":"68f686ba-bc04-4813-889d-de5a23c6748a","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Wallet Profile Identity","item":[{"name":"/nodefunction/identity - create an Identity on the chain","id":"3126c3a8-b09b-4e04-ab14-65c466cf5743","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"txData\": {\n \"walletAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\",\n \"identityType\": \"user\",\n \"profile\": \"{country:Singapore,rating:5,type:accredited}\",\n \"scaId\": \"SampleSCA\",\n \"submitterAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\"\n },\n \"txSignature\": \"00c2494600d72bbc7dd3f71dc1710308e561d4cce2de579f3046399d0046f4832f503894a2271bdfc49e2e318f5bb3ee98cdfbfc730bcb5ce9051c50ffba5a940d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://studios-api.stacs.io/chain/node-a/nodefunction/identity","description":"Create an Identity on the chain for a single wallet address with information for smart contracts to evaluate if a function should execute successfully, i.e. transfer of tokens.
\nThe profile attribute defined in the Request body can be used for validation checks at the smart contact function level during invocation, which is with the POST smartcontracts/invoke API endpoint.
\nThis attribute should be defined with the following format in order to utilize the validation check feature:{key1:value1,key2:value2,key3:value3}
For example, the following could be key-value pairs used for the Identity:{country:Singapore,rating:5,type:accredited}
To confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"a861b976-0378-43c3-848e-bdf4c7985d23","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Wallet Profile Identity enables the flexible construction of a wallet profile that is recorded onto the blockchain ledger that can be used by smart contracts for verifying a wallet's permission for critical functions such as the transfer of tokens.
\nThe Wallet Profile is simply the JSON payload which is a free-form field that is recorded onto the chain.
\nSmart Contracts can invoke node-level functions to validate if the Wallet Profile adheres to rules set within the Smart Contract.
\n","_postman_id":"d1e41cdf-f082-4316-b706-c713a1d6beb4","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}},{"name":"Data Feed","item":[{"name":"/nodefunction/datafeed - put data on the chain","id":"ea218610-a809-4a1f-a3b2-786ed2db47ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"txData\": {\n \"dataPayload\": \"any data to be recorded on the chain\",\n \"payloadVersion\": \"1.2\",\n \"scaId\": \"SampleSCA\",\n \"submitterAddress\": \"a298466b8ab9341ed6f9a4f6be166df9a8330a72\"\n },\n \"txSignature\": \"00c2494600d72bbc7dd3f71dc1710308e561d4cce2de579f3046399d0046f4832f503894a2271bdfc49e2e318f5bb3ee98cdfbfc730bcb5ce9051c50ffba5a940d\"\n}","options":{"raw":{"language":"json"}}},"url":"https://studios-api.stacs.io/chain/node-a/nodefunction/datafeed","description":"Put any free form data on the blockchain, JSON format is encouraged for easier parsing when retrieving this data feed transaction.
\nTo confirm the transaction state on the chain, either subscribe for a callback message that will be sent asynchronously or utilize the /transactions endpoint.
(This can only be one of node-a,node-b)
\n","type":"text/plain"},"type":"any","value":"node-a","key":"node"}]}},"response":[{"id":"e82087ae-c27d-434c-a43b-4be6e9c0c67b","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"The Data Feed is a simple yet versatile API message to the blockchain that appends a data set that can be cross-referenced and stored by Smart Contracts.
\n","_postman_id":"e36d378f-e234-43f2-9593-557bf7b6d1dd","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","id":"c30e327e-9359-4d39-8ad3-121a9a10bbf9","name":"STACS Platform APIs","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[]}},"variable":[{"id":"79d3487c-c2d2-48aa-84f6-4333ca74b650","key":"node","value":"node-a","type":"any","description":" (This can only be one of node-a,node-b)"},{"id":"7d00b303-8688-4624-8301-ef70debc5c90","key":"baseUrl","value":"https://studios-api.stacs.io/chain/node-a","type":"string"}]}