fix(client): add readOnlyFunctionArgs

Author: friedger

client/src/generated/apis/SmartContractsApi.ts

@@ -21,6 +21,9 @@ import {
     ContractSourceResponse,
     ContractSourceResponseFromJSON,
     ContractSourceResponseToJSON,
+    ReadOnlyFunctionArgs,
+    ReadOnlyFunctionArgsFromJSON,
+    ReadOnlyFunctionArgsToJSON,
     ReadOnlyFunctionSuccessResponse,
     ReadOnlyFunctionSuccessResponseFromJSON,
     ReadOnlyFunctionSuccessResponseToJSON,
@@ -30,6 +33,7 @@ export interface CallReadOnlyFunctionRequest {
     stacksAddress: string;
     contractName: string;
     functionName: string;
+    readOnlyFunctionArgs: ReadOnlyFunctionArgs;
 }
 
 export interface GetContractByIdRequest {
@@ -81,15 +85,22 @@ export class SmartContractsApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('functionName','Required parameter requestParameters.functionName was null or undefined when calling callReadOnlyFunction.');
         }
 
+        if (requestParameters.readOnlyFunctionArgs === null || requestParameters.readOnlyFunctionArgs === undefined) {
+            throw new runtime.RequiredError('readOnlyFunctionArgs','Required parameter requestParameters.readOnlyFunctionArgs was null or undefined when calling callReadOnlyFunction.');
+        }
+
         const queryParameters: runtime.HTTPQuery = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+        headerParameters['Content-Type'] = 'application/json';
+
         const response = await this.request({
             path: `/v2/contracts/call-read/{stacks_address}/{contract_name}/{function_name}`.replace(`{${"stacks_address"}}`, encodeURIComponent(String(requestParameters.stacksAddress))).replace(`{${"contract_name"}}`, encodeURIComponent(String(requestParameters.contractName))).replace(`{${"function_name"}}`, encodeURIComponent(String(requestParameters.functionName))),
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
+            body: ReadOnlyFunctionArgsToJSON(requestParameters.readOnlyFunctionArgs),
         });
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ReadOnlyFunctionSuccessResponseFromJSON(jsonValue));

client/src/generated/models/ReadOnlyFunctionArgs.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks 2.0 Blockchain API
+ * This is the documentation for the Stacks 2.0 Blockchain API.  It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API.  [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/614feab5c108d292bffa#?env%5BStacks%20Blockchain%20API%5D=W3sia2V5Ijoic3R4X2FkZHJlc3MiLCJ2YWx1ZSI6IlNUMlRKUkhESE1ZQlE0MTdIRkIwQkRYNDMwVFFBNVBYUlg2NDk1RzFWIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJibG9ja19pZCIsInZhbHVlIjoiMHgiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6Im9mZnNldCIsInZhbHVlIjoiMCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoibGltaXRfdHgiLCJ2YWx1ZSI6IjIwMCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoibGltaXRfYmxvY2siLCJ2YWx1ZSI6IjMwIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJ0eF9pZCIsInZhbHVlIjoiMHg1NDA5MGMxNmE3MDJiNzUzYjQzMTE0ZTg4NGJjMTlhODBhNzk2MzhmZDQ0OWE0MGY4MDY4Y2RmMDAzY2RlNmUwIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb250cmFjdF9pZCIsInZhbHVlIjoiU1RKVFhFSlBKUFBWRE5BOUIwNTJOU1JSQkdRQ0ZOS1ZTMTc4VkdIMS5oZWxsb193b3JsZFxuIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJidGNfYWRkcmVzcyIsInZhbHVlIjoiYWJjIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb250cmFjdF9hZGRyZXNzIiwidmFsdWUiOiJTVEpUWEVKUEpQUFZETkE5QjA1Mk5TUlJCR1FDRk5LVlMxNzhWR0gxIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb250cmFjdF9uYW1lIiwidmFsdWUiOiJoZWxsb193b3JsZCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiY29udHJhY3RfbWFwIiwidmFsdWUiOiJzdG9yZSIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiY29udHJhY3RfbWV0aG9kIiwidmFsdWUiOiJnZXQtdmFsdWUiLCJlbmFibGVkIjp0cnVlfV0=)  ## Design  ### Stacks Core API vs Stacks Blockchain API The blockchain\'s Rust implementation exposes a JSON RPC endpoint (\"Stacks Core API\"), which can be used to interface with the blockchain. It can be used directly. [See the documentation for the `stacks-blockchain` in its Github repository](https://github.com/blockstack/stacks-blockchain/)  All `/v2/` routes a proxied to a Blockstack PBC-hosted Stacks Node. For a trustless architecture, you should make these requests to a self-hosted node.  All `/extended/` routes are provided by the Stacks 2.0 Blockchain API directly. They extend the Stacks Core API capabilities to make it easier to integrate with.  ### Pagination To make API responses more compact, lists returned by the API are paginated. For lists, the response body includes:       - `limit`: the number of list items return per response   - `offset`: the number of elements to skip (starting from `0`)   - `total`: the number of all available list items   - `results`: the array of list items (length of array equals the set limit)  Using the `limit` and `offset` properties, you can paginate through the entire list by increasing the offset by the limit until you reach the total.  ## Client Library A generated JS Client is available for consumption of this API. The client enables typesafe REST and WebSocket communication. Please review the [client documentation](https://blockstack.github.io/stacks-blockchain-api/client/index.html) for more details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * Describes representation of a Type-0 Stacks 2.0 transaction. https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#type-0-transferring-an-asset
+ * @export
+ * @interface ReadOnlyFunctionArgs
+ */
+export interface ReadOnlyFunctionArgs {
+    /**
+     * The simulated tx-sender
+     * @type {string}
+     * @memberof ReadOnlyFunctionArgs
+     */
+    sender: string;
+    /**
+     * An array of hex serialized Clarity values
+     * @type {Array<string>}
+     * @memberof ReadOnlyFunctionArgs
+     */
+    arguments: Array<string>;
+}
+
+export function ReadOnlyFunctionArgsFromJSON(json: any): ReadOnlyFunctionArgs {
+    return ReadOnlyFunctionArgsFromJSONTyped(json, false);
+}
+
+export function ReadOnlyFunctionArgsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReadOnlyFunctionArgs {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'sender': json['sender'],
+        'arguments': json['arguments'],
+    };
+}
+
+export function ReadOnlyFunctionArgsToJSON(value?: ReadOnlyFunctionArgs | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'sender': value.sender,
+        'arguments': value.arguments,
+    };
+}
+
+

