copy in specifications

moodysalem · moodysalem · commit 0d725e2ab47b · 2022-10-31T13:49:29.000-04:00
diff --git a/EIPS/eip-5792.md b/EIPS/eip-5792.md
@@ -75,21 +75,68 @@ Requests that the wallet deliver a group of function calls on-chain from the use
 - The wallet MAY reject the request if the `from` address does not match the enabled account.
 - The wallet MAY reject the request if one or more calls in the bundle will fail.
 
-#### `wallet_sendFunctionCallBundle` Parameters
-
-The method takes an array containing one object element, with the following keys:
-
-- `chainId`: `INTEGER` - The chain ID on which the function calls should be sent
-- `from`: `ADDRESS` - The address of the wallet that should send the calls in the bundle
-- `calls`: `ARRAY` - An array containing 1 or more call objects, where each call has the following keys:
-    - `to`: `ADDRESS` - (optional when creating new contract) The address the call is directed to.
-    - `gas`: `QUANTITY` - (optional) Integer of the gas provided for the call execution. Unused gas MAY be made
-      available to subsequent calls.
-    - `value`: `QUANTITY` - (optional) Integer of the value sent with this call.
-    - `data`: `DATA` - The compiled code of a contract OR the call data to include with the call, e.g. encoded
-      function signature and parameters.
-    - `optional`: `BOOLEAN` - (optional, default false) Whether the wallet should continue with subsequent calls if
-      this particular call fails
+#### `wallet_sendFunctionCallBundle` OpenRPC Specification
+
+```yaml
+- name: wallet_sendFunctionCallBundle
+  summary: Sends a bundle of function calls from the user wallet
+  params:
+    - name: Function calls
+      required: true
+      schema:
+        type: object
+        title: Transaction object generic to all types
+        required:
+          - chainId
+          - from
+          - calls
+        properties:
+          chainId:
+            title: chainId
+            description: Chain ID that these calls should be sent on
+            $ref: '#/components/schemas/uint'
+          from:
+            title: from address
+            description: The address from which the function calls should be sent
+            $ref: '#/components/schemas/address'
+          calls:
+            title: calls to make
+            description: The calls that the wallet should make from the user's address
+            type: array
+            minItems: 1
+            items:
+              title: function call
+              description: A single function call
+              type: object
+              required:
+                - gas
+                - data
+              to:
+                title: to address
+                description: The address that is being called
+                $ref: '#/components/schemas/address'
+              gas:
+                title: gas limit
+                description: The gas limit for this particular call
+                $ref: '#/components/schemas/uint'
+              value:
+                title: value
+                description: How much value to send with the call
+                $ref: '#/components/schemas/uint'
+              data:
+                title: data
+                description: The data to send with the function call
+                $ref: '#/components/schemas/bytes'
+              optional:
+                title: optional
+                description: Whether the call must succeed for subsequent calls to be made
+                type: boolean
+  result:
+    name: Bundle identifier
+    schema:
+      type: string
+      maxLength: 66
+```
 
 ##### `wallet_sendFunctionCallBundle` Example Parameters
 
