JSONRPC-private-module.md

title
The `private` Module

JSON-RPC methods (deprecated and removed from OE)

• private_call
• private_composeDeploymentTransaction
• private_contractKey
• private_sendTransaction

JSON-RPC API Reference

private_call

Make an local call to the private contract (without its state modification).

Parameters

0. Quantity or Tag - integer block number, or the string 'latest', 'earliest', see the default block parameter.
1. Object - The transaction object corresponding to the call
   • from: Address - 20 Bytes - The address the transaction is send from.
   • to: Address - (optional) 20 Bytes - The address the transaction is directed to.
   • gas: Quantity - (optional) Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
   • gasPrice: Quantity - (optional) Integer of the gas price used for each paid gas.
   • value: Quantity - (optional) Integer of the value sent with this transaction.
   • data: Data - (optional) 4 byte hash of the method signature followed by encoded parameters. For details see Ethereum Contract ABI.
   • nonce: Quantity - (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.
   • condition: Object - (optional) Conditional submission of the transaction. Can be either an integer block number { block: 1 } or UTC timestamp (in seconds) { time: 1491290692 } or null.

params: [
  "0x2", // 2
  {
    "from": "0x407d73d8a49eeb85d32cf465507dd71d507100c1",
    "to": "0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
    "data": "0x41cd5add4fd13aedd64521e363ea279923575ff39718065d38bd46f0e6632e8e"
  }
]

Returns

• Data - Result of the call

Example

Request

curl --data '{"method":"private_call","params":["0x2",{"from":"0x407d73d8a49eeb85d32cf465507dd71d507100c1","to":"0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b","data":"0x41cd5add4fd13aedd64521e363ea279923575ff39718065d38bd46f0e6632e8e"}],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "0x62e05075829655752e146a129a044ad72e95ce33e48ff48118b697e15e7b41e4"
}

---

private_composeDeploymentTransaction

Crafts a specific transaction wrapping a private contract inside a public contract. The resulting transaction is later expected to be signed and broadcasted.

Parameters

0. Quantity or Tag - integer block number, or the string 'latest', 'earliest', see the default block parameter.
1. Data - Signed transaction for contract’s creation.
2. Array - List of validator accounts for this contract.

params: [
  "0x2", // 2
  "0xf8840180830e57e094cd96d189596c690ff983e4e14d1838d0305186dc80a4bc64b76d2a0000000000000000000000000000000000000000000000000000000000000045a00b3aa43f869f087a3aec97ba4232b15f9f0ab964c17953ca556b944e424d1f84a058d6edf93ad3c2bb0f0513e9ef391bbe8f7400668aaa51344ee4bf1a587e0218",
  ["0xfeacd0d28fd158ba2d3adb6d69d20c723214edc9"]
]

Returns

• Object -
  • receipt: Object - The transaction’s receipt object.
    • transactionHash: Hash - 32 Bytes - hash of the transaction.
    • contractAddress: Address - 20 Bytes - address of the public contract.
    • status: Quantity - Status of the request.
  • transaction: Object - The transaction’s object
    • from: Address - 20 Bytes - The address the transaction is send from.
    • to: Address - (optional) 20 Bytes - The address the transaction is directed to.
    • gas: Quantity - (optional) Integer of the gas provided for the transaction execution. eth_call consumes zero gas, but this parameter may be needed by some executions.
    • gasPrice: Quantity - (optional) Integer of the gas price used for each paid gas.
    • value: Quantity - (optional) Integer of the value sent with this transaction.
    • data: Data - (optional) 4 byte hash of the method signature followed by encoded parameters. For details see Ethereum Contract ABI.
    • nonce: Quantity - (optional) Integer of a nonce. This allows to overwrite your own pending transactions that use the same nonce.
    • condition: Object - (optional) Conditional submission of the transaction. Can be either an integer block number { block: 1 } or UTC timestamp (in seconds) { time: 1491290692 } or null.

Example

Request