client/src/generated/models/index.ts

@@ -13,6 +13,7 @@ export * from './MempoolTransactionListResponse';
 export * from './NetworkBlockTimeResponse';
 export * from './NetworkBlockTimesResponse';
 export * from './NetworkBlockTimesResponseMainnet';
+export * from './ReadOnlyFunctionArgs';
 export * from './ReadOnlyFunctionSuccessResponse';
 export * from './RunFaucetResponse';
 export * from './TransactionResults';

client/test/test.ts

@@ -1,11 +1,10 @@
 import fetch from 'cross-fetch';
-import { Configuration, BlocksApi } from '../src/index';
+import { Configuration, BlocksApi, SmartContractsApi } from '../src/index';
 
 (async () => {
-
-  const apiConfig = new Configuration({ 
+  const apiConfig = new Configuration({
     fetchApi: fetch, // `fetch` lib must be specified in Node.js environments
-    basePath: 'https://sidecar.staging.blockstack.xyz' // defaults to http://localhost:3999
+    basePath: 'https://stacks-node-api-latest.argon.blockstack.xyz', // defaults to http://localhost:3999
   });
 
   const blockApi = new BlocksApi(apiConfig);
@@ -14,4 +13,15 @@ import { Configuration, BlocksApi } from '../src/index';
   console.log(blocks.total);
   console.log(blocks.results);
 
-})().catch(console.error)
+  const smartContractsApi = new SmartContractsApi(apiConfig);
+  const readOnly = await smartContractsApi.callReadOnlyFunction({
+    stacksAddress: 'ST12EY99GS4YKP0CP2CFW6SEPWQ2CGVRWK5GHKDRV',
+    contractName: 'flip-coin-jackpot',
+    functionName: 'get-optional-winner-at',
+    readOnlyFunctionArgs: {
+      sender: 'ST12EY99GS4YKP0CP2CFW6SEPWQ2CGVRWK5GHKDRV',
+      arguments: ['0x0100000000000000000000000000000001'],
+    },
+  });
+  console.log(readOnly);
+})().catch(console.error);

docs/entities/contracts/read-only-function-args.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "ReadOnlyFunctionArgs",
+  "description": "Describes representation of a Type-0 Stacks 2.0 transaction. https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#type-0-transferring-an-asset",
+  "type": "object",
+  "required": ["sender", "arguments"],
+  "properties": {
+    "sender": {
+      "type": "string",
+      "description": "The simulated tx-sender"
+    },
+    "arguments": {
+      "type": "array",
+      "description": "An array of hex serialized Clarity values",
+      "items": {
+        "type": "string"
+      }
+    }
+  }
+}

docs/openapi.yaml

@@ -425,49 +425,37 @@ paths:
                   $ref: ./api/contract/post-call-read-only-fn-success.example.json
                 fail:
                   $ref: ./api/contract/post-call-read-only-fn-fail.example.json
-    parameters:
-      - name: stacks_address
-        in: path
-        required: true
-        description: Stacks address
-        schema:
-          type: string
-      - name: contract_name
-        in: path
-        required: true
-        description: Contract name
-        schema:
-          type: string
-      - name: function_name
-        in: path
-        required: true
-        description: Function name
-        schema:
-          type: string
-    requestBody:
-      description: map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.
-      required: true
-      content:
-        application/json:
+      parameters:
+        - name: stacks_address
+          in: path
+          required: true
+          description: Stacks address
+          schema:
+            type: string
+        - name: contract_name
+          in: path
+          required: true
+          description: Contract name
           schema:
-            type: object
-            properties:
-              sender:
-                type: string
-                description: the simulated tx-sender
-              arguments:
-                type: array
-                description: an array of hex serialized Clarity values
-                items:
-                  type: string
-            requires:
-              - sender
-              - arguments
-            example:
-              sender: 'SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info'
-              arguments:
-                - '0x0011...'
-                - '0x00231...'
+            type: string
+        - name: function_name
+          in: path
+          required: true
+          description: Function name
+          schema:
+            type: string
+      requestBody:
+        description: map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: './entities/contracts/read-only-function-args.schema.json'
+              example:
+                sender: 'SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info'
+                arguments:
+                  - '0x0011...'
+                  - '0x00231...'
 
   /extended/v1/address/{principal}/balances:
     get: