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.

Sign up for GitHub

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

[PSDK-247] ServerSigner Class Impl + ServerSigner.getDefault() #58

Merged
merged 1 commit into from
Jun 6, 2024
Merged

[PSDK-247] ServerSigner Class Impl + ServerSigner.getDefault() #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
### Added

- Added Base Mainnet network support
- `ServerSigner` object
- Ability to get default Server-Signer

### Changed

Expand Down Expand Up @@ -38,4 +40,4 @@ Initial release of the Coinbase NodeJS.
- API HTTP debugging
- User object and getDefaultUser
- Individual private key export
- Error specifications
- Error specifications
241 changes: 233 additions & 8 deletions src/client/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,43 @@ export interface BroadcastTransferRequest {
*/
'signed_payload': string;
}
/**
*
* @export
* @interface BuildStakingOperationRequest
*/
export interface BuildStakingOperationRequest {
/**
* The ID of the blockchain network
* @type {string}
* @memberof BuildStakingOperationRequest
*/
'network_id': string;
/**
* The ID of the asset being staked
* @type {string}
* @memberof BuildStakingOperationRequest
*/
'asset_id': string;
/**
* The onchain address from which the staking transaction originates and is responsible for signing the transaction.
* @type {string}
* @memberof BuildStakingOperationRequest
*/
'address_id': string;
/**
* The type of staking operation
* @type {string}
* @memberof BuildStakingOperationRequest
*/
'action': string;
/**
*
* @type {{ [key: string]: string; }}
* @memberof BuildStakingOperationRequest
*/
'options': { [key: string]: string; };
}
/**
*
* @export
Expand Down Expand Up @@ -497,6 +534,37 @@ export interface ServerSignerEventList {
*/
'total_count': number;
}
/**
*
* @export
* @interface ServerSignerList
*/
export interface ServerSignerList {
/**
*
* @type {Array<ServerSigner>}
* @memberof ServerSignerList
*/
'data': Array<ServerSigner>;
/**
* True if this list has another page of items after this one that can be fetched.
* @type {boolean}
* @memberof ServerSignerList
*/
'has_more': boolean;
/**
* The page token to be used to fetch the next page.
* @type {string}
* @memberof ServerSignerList
*/
'next_page': string;
/**
* The total number of server-signers for the project.
* @type {number}
* @memberof ServerSignerList
*/
'total_count': number;
}
/**
* An event representing a signature creation.
* @export
Expand Down Expand Up @@ -599,6 +667,19 @@ export interface SignatureCreationEventResult {
}


/**
* An onchain transaction to help realize a staking action.
* @export
* @interface StakingOperation
*/
export interface StakingOperation {
/**
*
* @type {Transaction}
* @memberof StakingOperation
*/
'transaction': Transaction;
}
/**
* A trade of an asset to another asset
* @export
Expand Down Expand Up @@ -1690,10 +1771,12 @@ export const ServerSignersApiAxiosParamCreator = function (configuration?: Confi
/**
* List server signers for the current project
* @summary List server signers for the current project
* @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
* @param {string} [page] A cursor for pagination across multiple pages of results. Don\&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listServerSigners: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
listServerSigners: async (limit?: number, page?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/v1/server_signers`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
Expand All @@ -1706,6 +1789,14 @@ export const ServerSignersApiAxiosParamCreator = function (configuration?: Confi
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;

if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}

if (page !== undefined) {
localVarQueryParameter['page'] = page;
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
Expand Down Expand Up @@ -1847,11 +1938,13 @@ export const ServerSignersApiFp = function(configuration?: Configuration) {
/**
* List server signers for the current project
* @summary List server signers for the current project
* @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
* @param {string} [page] A cursor for pagination across multiple pages of results. Don\&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async listServerSigners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerSigner>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listServerSigners(options);
async listServerSigners(limit?: number, page?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerSignerList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.listServerSigners(limit, page, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ServerSignersApi.listServerSigners']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
Expand Down Expand Up @@ -1929,11 +2022,13 @@ export const ServerSignersApiFactory = function (configuration?: Configuration,
/**
* List server signers for the current project
* @summary List server signers for the current project
* @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
* @param {string} [page] A cursor for pagination across multiple pages of results. Don\&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listServerSigners(options?: any): AxiosPromise<ServerSigner> {
return localVarFp.listServerSigners(options).then((request) => request(axios, basePath));
listServerSigners(limit?: number, page?: string, options?: any): AxiosPromise<ServerSignerList> {
return localVarFp.listServerSigners(limit, page, options).then((request) => request(axios, basePath));
},
/**
* Submit the result of a server signer event
Expand Down Expand Up @@ -2001,11 +2096,13 @@ export interface ServerSignersApiInterface {
/**
* List server signers for the current project
* @summary List server signers for the current project
* @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
* @param {string} [page] A cursor for pagination across multiple pages of results. Don\&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ServerSignersApiInterface
*/
listServerSigners(options?: RawAxiosRequestConfig): AxiosPromise<ServerSigner>;
listServerSigners(limit?: number, page?: string, options?: RawAxiosRequestConfig): AxiosPromise<ServerSignerList>;