curl --data '{"method":"private_composeDeploymentTransaction","params":["0x2","0xf8840180830e57e094cd96d189596c690ff983e4e14d1838d0305186dc80a4bc64b76d2a0000000000000000000000000000000000000000000000000000000000000045a00b3aa43f869f087a3aec97ba4232b15f9f0ab964c17953ca556b944e424d1f84a058d6edf93ad3c2bb0f0513e9ef391bbe8f7400668aaa51344ee4bf1a587e0218",["0xfeacd0d28fd158ba2d3adb6d69d20c723214edc9"]],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "receipt": {
      "contractAddress": "0x4466399893d182dcbe43c2a5a79db93b52ed26ae",
      "status": "0",
      "transactionHash": "0xa6d76a50b9ca942091a0a766e7ca7ede06062c5b43916fa4bb4ed1c04d5bcd14"
    },
    "transaction": {
      "condition": null,
      "data": "0x6060604052341561000f57600080fd5b604051610b0d380380610b0d833981016040528080518201919060200180518201919060200180518201919050508260009080519060200190610053929190610092565b50816002908051906020019061006a92919061011c565b50806001908051906020019061008192919061011c565b506001600381905550505050610204565b82805482825590600052602060002090810192821561010b579160200282015b8281111561010a5782518260006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff160217905550916020019190600101906100b2565b5b509050610118919061019c565b5090565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f1061015d57805160ff191683800117855561018b565b8280016001018555821561018b579182015b8281111561018a57825182559160200191906001019061016f565b5b50905061019891906101df565b5090565b6101dc91905b808211156101d857600081816101000a81549073ffffffffffffffffffffffffffffffffffffffff0219169055506001016101a2565b5090565b90565b61020191905b808211156101fd5760008160009055506001016101e5565b5090565b90565b6108fa806102136000396000f300606060405260043610610078576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff16806317ac53a21461007d57806324c12bf61461019a57806335aa2e4414610228578063affed0e01461028b578063b7ab4db5146102b4578063c19d93fb1461031e575b600080fd5b341561008857600080fd5b610198600480803590602001908201803590602001908080601f016020809104026020016040519081016040528093929190818152602001838380828437820191505050505050919080359060200190820180359060200190808060200260200160405190810160405280939291908181526020018383602002808284378201915050505050509190803590602001908201803590602001908080602002602001604051908101604052809392919081815260200183836020028082843782019150505050505091908035906020019082018035906020019080806020026020016040519081016040528093929190818152602001838360200280828437820191505050505050919050506103ac565b005b34156101a557600080fd5b6101ad610600565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156101ed5780820151818401526020810190506101d2565b50505050905090810190601f16801561021a5780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b341561023357600080fd5b610249600480803590602001909190505061069e565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b341561029657600080fd5b61029e6106dd565b6040518082815260200191505060405180910390f35b34156102bf57600080fd5b6102c76106e3565b6040518080602001828103825283818151815260200191508051906020019060200280838360005b8381101561030a5780820151818401526020810190506102ef565b505050509050019250505060405180910390f35b341561032957600080fd5b610331610777565b6040518080602001828103825283818151815260200191508051906020019080838360005b83811015610371578082015181840152602081019050610356565b50505050905090810190601f16801561039e5780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b6000806040805190810160405280876040518082805190602001908083835b6020831015156103f057805182526020820191506020810190506020830392506103cb565b6001836020036101000a03801982511681845116808217855250505050505090500191505060405180910390206000191660001916815260200160035460010260001916600019168152506040518082600260200280838360005b8381101561046657808201518184015260208101905061044b565b5050505090500191505060405180910390209150600090505b6000805490508110156105d55760008181548110151561049b57fe5b906000526020600020900160009054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1660018387848151811015156104ee57fe5b90602001906020020151878581518110151561050657fe5b90602001906020020151878681518110151561051e57fe5b90602001906020020151604051600081526020016040526000604051602001526040518085600019166000191681526020018460ff1660ff16815260200183600019166000191681526020018260001916600019168152602001945050505050602060405160208103908084039060008661646e5a03f115156105a057600080fd5b50506020604051035173ffffffffffffffffffffffffffffffffffffffff161415156105c857fe5b808060010191505061047f565b85600190805190602001906105eb929190610815565b50600160035401600381905550505050505050565b60028054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156106965780601f1061066b57610100808354040283529160200191610696565b820191906000526020600020905b81548152906001019060200180831161067957829003601f168201915b505050505081565b6000818154811015156106ad57fe5b90600052602060002090016000915054906101000a900473ffffffffffffffffffffffffffffffffffffffff1681565b60035481565b6106eb610895565b600080548060200260200160405190810160405280929190818152602001828054801561076d57602002820191906000526020600020905b8160009054906101000a900473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020019060010190808311610723575b5050505050905090565b60018054600181600116156101000203166002900480601f01602080910402602001604051908101604052809291908181526020018280546001816001161561010002031660029004801561080d5780601f106107e25761010080835404028352916020019161080d565b820191906000526020600020905b8154815290600101906020018083116107f057829003601f168201915b505050505081565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f1061085657805160ff1916838001178555610884565b82800160010185558215610884579182015b82811115610883578251825591602001919060010190610868565b5b50905061089191906108a9565b5090565b602060405190810160405280600081525090565b6108cb91905b808211156108c75760008160009055506001016108af565b5090565b905600a165627a7a723058200ae0215fae320b646a22fdd58278b328f46d915bd65ddbfeb5b4a09643d6e0220029000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a000000000000000000000000000000000000000000000000000000000000001c00000000000000000000000000000000000000000000000000000000000000001000000000000000000000000feacd0d28fd158ba2d3adb6d69d20c723214edc900000000000000000000000000000000000000000000000000000000000000fc4c5d67d4f32afe4255372cb09c66f95c6cc0d3f847fae3daf400c451c77da3ec722c81b25440cad0eda11103b3e5036ee978e4ca23c4c6518da68ed6f366bbf16afb45e05d5f535cc7e1dac36077b1e4299e4a50129ce10aebf5bb7c25b9c674e64745e33d4312f82d0c7b5c7e9af06a18a0fde847dd095ddd988bf692cd40b9ce4215ffb28b6e3baf7e98b5e3ab0d7493c6fd4ae4154c4eee23fb2e74a868bf840ce0436542837d875b95cc284851a06e31f6a9e1d268826c99a8a28b4c6cff28d1acfb090177c44d49960fd9424a449a4bf3ee9937e629570a659735c5c2b0c76a3ab1aa92692142bfcb596ac8468a2cdfb1e87a4999480ef8c0490000000000000000000000000000000000000000000000000000000000000000000000103d5dca32b04c088dbea884d9d0d5f97400000000000000000000000000000000",
      "from": "0xe5a4b6f39b4c3e7203ca8caeecbad58d8f29b046",
      "gas": "0x2b1740",
      "gasPrice": "0x0",
      "nonce": "0x17",
      "to": null,
      "value": "0x0"
    }
  }
}

