Table of Contents
  1. JSON
  2. XML
  3. Input Parameters
  4. Response Parameters
  5. Calculating the Key Signature
  6. Calculating the Request Signature
  7. Javascript Library

/Legal/SignContract

Allows the client to sign a smart contract.

Note: Neurons are federated. You can sign contracts created on other neurons through this API on the neuron you have your account on. Federated means that the neurons interconnect to share authorized information, when requested, and permitted.

JSON

Request
{
	"keyId": Required(Str(PKeyId)),
	"legalId": Required(Str(PLegalId)),
	"contractId": Required(Str(PContractId)),
	"role": Required(Str(PRole)),
	"nonce": Required(Str(PNonce)),
	"keySignature": Required(Str(PKeySignature)),
	"requestSignature": Required(Str(PRequestSignature))
}
Response (if successful)
{
	"Contract": Required(PContract)
}

XML

Request
<SignContract xmlns="https://waher.se/Schema/BrokerAgent.xsd"
              keyId=(Required(Str(PKeyId)))
              legalId=(Required(Str(PLegalId)))
              contractId=(Required(Str(PContractId)))
              role=(Required(Str(PRole)))
              nonce=(Required(Str(PNonce)))
              keySignature=(Required(Str(PKeySignature)))
              requestSignature=(Required(Str(PRequestSignature))) />
Response (if successful)
<ContractResponse xmlns="https://waher.se/Schema/BrokerAgent.xsd">
	<[Required(PContract)]>
</ContractResponse>

Input Parameters

Parameter Description
PKeyId Identity of key to use for signing the contract. It must correspond to the key used when signing the Legal Identity application that will be used to sign the contract.
PContractId ID of smart contract to sign.
PLegalId Identity of the Legal Identity that will be used to sign the smart contract.
Role For what role the signature will be made.
PNonce A unique random string, at least 32 characters long, with sufficient entropy to not be reused again. If reused, an error will be returned.
PKeySignature Cryptographic signature of the key ID, using the key password.
PRequestSignature Cryptographic signature of the requesut, using the account password.

Response Parameters

Parameter Description
PContract Updated Smart Contract object with the signature.

Calculating the Key Signature

The signature in PKeySignature is calculated as follows.

  1. Concatenate the strings PUserName ":" Host ":" PLocalName ":" PNamespace ":" PKeyId and call it s1, where Host is the host/domain name of the server. It is taken from the HTTP Host request header, so it must be the same as is used in the URL of the request. PUserName is the name of the account, used when creating the current account or logging in to the current account. PLocalName and PNamespace are the local name and namespace corresponding to the algorithm used for the key.

  2. UTF-8 encode the secret corresponding to the key, and call it Key1.

  3. UTF-8 encode the string s1, and call it Data1.

  4. Calculate the HMAC-SHA256 signature using Key1 and Data1, and call it H1.

  5. Base64-encode H1. The result is the key signature of the request.

Calculating the Request Signature

The signature in PRequestSignature is calculated as follows.

  1. Concatenate the strings s1 ":" PKeySignature ":" PNonce ":" PLegalId ":" PContractId ":" PRole, and call it s2. s1 is the intermediate result of computing the key signature in the previous step.

  2. UTF-8 encode the secret corresponding to the account, and call it Key2.

  3. UTF-8 encode the string s2, and call it Data2.

  4. Calculate the HMAC-SHA256 signature using Key2 and Data2, and call it H2.

  5. Base64-encode H2. The result is the signature of the request.

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource. It computes the signatures according to the above specification.

var Response = await AgentAPI.Legal.SignContract(LocalName,Namespace,KeyId,KeyPassword,AccountPassword,ContractId,LegalId,Role);
Test









Request Payload:

Response Payload: