Skip to content
Draft
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
docs
docs/*
!docs/.gitkeep
.idea
dist/*
!dist/esm
Expand Down
1 change: 1 addition & 0 deletions lib/algorand.asset.params.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
> More detailed explanation about the asset parameters can be added to the documentation
19 changes: 19 additions & 0 deletions lib/algorand.asset.params.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// #region imports
import {AssetParams, AssetParamsBuilder} from "./algorand.asset.params";

// #endregion imports
describe("AssetParams", () => {
it("(OK) AssetParams Builder", async () => {
// #region quickStart
const assetParams = new AssetParamsBuilder()
.addTotal(1000)
.addDecimals(1)
.addAssetName('Yet Another Asset')
.addUnitName('YEET')
.get()
// #endregion quickStart

expect(assetParams).toBeDefined()
expect(assetParams).toBeInstanceOf(AssetParams)
})
})
11 changes: 11 additions & 0 deletions lib/algorand.asset.params.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
import {AlgorandEncoder} from "./algorand.encoder.js";

/**
* Asset Parameters
*
* Specifies the parameters for an asset.
* (apar) when part of an AssetConfig transaction.
*
* #### Quick Start:
* {@includeCode ./algorand.asset.params.spec.ts#imports,quickStart}
*
* {@include ./algorand.asset.params.md}
*
* @category Common
* @see {@link AssetConfigTransaction}
*/
export class AssetParams {
/**
Expand Down
Loading