Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Access] Add REST endpoint to get an account public keys #1494

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions openapi/access.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,38 @@ paths:
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerError'
/accounts/{address}/keys:
get:
summary: Get an Account Keys By Address
description: Get an account data by provided address in latest "sealed" block or by provided block height.
tags:
- Accounts
parameters:
- name: address
in: path
schema:
$ref: '#/components/schemas/Address'
required: true
description: The address of the account.
- name: block_height
in: query
schema:
$ref: '#/components/schemas/BlockHeight'
required: false
description: The block height to query for the account balance. "sealed" is used by default.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPublicKeys'
'400':
$ref: '#/components/responses/400BadRequest'
'404':
$ref: '#/components/responses/404NotFound'
'500':
$ref: '#/components/responses/500InternalServerError'
/accounts/{address}/keys/{index}:
get:
summary: Get an individual Account Key By Address and Index
Expand Down Expand Up @@ -725,6 +757,17 @@ components:
type: string
_links:
$ref: '#/components/schemas/Links'
AccountPublicKeys:
type: object
required:
- keys
properties:
keys:
type: array
items:
$ref: '#/components/schemas/AccountPublicKey'
minItems: 1
uniqueItems: true
AccountPublicKey:
type: object
required:
Expand Down
2 changes: 2 additions & 0 deletions openapi/go-client-generated/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ All URIs are relative to *https://rest-canary.onflow.org/v1/*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountsApi* | [**AccountsAddressGet**](docs/AccountsApi.md#accountsaddressget) | **Get** /accounts/{address} | Get an Account By Address
*AccountsApi* | [**AccountsAddressKeysGet**](docs/AccountsApi.md#accountsaddresskeysget) | **Get** /accounts/{address}/keys | Get an Account Keys By Address
*AccountsApi* | [**AccountsAddressKeysIndexGet**](docs/AccountsApi.md#accountsaddresskeysindexget) | **Get** /accounts/{address}/keys/{index} | Get an individual Account Key By Address and Index
*BlocksApi* | [**BlocksGet**](docs/BlocksApi.md#blocksget) | **Get** /blocks | Gets Blocks by Height
*BlocksApi* | [**BlocksIdGet**](docs/BlocksApi.md#blocksidget) | **Get** /blocks/{id} | Get Blocks by ID.
Expand All @@ -43,6 +44,7 @@ Class | Method | HTTP request | Description
- [Account](docs/Account.md)
- [AccountExpandable](docs/AccountExpandable.md)
- [AccountPublicKey](docs/AccountPublicKey.md)
- [AccountPublicKeys](docs/AccountPublicKeys.md)
- [AggregatedSignature](docs/AggregatedSignature.md)
- [Block](docs/Block.md)
- [BlockEvents](docs/BlockEvents.md)
Expand Down
77 changes: 77 additions & 0 deletions openapi/go-client-generated/api/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,56 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'
/accounts/{address}/keys:
get:
tags:
- Accounts
summary: Get an Account Keys By Address
description: Get an account data by provided address in latest "sealed" block
or by provided block height.
parameters:
- name: address
in: path
description: The address of the account.
required: true
style: simple
explode: false
schema:
$ref: '#/components/schemas/Address'
- name: block_height
in: query
description: The block height to query for the account balance. "sealed" is
used by default.
required: false
style: form
explode: true
schema:
$ref: '#/components/schemas/BlockHeight'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPublicKeys'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
"404":
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/accounts/{address}/keys/{index}:
get:
tags:
Expand Down Expand Up @@ -1179,6 +1229,33 @@ components:
_expandable:
keys: keys
contracts: contracts
AccountPublicKeys:
required:
- keys
type: object
properties:
keys:
minItems: 1
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/AccountPublicKey'
example:
keys:
- public_key: public_key
sequence_number: sequence_number
index: index
weight: weight
signing_algorithm: BLSBLS12381
revoked: true
hashing_algorithm: SHA2_256
- public_key: public_key
sequence_number: sequence_number
index: index
weight: weight
signing_algorithm: BLSBLS12381
revoked: true
hashing_algorithm: SHA2_256
AccountPublicKey:
required:
- hashing_algorithm
Expand Down
125 changes: 125 additions & 0 deletions openapi/go-client-generated/api_accounts.go
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,131 @@ func (a *AccountsApiService) AccountsAddressGet(ctx context.Context, address str
return localVarReturnValue, localVarHttpResponse, nil
}
/*
AccountsApiService Get an Account Keys By Address
Get an account data by provided address in latest \"sealed\" block or by provided block height.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param address The address of the account.
* @param optional nil or *AccountsApiAccountsAddressKeysGetOpts - Optional Parameters:
* @param "BlockHeight" (optional.Interface of BlockHeight) - The block height to query for the account balance. \"sealed\" is used by default.
@return AccountPublicKeys
*/

type AccountsApiAccountsAddressKeysGetOpts struct {
BlockHeight optional.Interface
}

func (a *AccountsApiService) AccountsAddressKeysGet(ctx context.Context, address string, localVarOptionals *AccountsApiAccountsAddressKeysGetOpts) (AccountPublicKeys, *http.Response, error) {
var (
localVarHttpMethod = strings.ToUpper("Get")
localVarPostBody interface{}
localVarFileName string
localVarFileBytes []byte
localVarReturnValue AccountPublicKeys
)

// create path and map variables
localVarPath := a.client.cfg.BasePath + "/accounts/{address}/keys"
localVarPath = strings.Replace(localVarPath, "{"+"address"+"}", fmt.Sprintf("%v", address), -1)

localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}

if localVarOptionals != nil && localVarOptionals.BlockHeight.IsSet() {
localVarQueryParams.Add("block_height", parameterToString(localVarOptionals.BlockHeight.Value(), ""))
}
// to determine the Content-Type header
localVarHttpContentTypes := []string{}

// set Content-Type header
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
if localVarHttpContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHttpContentType
}

// to determine the Accept header
localVarHttpHeaderAccepts := []string{"application/json"}

// set Accept header
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
if localVarHttpHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
}
r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
if err != nil {
return localVarReturnValue, nil, err
}

localVarHttpResponse, err := a.client.callAPI(r)
if err != nil || localVarHttpResponse == nil {
return localVarReturnValue, localVarHttpResponse, err
}

localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
localVarHttpResponse.Body.Close()
if err != nil {
return localVarReturnValue, localVarHttpResponse, err
}

if localVarHttpResponse.StatusCode < 300 {
// If we succeed, return the data, otherwise pass on to decode error.
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err == nil {
return localVarReturnValue, localVarHttpResponse, err
}
}

if localVarHttpResponse.StatusCode >= 300 {
newErr := GenericSwaggerError{
body: localVarBody,
error: localVarHttpResponse.Status,
}
if localVarHttpResponse.StatusCode == 200 {
var v AccountPublicKeys
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 400 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 404 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
if localVarHttpResponse.StatusCode == 500 {
var v ModelError
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"));
if err != nil {
newErr.error = err.Error()
return localVarReturnValue, localVarHttpResponse, newErr
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, newErr
}

return localVarReturnValue, localVarHttpResponse, nil
}
/*
AccountsApiService Get an individual Account Key By Address and Index
Get an account data by provided address in latest \&quot;sealed\&quot; block or by provided block height.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
Expand Down
9 changes: 9 additions & 0 deletions openapi/go-client-generated/docs/AccountPublicKeys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# AccountPublicKeys

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Keys** | [**[]AccountPublicKey**](AccountPublicKey.md) | | [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

37 changes: 37 additions & 0 deletions openapi/go-client-generated/docs/AccountsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All URIs are relative to *https://rest-canary.onflow.org/v1/*
Method | HTTP request | Description
------------- | ------------- | -------------
[**AccountsAddressGet**](AccountsApi.md#AccountsAddressGet) | **Get** /accounts/{address} | Get an Account By Address
[**AccountsAddressKeysGet**](AccountsApi.md#AccountsAddressKeysGet) | **Get** /accounts/{address}/keys | Get an Account Keys By Address
[**AccountsAddressKeysIndexGet**](AccountsApi.md#AccountsAddressKeysIndexGet) | **Get** /accounts/{address}/keys/{index} | Get an individual Account Key By Address and Index

# **AccountsAddressGet**
Expand Down Expand Up @@ -45,6 +46,42 @@ No authorization required

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **AccountsAddressKeysGet**
> AccountPublicKeys AccountsAddressKeysGet(ctx, address, optional)
Get an Account Keys By Address

Get an account data by provided address in latest \"sealed\" block or by provided block height.

### Required Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**address** | [**string**](.md)| The address of the account. |
**optional** | ***AccountsApiAccountsAddressKeysGetOpts** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a pointer to a AccountsApiAccountsAddressKeysGetOpts struct
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------

**blockHeight** | [**optional.Interface of BlockHeight**](.md)| The block height to query for the account balance. \&quot;sealed\&quot; is used by default. |

### Return type

[**AccountPublicKeys**](AccountPublicKeys.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **AccountsAddressKeysIndexGet**
> AccountPublicKey AccountsAddressKeysIndexGet(ctx, address, index, optional)
Get an individual Account Key By Address and Index
Expand Down
13 changes: 13 additions & 0 deletions openapi/go-client-generated/model_account_public_keys.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/*
* Access API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 1.0.0
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
*/
package swagger

type AccountPublicKeys struct {
Keys []AccountPublicKey `json:"keys"`
}
Loading