@@ -117,16 +164,6 @@ The method takes an array containing one object element, with the following keys
 ]
 ```
 
-#### `wallet_sendFunctionCallBundle` Return value
-
-DATA, String - an identifier that the wallet uses to represent the bundle of calls.
-
-- This identifier MUST persist between connections of the same Dapp and account
-- The dapp SHOULD track the returned identifier to check the status of the bundle in the future
-- The returned identifier value MUST be unique for the given `from` address
-- The length of the returned identifier MUST NOT exceed 66 characters
-- There are no other requirements on the pattern of the identifier
-
 ##### `wallet_sendFunctionCallBundle` Example Return Value
 
 The identifier may be the hash of the call bundle, e.g.:
@@ -153,9 +190,78 @@ Returns the status of a bundle that was sent via `wallet_sendFunctionCallBundle`
 value returned from the `wallet_sendFunctionCallBundle` RPC. Note this method only returns a subset of fields
 that `eth_getTransactionReceipt` returns, excluding any fields that may differ across wallet implementations.
 
-#### `wallet_getBundleStatus` Parameters
-
-The method takes an array containing one string element, a bundle ID returned by `wallet_sendFunctionCallBundle`.
+#### `wallet_getBundleStatus` OpenRPC Specification
+
+```yaml
+- name: wallet_getBundleStatus
+  summary: Sends a bundle of function calls from the user wallet
+  params:
+    - name: Bundle identifier
+      required: true
+      schema:
+        type: string
+        title: Bundle identifier
+  result:
+    name: Call status
+    schema:
+      type: object
+      properties:
+        calls:
+          type: array
+          items:
+            title: call status
+            description: Status of the call at the given index
+            type: object
+            status:
+              title: The current status of the call
+              enum:
+                - CONFIRMED
+                - PENDING
+            receipt:
+              type: object
+              required:
+                - success
+                - blockHash
+                - blockNumber
+                - blockTimestamp
+                - gasUsed
+                - transactionHash
+              properties:
+                logs:
+                  type: array
+                  items:
+                    title: Log object
+                    type: object
+                    properties:
+                      address:
+                        $ref: '#/components/schemas/address'
+                      data:
+                        title: data
+                        $ref: '#/components/schemas/bytes'
+                      topics:
+                        title: topics
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/bytes32'
+                success:
+                  type: boolean
+                  title: Whether the call succeeded
+                blockHash:
+                  title: The hash of the block in which the call was included
+                  $ref: '#/components/schemas/bytes32'
+                blockNumber:
+                  title: The number of the block in which the call was included
+                  $ref: '#/components/schemas/uint'
+                blockTimestamp:
+                  title: The timestamp of the block in which the call was included
+                  $ref: '#/components/schemas/uint'
+                gasUsed:
+                  title: How much gas the call actually used
+                  $ref: '#/components/schemas/uint'
+                transactionHash:
+                  title: The hash of the transaction in which the call was made
+                  $ref: '#/components/schemas/bytes32'
+```
 
 ##### `wallet_getBundleStatus` Example Parameters
 
@@ -179,24 +285,6 @@ It may be a base64 encoded string:
 ["aGVsbG8gd29ybGQ="]
 ```
 
-#### `wallet_getBundleStatus` Return value
-
-Returns an object describing the status of each call in the bundle. Each call has its own status in the response,
-even if all the calls were submitted as part of a single transaction.
-
-- `calls`: `ARRAY` - An array of objects containing the status of each call from the bundle
-    - `status`: `"PENDING" | "CONFIRMED"` - Either `"PENDING"` indicating the call is not yet included on-chain,
-      or `"CONFIRMED"` indicating the call was included in a block
-    - `receipt`: `OBJECT` - (optional) An object containing the receipt for the given call, _iff_ status
-      is `"CONFIRMED"`
-        - `logs`: `ARRAY` - An array of log objects describing logs that were emitted by the call
-        - `success`: `BOOLEAN` - Whether the call was successfully delivered on-chain
-        - `blockHash`: `DATA` - The hash of the block in which the call was sent
-        - `blockNumber`: `QUANTITY` - The block number of the block in which the call was sent
-        - `blockTimestamp`: `QUANTITY` - The block timestamp of the block in which the call was sent
-        - `transactionHash`: `DATA` - The hash of the transaction in which the call was sent
-        - `gasUsed`: `QUANTITY` - The amount of gas that the call cost to deliver
-
 ##### `wallet_getBundleStatus` Example Return Value
 
 ```json
@@ -239,9 +327,22 @@ transaction hash.
 - The wallet MAY ignore the request, for example if the wallet is busy with other user actions.
 - The wallet MAY direct the user to a third party block explorer for more information.
 
-#### `wallet_showBundleStatus` Parameters
-
-The method takes an array containing one string element, a bundle ID returned by `wallet_sendFunctionCallBundle`.
+#### `wallet_showBundleStatus` OpenRPC Specification
+
+```yaml
+- name: wallet_showBundleStatus
+  summary: Requests that the wallet show the status of the bundle with the given identifier
+  params:
+    - name: Bundle identifier
+      required: true
+      schema:
+        type: string
+        maxLength: 66
+  result:
+    name: Empty
+    schema:
+      type: "null"
+```
 
 ##### `wallet_showBundleStatus` Example Parameters
 
@@ -251,10 +352,6 @@ The method takes an array containing one string element, a bundle ID returned by
 ]
 ```
 
-#### `wallet_showBundleStatus` Return Value
-
-This method always returns `null`.
-
 ##### `wallet_showBundleStatus` Example Return Value
 
 ```json