/**
* Submit the result of a server signer event
Expand Down Expand Up @@ -2079,12 +2176,14 @@ export class ServerSignersApi extends BaseAPI implements ServerSignersApiInterfa
/**
* List server signers for the current project
* @summary List server signers for the current project
* @param {number} [limit] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
* @param {string} [page] A cursor for pagination across multiple pages of results. Don\&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ServerSignersApi
*/
public listServerSigners(options?: RawAxiosRequestConfig) {
return ServerSignersApiFp(this.configuration).listServerSigners(options).then((request) => request(this.axios, this.basePath));
public listServerSigners(limit?: number, page?: string, options?: RawAxiosRequestConfig) {
return ServerSignersApiFp(this.configuration).listServerSigners(limit, page, options).then((request) => request(this.axios, this.basePath));
}

/**
Expand Down Expand Up @@ -2116,6 +2215,132 @@ export class ServerSignersApi extends BaseAPI implements ServerSignersApiInterfa



/**
* StakeApi - axios parameter creator
* @export
*/
export const StakeApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Build a new staking operation
* @summary Build a new staking operation
* @param {BuildStakingOperationRequest} [buildStakingOperationRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
buildStakingOperation: async (buildStakingOperationRequest?: BuildStakingOperationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/v1/stake/build`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}

const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;



localVarHeaderParameter['Content-Type'] = 'application/json';

setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(buildStakingOperationRequest, localVarRequestOptions, configuration)

return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};

/**
* StakeApi - functional programming interface
* @export
*/
export const StakeApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = StakeApiAxiosParamCreator(configuration)
return {
/**
* Build a new staking operation
* @summary Build a new staking operation
* @param {BuildStakingOperationRequest} [buildStakingOperationRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async buildStakingOperation(buildStakingOperationRequest?: BuildStakingOperationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StakingOperation>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.buildStakingOperation(buildStakingOperationRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['StakeApi.buildStakingOperation']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};

/**
* StakeApi - factory interface
* @export
*/
export const StakeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = StakeApiFp(configuration)
return {
/**
* Build a new staking operation
* @summary Build a new staking operation
* @param {BuildStakingOperationRequest} [buildStakingOperationRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
buildStakingOperation(buildStakingOperationRequest?: BuildStakingOperationRequest, options?: any): AxiosPromise<StakingOperation> {
return localVarFp.buildStakingOperation(buildStakingOperationRequest, options).then((request) => request(axios, basePath));
},
};
};

/**
* StakeApi - interface
* @export
* @interface StakeApi
*/
export interface StakeApiInterface {
/**
* Build a new staking operation
* @summary Build a new staking operation
* @param {BuildStakingOperationRequest} [buildStakingOperationRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StakeApiInterface
*/
buildStakingOperation(buildStakingOperationRequest?: BuildStakingOperationRequest, options?: RawAxiosRequestConfig): AxiosPromise<StakingOperation>;

}

/**
* StakeApi - object-oriented interface
* @export
* @class StakeApi
* @extends {BaseAPI}
*/
export class StakeApi extends BaseAPI implements StakeApiInterface {
/**
* Build a new staking operation
* @summary Build a new staking operation
* @param {BuildStakingOperationRequest} [buildStakingOperationRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StakeApi
*/
public buildStakingOperation(buildStakingOperationRequest?: BuildStakingOperationRequest, options?: RawAxiosRequestConfig) {
return StakeApiFp(this.configuration).buildStakingOperation(buildStakingOperationRequest, options).then((request) => request(this.axios, this.basePath));
}
}



/**
* TradesApi - axios parameter creator
* @export
Expand Down
2 changes: 2 additions & 0 deletions src/coinbase/coinbase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
TransfersApiFactory,
AddressesApiFactory,
WalletsApiFactory,
ServerSignersApiFactory,
} from "../client";
import { BASE_PATH } from "./../client/base";
import { Configuration } from "./../client/configuration";
Expand Down Expand Up @@ -100,6 +101,7 @@ export class Coinbase {
Coinbase.apiClients.wallet = WalletsApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.address = AddressesApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.transfer = TransfersApiFactory(config, basePath, axiosInstance);
Coinbase.apiClients.serverSigner = ServerSignersApiFactory(config, basePath, axiosInstance);
Coinbase.apiKeyPrivateKey = privateKey;
Coinbase.useServerSigner = useServerSigner;
}
Expand Down
Loading
Loading