1.0.5 • Published 5 months ago

@curvegrid/multibaas-sdk v1.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

@curvegrid/multibaas-sdk@1.0.5

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @curvegrid/multibaas-sdk@1.0.5 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://your_deployment.multibaas.com/api/v0

ClassMethodHTTP requestDescription
AddressesApideleteAddressDELETE /chains/{chain}/addresses/{address-or-alias}Delete address
AddressesApigetAddressGET /chains/{chain}/addresses/{address-or-alias}Get address
AddressesApilistAddressesGET /chains/{chain}/addressesList addresses
AddressesApisetAddressPOST /chains/{chain}/addressesCreate or update address
AdminApiacceptInvitePOST /invites/{inviteID}Accept invite
AdminApiaddCorsOriginPOST /corsAdd CORS origin
AdminApiaddGroupApiKeyPUT /groups/{groupID}/api_keys/{apiKeyID}Add API key to group
AdminApiaddGroupRolePUT /groups/{groupID}/roles/{roleShortName}Add role to group
AdminApiaddGroupUserPUT /groups/{groupID}/users/{userID}Add user to group
AdminApicheckInviteGET /invites/{inviteID}Check invite
AdminApicreateApiKeyPOST /api_keysCreate API key
AdminApideleteApiKeyDELETE /api_keys/{apiKeyID}Delete API key
AdminApideleteUserDELETE /users/{userID}Delete user
AdminApigetApiKeyGET /api_keys/{apiKeyID}Get API Key
AdminApiinviteUserPOST /invitesInvite user
AdminApilistApiKeysGET /api_keysList API keys
AdminApilistAuditLogsGET /systemactivitiesList audit logs
AdminApilistCorsOriginsGET /corsList CORS origins
AdminApilistGroupsGET /groupsList groups
AdminApilistUserSignersGET /users/{userID}/signersList user signers
AdminApilistUsersGET /usersList users
AdminApiremoveCorsOriginDELETE /cors/{originID}Remove CORS Origin
AdminApiremoveGroupApiKeyDELETE /groups/{groupID}/api_keys/{apiKeyID}Remove API key from group
AdminApiremoveGroupRoleDELETE /groups/{groupID}/roles/{roleShortName}Remove role from group
AdminApiremoveGroupUserDELETE /groups/{groupID}/users/{userID}Remove user from group
AdminApiremoveUserSignerCloudWalletDELETE /users/{userID}/cloudwallets/{wallet_address}Remove user cloud wallet signer
AdminApiremoveUserSignerSafeAccountDELETE /users/{userID}/safeaccounts/{wallet_address}Remove user safe account signer
AdminApiremoveUserSignerWeb3WalletDELETE /users/{userID}/web3wallets/{wallet_address}Remove user web3 wallet signer
AdminApisetUserSignerCloudWalletPUT /users/{userID}/cloudwallets/{wallet_address}Add or update user cloud wallet signer
AdminApisetUserSignerSafeAccountPUT /users/{userID}/safeaccounts/{wallet_address}Add or update user safe account signer
AdminApisetUserSignerWeb3WalletPUT /users/{userID}/web3wallets/{wallet_address}Add or update user web3 wallet signer
AdminApiupdateApiKeyPUT /api_keys/{apiKeyID}Update API key
ChainsApigetBlockGET /chains/{chain}/blocks/{block}Get a block
ChainsApigetChainStatusGET /chains/{chain}/statusGet chain status
ChainsApigetTransactionGET /chains/{chain}/transactions/{hash}Get transaction
ChainsApigetTransactionReceiptGET /chains/{chain}/transactions/receipt/{hash}Get transaction receipt
ChainsApisubmitSignedTransactionPOST /chains/{chain}/transactions/submitSubmit signed transaction
ChainsApitransferEthPOST /chains/{chain}/transfersTransfer ETH
ContractsApicallContractFunctionPOST /chains/{chain}/addresses/{address-or-alias}/contracts/{contract}/methods/{method}Call a contract function
ContractsApicreateContractPOST /contracts/{contract}Create a contract
ContractsApicreateContractsPOST /contractsCreate multiple contracts
ContractsApideleteContractDELETE /contracts/{contract}Delete a contract
ContractsApideleteContractVersionDELETE /contracts/{contract}/{version}Delete a contract version
ContractsApideployContractPOST /contracts/{contract}/deployDeploy a contract
ContractsApideployContractVersionPOST /contracts/{contract}/{version}/deployDeploy a contract version
ContractsApigetContractGET /contracts/{contract}Get a contract
ContractsApigetContractVersionGET /contracts/{contract}/{version}Get a contract version
ContractsApigetContractVersionsGET /contracts/{contract}/allGet all contract versions
ContractsApigetEventMonitorStatusGET /chains/{chain}/addresses/{address-or-alias}/contracts/{contract}/statusGet event monitor status
ContractsApigetEventTypeConversionsGET /contracts/{contract}/{version}/events/{event}Get event type conversions
ContractsApigetFunctionTypeConversionsGET /contracts/{contract}/{version}/methods/{method}Get function type conversions
ContractsApilinkAddressContractPOST /chains/{chain}/addresses/{address-or-alias}/contractsLink address and contract
ContractsApilistContractVersionsGET /contracts/{contract}/versionsList all contract versions
ContractsApilistContractsGET /contractsList contracts
ContractsApisetEventTypeConversionsPOST /contracts/{contract}/{version}/events/{event}Set event type conversions
ContractsApisetFunctionTypeConversionsPOST /contracts/{contract}/{version}/methods/{method}Set function type conversions
ContractsApiunlinkAddressContractDELETE /chains/{chain}/addresses/{address-or-alias}/contracts/{contract}Unlink address and contract
EventQueriesApicountEventQueryRecordsGET /queries/{event_query}/countCount event query records
EventQueriesApideleteEventQueryDELETE /queries/{event_query}Delete event query
EventQueriesApiexecuteArbitraryEventQueryPOST /queriesExecute arbitrary event query
EventQueriesApiexecuteEventQueryGET /queries/{event_query}/resultsExecute event query
EventQueriesApigetEventQueryGET /queries/{event_query}Get event query
EventQueriesApilistEventQueriesGET /queriesList event queries
EventQueriesApisetEventQueryPUT /queries/{event_query}Create or update event query
EventsApigetEventCountGET /events/countGet event count
EventsApilistEventsGET /eventsList events
HsmApiaddHsmConfigPOST /hsm/configAdd HSM config
HsmApiaddHsmKeyPOST /hsm/keyAdd HSM key
HsmApicreateHsmKeyPOST /hsm/key/newCreate HSM key
HsmApilistHsmGET /hsmList HSM configs and wallets
HsmApilistHsmWalletsGET /hsm/walletsList HSM wallets
HsmApiremoveHsmConfigDELETE /hsm/config/{client_id}Remove HSM config
HsmApiremoveHsmKeyDELETE /hsm/key/{wallet_address}Remove HSM key
HsmApisetLocalNoncePOST /chains/{chain}/hsm/nonce/{wallet_address}Set local nonce
HsmApisignAndSubmitTransactionPOST /chains/{chain}/hsm/submitSign and submit transaction
HsmApisignDataPOST /chains/{chain}/hsm/signSign data
TxmApicancelTransactionPOST /chains/{chain}/txm/{wallet_address}/nonce/{nonce}/cancelCancel transaction
TxmApicountWalletTransactionsGET /chains/{chain}/txm/{wallet_address}/countCount all transactions for a wallet
TxmApilistWalletTransactionsGET /chains/{chain}/txm/{wallet_address}List transactions for a wallet
TxmApispeedUpTransactionPOST /chains/{chain}/txm/{wallet_address}/nonce/{nonce}/speed_upSpeed up transaction
WebhooksApicountWebhookEventsGET /webhooks/{webhookID}/events/countCount webhook events
WebhooksApicountWebhooksGET /webhooks/countCount webhooks
WebhooksApicreateWebhookPOST /webhooksCreate webhook
WebhooksApideleteWebhookDELETE /webhooks/{webhookID}Delete webhook
WebhooksApigetWebhookGET /webhooks/{webhookID}Get webhook
WebhooksApilistWebhookEventsGET /webhooks/{webhookID}/eventsList webhook events
WebhooksApilistWebhooksGET /webhooksList webhooks
WebhooksApiupdateWebhookPUT /webhooks/{webhookID}Update webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (JWT)

