Skip to content

Commit b85da30

Browse files
robdmoorerobdmoore
authored
Merge pull request #6 from algorandfoundation/docs-check
Docs check
2 parents 600c806 + b3474c8 commit b85da30

File tree

74 files changed

+6534
-9
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+6534
-9
lines changed

‎.github/workflows/pr.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,19 @@ jobs:
1919
pre-test-script: |
2020
pipx install algokit
2121
algokit localnet start
22+
check_docs:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Clone repository
26+
uses: actions/checkout@v3
27+
with:
28+
fetch-depth: 1
29+
- name: Check docs are up to date
30+
shell: bash
31+
run: |
32+
npm ci --ignore-scripts
33+
npm run generate:code-docs
34+
# Add untracked files as empty so they come up in diff
35+
git add -N .
36+
# Print changed files and error out if there are changes after generating docs
37+
git diff --exit-code --name-only

‎.github/workflows/release.yml‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,29 @@ jobs:
2222
pipx install algokit
2323
algokit localnet start
2424
25+
check_docs:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- name: Clone repository
29+
uses: actions/checkout@v3
30+
with:
31+
fetch-depth: 1
32+
- name: Check docs are up to date
33+
shell: bash
34+
run: |
35+
npm ci --ignore-scripts
36+
npm run generate:code-docs
37+
# Add untracked files as empty so they come up in diff
38+
git add -N .
39+
# Print changed files and error out if there are changes after generating docs
40+
git diff --exit-code --name-only
41+
2542
build:
2643
name: Build
2744
uses: makerxstudio/shared-config/.github/workflows/node-build-zip.yml@main
28-
needs: ci
45+
needs:
46+
- ci
47+
- check_docs
2948
with:
3049
build-path: dist
3150
artifact-name: package

‎docs/code/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
@algorandfoundation/algokit-utils
2+
3+
# @algorandfoundation/algokit-utils
4+
5+
## Table of contents
6+
7+
### Modules
8+
9+
- [index](modules/index.md)
10+
- [types/algod](modules/types_algod.md)
11+
- [types/appspec](modules/types_appspec.md)
12+
- [types/indexer](modules/types_indexer.md)

