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

fix: align signer account to the type #349

Merged
merged 1 commit into from
Dec 9, 2024
Merged

fix: align signer account to the type #349

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
42 changes: 21 additions & 21 deletions docs/code/classes/types_account_manager.AccountManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ ___

#### Defined in

[src/types/account-manager.ts:512](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L512)
[src/types/account-manager.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L513)

___

Expand Down Expand Up @@ -207,7 +207,7 @@ const account = await account.dispenserFromEnvironment()

#### Defined in

[src/types/account-manager.ts:425](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L425)
[src/types/account-manager.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L426)

___

Expand Down Expand Up @@ -250,7 +250,7 @@ await algorand.account.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algoki

#### Defined in

[src/types/account-manager.ts:545](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L545)
[src/types/account-manager.ts:546](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L546)

___

Expand Down Expand Up @@ -299,7 +299,7 @@ await algorand.account.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.alg

#### Defined in

[src/types/account-manager.ts:607](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L607)
[src/types/account-manager.ts:608](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L608)

___

Expand Down Expand Up @@ -343,7 +343,7 @@ await algorand.account.ensureFundedUsingDispenserAPI("ACCOUNTADDRESS", algorand.

#### Defined in

[src/types/account-manager.ts:663](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L663)
[src/types/account-manager.ts:664](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L664)

___

Expand Down Expand Up @@ -388,7 +388,7 @@ If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC

#### Defined in

[src/types/account-manager.ts:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L318)
[src/types/account-manager.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L319)

___

Expand Down Expand Up @@ -422,7 +422,7 @@ const defaultDispenserAccount = await account.fromKmd('unencrypted-default-walle

#### Defined in

[src/types/account-manager.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L354)
[src/types/account-manager.ts:355](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L355)

___

Expand Down Expand Up @@ -454,7 +454,7 @@ const rekeyedAccount = accountManager.fromMnemonic("mnemonic secret ...", "SENDE

#### Defined in

[src/types/account-manager.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L270)
[src/types/account-manager.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L271)

___

Expand Down Expand Up @@ -489,7 +489,7 @@ const account = accountManager.getAccount(sender)

#### Defined in

[src/types/account-manager.ts:206](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L206)
[src/types/account-manager.ts:207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L207)

___

Expand Down Expand Up @@ -522,7 +522,7 @@ const accountInfo = await accountManager.getInformation(address);

#### Defined in

[src/types/account-manager.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L225)
[src/types/account-manager.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L226)

___

Expand Down Expand Up @@ -555,7 +555,7 @@ const signer = accountManager.getSigner("SENDERADDRESS")

#### Defined in

[src/types/account-manager.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L186)
[src/types/account-manager.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L187)

___

Expand All @@ -579,7 +579,7 @@ const account = await account.localNetDispenser()

#### Defined in

[src/types/account-manager.ts:444](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L444)
[src/types/account-manager.ts:445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L445)

___

Expand Down Expand Up @@ -610,7 +610,7 @@ const account = account.logicsig(program, [new Uint8Array(3, ...)])

#### Defined in

[src/types/account-manager.ts:392](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L392)
[src/types/account-manager.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L393)

___

Expand Down Expand Up @@ -642,7 +642,7 @@ const account = accountManager.multisig({version: 1, threshold: 1, addrs: ["ADDR

#### Defined in

[src/types/account-manager.ts:377](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L377)
[src/types/account-manager.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L378)

___

Expand All @@ -666,7 +666,7 @@ const account = account.random()

#### Defined in

[src/types/account-manager.ts:405](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L405)
[src/types/account-manager.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L406)

___

Expand Down Expand Up @@ -726,7 +726,7 @@ await algorand.account.rekeyAccount({

#### Defined in

[src/types/account-manager.ts:487](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L487)
[src/types/account-manager.ts:488](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L488)

___

Expand Down Expand Up @@ -758,7 +758,7 @@ const rekeyedAccount = accountManager.rekeyed(account, "SENDERADDRESS...")

#### Defined in

[src/types/account-manager.ts:287](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L287)
[src/types/account-manager.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L288)

___

Expand Down Expand Up @@ -827,7 +827,7 @@ const accountManager = new AccountManager(clientManager)

#### Defined in

[src/types/account-manager.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L153)
[src/types/account-manager.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L154)

___

Expand Down Expand Up @@ -865,7 +865,7 @@ const accountManager = new AccountManager(clientManager)

#### Defined in

[src/types/account-manager.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L137)
[src/types/account-manager.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L138)

___

Expand All @@ -892,7 +892,7 @@ The `AccountManager` instance for method chaining

#### Defined in

[src/types/account-manager.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L166)
[src/types/account-manager.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L167)

___

Expand Down Expand Up @@ -921,4 +921,4 @@ retrieval and returns a `TransactionSignerAccount` along with the original accou

#### Defined in

[src/types/account-manager.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L99)
[src/types/account-manager.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L100)
4 changes: 2 additions & 2 deletions src/types/account-manager.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ describe('AccountManager', () => {
const account2 = await algorand.account.fromEnvironment(name)

expect(account).not.toBe(account2)
expect(account.addr).toBe(account2.addr)
expect(account.addr).toEqual(account2.addr)
expect(account.account.sk).toEqual(account2.account.sk)
}, 10e6)

Expand All @@ -39,7 +39,7 @@ describe('AccountManager', () => {
const account2 = await algorand.account.fromEnvironment(name2)

expect(account).not.toBe(account2)
expect(account.addr).toBe(account2.addr)
expect(account.addr).toEqual(account2.addr)
expect(account.account.sk).toEqual(account2.account.sk)
}, 10e6)
})
9 changes: 5 additions & 4 deletions src/types/account-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ export class AccountManager {
* Records the given account (that can sign) against the address of the provided account for later
* retrieval and returns a `TransactionSignerAccount` along with the original account in an `account` property.
*/

private signerAccount<T extends TransactionSignerAccount | Account | SigningAccount | LogicSigAccount | MultisigAccount>(
account: T,
): Address &
Expand All @@ -108,12 +109,12 @@ export class AccountManager {
signer: signer,
}
this._accounts[acc.addr.toString()] = acc
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const addressWithAccount = Address.fromString(acc.addr.toString()) as any

const addressWithAccount = Address.fromString(acc.addr.toString()) as Address & TransactionSignerAccount & { account: T }
addressWithAccount.account = account
addressWithAccount.addr = acc.addr.toString()
addressWithAccount.addr = acc.addr
addressWithAccount.signer = signer
return addressWithAccount as Address & TransactionSignerAccount & { account: T }
return addressWithAccount
}

/**
Expand Down
Loading