---

private_contractKey

Returns the Secret Store Document key id associated with the deployed public contract.

Parameters

0. Address - 20 Bytes - Address of the private contract

params: ["0x4466399893d182dcbe43c2a5a79db93b52ed26ae"]

Returns

• Data - 20 Bytes - Document key id associated with the deployed public contract.

Example

Request

curl --data '{"method":"private_contractKey","params":["0x4466399893d182dcbe43c2a5a79db93b52ed26ae"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "0x0000000000000000000000004466399893d182dcbe43c2a5a79db93b52ed26ae"
}

---

private_sendTransaction

Make an onchain call to the private contract in order to modify its state.

Parameters

0. Data - Signed regular transaction

params: ["0xf8840180830e57e094cd96d189596c690ff983e4e14d1838d0305186dc80a4bc64b76d2a0000000000000000000000000000000000000000000000000000000000000045a00b3aa43f869f087a3aec97ba4232b15f9f0ab964c17953ca556b944e424d1f84a058d6edf93ad3c2bb0f0513e9ef391bbe8f7400668aaa51344ee4bf1a587e0218"]

Returns

• Object - Response object describing the result of the call
  • transactionHash: Hash - 32 Bytes - hash of the transaction.
  • contractAddress: Address - 20 Bytes - address of the public contract.
  • status: Quantity - Status of the request.

Example

Request

curl --data '{"method":"private_sendTransaction","params":["0xf8840180830e57e094cd96d189596c690ff983e4e14d1838d0305186dc80a4bc64b76d2a0000000000000000000000000000000000000000000000000000000000000045a00b3aa43f869f087a3aec97ba4232b15f9f0ab964c17953ca556b944e424d1f84a058d6edf93ad3c2bb0f0513e9ef391bbe8f7400668aaa51344ee4bf1a587e0218"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": {
    "transactionHash": "0x63c715e88f7291e66069302f6fcbb4f28a19ef5d7cbd1832d0c01e221c0061c6",
    "contractAddress": "0xa94f5374fce5edbc8e2a8697c15331677e6ebf0b",
    "status": "0x0" // 0
  }
}