‎docs/code/classes/index.AlgoAmount.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
[@algorandfoundation/algokit-utils](../README.md) / [index](../modules/index.md) / AlgoAmount
2+
3+
# Class: AlgoAmount
4+
5+
[index](../modules/index.md).AlgoAmount
6+
7+
Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and numbers
8+
9+
## Table of contents
10+
11+
### Constructors
12+
13+
- [constructor](index.AlgoAmount.md#constructor)
14+
15+
### Properties
16+
17+
- [amountInMicroAlgos](index.AlgoAmount.md#amountinmicroalgos)
18+
19+
### Accessors
20+
21+
- [algos](index.AlgoAmount.md#algos)
22+
- [microAlgos](index.AlgoAmount.md#microalgos)
23+
24+
### Methods
25+
26+
- [Algos](index.AlgoAmount.md#algos-1)
27+
- [MicroAlgos](index.AlgoAmount.md#microalgos-1)
28+
29+
## Constructors
30+
31+
### constructor
32+
33+
• **new AlgoAmount**(`amount`)
34+
35+
#### Parameters
36+
37+
| Name | Type |
38+
| :------ | :------ |
39+
| `amount` | { `algos`: `number` } \| { `microAlgos`: `number` } |
40+
41+
#### Defined in
42+
43+
[algo-amount.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algo-amount.ts#L17)
44+
45+
## Properties
46+
47+
### amountInMicroAlgos
48+
49+
• `Private` **amountInMicroAlgos**: `number`
50+
51+
#### Defined in
52+
53+
[algo-amount.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algo-amount.ts#L5)
54+
55+
## Accessors
56+
57+
### algos
58+
59+
• `get` **algos**(): `number`
60+
61+
Return the amount as a number in Algos
62+
63+
#### Returns
64+
65+
`number`
66+
67+
#### Defined in
68+
69+
[algo-amount.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algo-amount.ts#L13)
70+
71+
___
72+
73+
### microAlgos
74+
75+
• `get` **microAlgos**(): `number`
76+
77+
Return the amount as a number in µAlgos
78+
79+
#### Returns
80+
81+
`number`
82+
83+
#### Defined in
84+
85+
[algo-amount.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algo-amount.ts#L8)
86+
87+
## Methods
88+
89+
### Algos
90+
91+
▸ `Static` **Algos**(`amount`): [`AlgoAmount`](index.AlgoAmount.md)
92+
93+
Create a
94+
95+
**`See`**
96+
97+
object representing the given number of Algos
98+
99+
#### Parameters
100+
101+
| Name | Type |
102+
| :------ | :------ |
103+
| `amount` | `number` |
104+
105+
#### Returns
106+
107+
[`AlgoAmount`](index.AlgoAmount.md)
108+
109+
#### Defined in
110+
111+
[algo-amount.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algo-amount.ts#L22)
112+
113+
___
114+
115+
### MicroAlgos
116+
117+
▸ `Static` **MicroAlgos**(`amount`): [`AlgoAmount`](index.AlgoAmount.md)
118+
119+
Create a
120+
121+
**`See`**
122+
123+
object representing the given number of µAlgos
124+
125+
#### Parameters
126+
127+
| Name | Type |
128+
| :------ | :------ |
129+
| `amount` | `number` |
130+
131+
#### Returns
132+
133+
[`AlgoAmount`](index.AlgoAmount.md)
134+
135+
#### Defined in
136+
137+
[algo-amount.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algo-amount.ts#L27)

‎docs/code/classes/index.MultisigAccount.md‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
[@algorandfoundation/algokit-utils](../README.md) / [index](../modules/index.md) / MultisigAccount
2+
3+
# Class: MultisigAccount
4+
5+
[index](../modules/index.md).MultisigAccount
6+
7+
Account wrapper that supports partial or full multisig signing
8+
9+
## Table of contents
10+
11+
### Constructors
12+
13+
- [constructor](index.MultisigAccount.md#constructor)
14+
15+
### Properties
16+
17+
- [\_addr](index.MultisigAccount.md#_addr)
18+
- [\_params](index.MultisigAccount.md#_params)
19+
- [\_signingAccounts](index.MultisigAccount.md#_signingaccounts)
20+
21+
### Accessors
22+
23+
- [addr](index.MultisigAccount.md#addr)
24+
- [params](index.MultisigAccount.md#params)
25+
- [signingAccounts](index.MultisigAccount.md#signingaccounts)
26+
27+
### Methods
28+
29+
- [sign](index.MultisigAccount.md#sign)
30+
31+
## Constructors
32+
33+
### constructor
34+
35+
• **new MultisigAccount**(`multisigParams`, `signingAccounts`)
36+
37+
#### Parameters
38+
39+
| Name | Type |
40+
| :------ | :------ |
41+
| `multisigParams` | `MultisigMetadata` |
42+
| `signingAccounts` | (`default` \| [`SigningAccount`](index.SigningAccount.md))[] |
43+
44+
#### Defined in
45+
46+
[transaction.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L25)
47+
48+
## Properties
49+
50+
### \_addr
51+
52+
• **\_addr**: `string`
53+
54+
#### Defined in
55+
56+
[transaction.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L11)
57+
58+
___
59+
60+
### \_params
61+
62+
• **\_params**: `MultisigMetadata`
63+
64+
#### Defined in
65+
66+
[transaction.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L9)
67+
68+
___
69+
70+
### \_signingAccounts
71+
72+
• **\_signingAccounts**: (`default` \| [`SigningAccount`](index.SigningAccount.md))[]
73+
74+
#### Defined in
75+
76+
[transaction.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L10)
77+
78+
## Accessors
79+
80+
### addr
81+
82+
• `get` **addr**(): `string`
83+
84+
#### Returns
85+
86+
`string`
87+
88+
#### Defined in
89+
90+
[transaction.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L21)
91+
92+
___
93+
94+
### params
95+
96+
• `get` **params**(): `Readonly`<`MultisigMetadata`\>
97+
98+
#### Returns
99+
100+
`Readonly`<`MultisigMetadata`\>
101+
102+
#### Defined in
103+
104+
[transaction.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L13)
105+
106+
___
107+
108+
### signingAccounts
109+
110+
• `get` **signingAccounts**(): readonly (`default` \| [`SigningAccount`](index.SigningAccount.md))[]
111+
112+
#### Returns
113+
114+
readonly (`default` \| [`SigningAccount`](index.SigningAccount.md))[]
115+
116+
#### Defined in
117+
118+
[transaction.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L17)
119+
120+
## Methods
121+
122+
### sign
123+
124+
▸ **sign**(`transaction`): `Uint8Array`
125+
126+
#### Parameters
127+
128+
| Name | Type |
129+
| :------ | :------ |
130+
| `transaction` | `Uint8Array` \| `Transaction` |
131+
132+
#### Returns
133+
134+
`Uint8Array`
135+
136+
#### Defined in
137+
138+
[transaction.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L31)

0 commit comments

Comments
 (0)