digital_asset

DigitalAsset - JavaScript client for digital_asset Layer1 API making management of crypto assets simple and easy This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install digital_asset --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your digital_asset from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var DigitalAsset = require('digital_asset');

var defaultClient = DigitalAsset.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new DigitalAsset.AddressApi()
var createAddressRequest = new DigitalAsset.CreateAddressRequest(); // {CreateAddressRequest} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAddress(createAddressRequest, callback);

Documentation for API Endpoints

All URIs are relative to https://api.staging.layer1.com

Class	Method	HTTP request	Description
DigitalAsset.AddressApi	createAddress	POST /digital/v1/addresses	Create a new address
DigitalAsset.AddressApi	getAddress	GET /digital/v1/addresses/{addressId}	Get address
DigitalAsset.AddressApi	listAddresses	GET /digital/v1/addresses	List addresses
DigitalAsset.AddressApi	listTags	GET /digital/v1/addresses/{addressId}/tags	List address tags
DigitalAsset.AddressApi	validateAddress	POST /digital/v1/addresses/validate	Validate address
DigitalAsset.AssetPoolApi	createAssetPool	POST /digital/v1/asset-pools	Create asset pool
DigitalAsset.AssetPoolApi	deleteAssetPool	DELETE /digital/v1/asset-pools/{assetPoolId}	Delete asset pool
DigitalAsset.AssetPoolApi	getAssetPool	GET /digital/v1/asset-pools/{assetPoolId}	Get asset pool
DigitalAsset.AssetPoolApi	getAssetPoolBalance	GET /digital/v1/asset-pools/{assetPoolId}/balances	Get asset pool balance
DigitalAsset.AssetPoolApi	getAssetPoolMaxWithdrawableAmount	GET /digital/v1/asset-pools/{assetPoolId}/max-withdrawable-amount	Get max asset pool withdrawable balance
DigitalAsset.AssetPoolApi	getAssetPoolSummary	GET /digital/v1/asset-pools/summary	Get asset pool summary
DigitalAsset.AssetPoolApi	listAssetPools	GET /digital/v1/asset-pools	List asset pools
DigitalAsset.AssetPoolApi	updateAssetPool	PATCH /digital/v1/asset-pools/{assetPoolId}	Update asset pool
DigitalAsset.ExportApi	createBalanceExport	POST /digital/v1/exports	Create a balance export
DigitalAsset.ExportApi	getExport	GET /digital/v1/exports/{id}	Get export with a download link
DigitalAsset.ExportApi	getExports	GET /digital/v1/exports	List all exports
DigitalAsset.FeeApi	estimateTransactionFee	POST /digital/v1/fee-estimate	Estimate transaction fee
DigitalAsset.KeyPairApi	createKeyPair	POST /digital/v1/key-pairs	Create key pair
DigitalAsset.KeyPairApi	getKeyPair	GET /digital/v1/key-pairs/{keyPairId}	Get key pair
DigitalAsset.KeyPairApi	listKeyPairs	GET /digital/v1/key-pairs	List key pairs
DigitalAsset.NetworkApi	getNetworks	GET /digital/v1/networks	Get all networks
DigitalAsset.ReturnApi	createReturnTransactionRequest	POST /digital/v1/returns	Create return transaction request
DigitalAsset.ScreeningApi	listScreenings	GET /digital/v1/screenings	List screening results
DigitalAsset.ScreeningApi	manuallyActionHeldTransfer	PUT /digital/v1/screenings/action	Approve or reject a held transfer
DigitalAsset.TransactionApi	claimTransaction	POST /digital/v1/transaction-claims	Claim blockchain transaction
DigitalAsset.TransactionApi	getTransactionById	GET /digital/v1/transactions/{transactionId}	Get transaction
DigitalAsset.TransactionApi	listTransactions	GET /digital/v1/transactions	List transactions
DigitalAsset.TransactionRequestApi	createStakingTransaction	POST /digital/v1/staking-requests	Create staking transaction request
DigitalAsset.TransactionRequestApi	createTransaction	POST /digital/v1/transaction-requests	Create transaction request
DigitalAsset.TransactionRequestApi	getTransactionRequestById	GET /digital/v1/transaction-requests/{requestId}	Get transaction request
DigitalAsset.TransactionRequestApi	listTransactionRequests	GET /digital/v1/transaction-requests	List transaction requests

Documentation for Models

• DigitalAsset.Address
• DigitalAsset.ApiError
• DigitalAsset.Asset
• DigitalAsset.AssetPoolSummary
• DigitalAsset.AssetValue
• DigitalAsset.Balance
• DigitalAsset.BlockDetail
• DigitalAsset.CreateAddressRequest
• DigitalAsset.CreateAssetPoolRequest
• DigitalAsset.CreateBalanceExportRequest
• DigitalAsset.CreateKeyPairRequest
• DigitalAsset.CreateStakingTransactionRequest
• DigitalAsset.CreateTransactionRequest
• DigitalAsset.Detail
• DigitalAsset.EstimateTransactionFeeRequest
• DigitalAsset.Export
• DigitalAsset.Failure
• DigitalAsset.KeyPair
• DigitalAsset.ManualActionRequest
• DigitalAsset.Network
• DigitalAsset.NetworkDetail
• DigitalAsset.Pageable
• DigitalAsset.PaginatedExports
• DigitalAsset.PaginatedResultAddress
• DigitalAsset.PaginatedResultKeyPair
• DigitalAsset.PaginatedResultTransaction
• DigitalAsset.PaginatedResultTransactionRequest
• DigitalAsset.PaginatedScreenings
• DigitalAsset.Participant
• DigitalAsset.ReturnRequest
• DigitalAsset.ScreeningMetadata
• DigitalAsset.ScreeningView
• DigitalAsset.Transaction
• DigitalAsset.TransactionClaimRequest
• DigitalAsset.TransactionMetadata
• DigitalAsset.TransactionRequest
• DigitalAsset.UpdateAssetPoolRequest
• DigitalAsset.ValidateAddressRequest
• DigitalAsset.ValidateAddressResponse

Documentation for Authorization

Authentication schemes defined for the API:

openId

httpSignature

• Type: HTTP signature authentication

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A