cookie

  • Type: API key
  • API key parameter name: token
  • Location:
1.0.2

7 months ago

1.0.1

8 months ago

1.0.0

8 months ago

1.0.5

5 months ago

1.0.4

6 months ago

1.0.3

6 months ago

1.0.0-beta26

1 year ago

1.0.0-beta27

11 months ago

1.0.0-beta28

11 months ago

1.0.0-beta25

1 year ago

1.0.0-beta24

1 year ago

1.0.0-beta22

1 year ago

1.0.0-beta23

1 year ago

1.0.0-beta21

1 year ago

1.0.0-beta20

1 year ago

1.0.0-beta19

1 year ago

1.0.0-beta18

2 years ago

1.0.0-beta17

2 years ago

1.0.0-beta10

2 years ago

1.0.0-beta9

2 years ago

1.0.0-beta15

2 years ago

1.0.0-beta16

2 years ago

1.0.0-beta11

2 years ago

1.0.0-beta12

2 years ago

1.0.0-beta13

2 years ago

1.0.0-beta14

2 years ago

1.0.0-beta8

2 years ago

1.0.0-beta6

2 years ago

1.0.0-beta7

2 years ago

1.0.0-beta5

2 years ago

1.0.0-beta2

2 years ago

1.0.0-beta3

2 years ago

1.0.0-beta4

2 years ago

1.0.0-beta1

3 years ago