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

Docs executetx #739

Merged
merged 2 commits into from
Jul 19, 2022
Merged

Docs executetx #739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
012f739
docs: update executeTx and deploy* docs
robert-zaremba Jul 13, 2022
b81bf09
add note about rekeyed accounts
robert-zaremba Jul 19, 2022
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
4 changes: 3 additions & 1 deletion packages/algob/src/internal/deployer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -887,7 +887,9 @@ export class DeployerDeployMode extends DeployerBasicMode implements Deployer {
* Note: If passing transaction object a signer/s must be provided.
* @param transactions transaction parameters or atomic transaction parameters
* https://github.com/scale-it/algo-builder/blob/docs/docs/guide/execute-transaction.md
* or TransactionAndSign object(SDK transaction object and signer parameters)
* or TransactionAndSign object(SDK transaction object and signer parameters).
* If `ExecParams` are used, the deployer will connect to appropriate accounts / wallets to sign
* constructed transactions.
*/
async executeTx(
transactions: wtypes.ExecParams[] | wtypes.TransactionAndSign[]
Expand Down
4 changes: 3 additions & 1 deletion packages/algob/src/lib/tx.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,9 @@ export function signTransactions(txnAndSign: wtypes.TransactionAndSign[]): Uint8
* @param deployer Deployer
* @param transactions transaction parameters or atomic transaction parameters
* https://github.com/scale-it/algo-builder/blob/docs/docs/guide/execute-transaction.md
* or TransactionAndSign object(SDK transaction object and signer parameters)
* or TransactionAndSign object(SDK transaction object and signer parameters).
* If `ExecParams` are used, the deployer will connect to appropriate deployer accounts / wallets
* to sign constructed transactions.
*/
export async function executeTx(
deployer: Deployer,
Expand Down
10 changes: 7 additions & 3 deletions packages/algob/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,9 @@ export interface Deployer {
/**
* Creates and deploys ASA defined in asa.yaml.
* @name ASA name - deployer will search for the ASA in the /assets/asa.yaml file
* @flags deployment flags */
* @flags deployment flags. Required.
* `flags.creator` must be defined - it's an account which will sign the constructed transaction.
* NOTE: support for rekeyed accounts is limited (creator must have updated sk to properly sign transaction) */
deployASA: (
name: string,
flags: rtypes.ASADeploymentFlags,
Expand All @@ -455,7 +457,8 @@ export interface Deployer {
* @name ASA name
* @asaDef ASA definitions
* @flags deployment flags
*/
* `flags.creator` must be defined - it's an account which will sign the constructed transaction.
* NOTE: support for rekeyed accounts is limited (creator must have updated sk to properly sign transaction) */
deployASADef: (
name: string,
asaDef: wtypes.ASADef,
Expand Down Expand Up @@ -548,7 +551,8 @@ export interface Deployer {

/**
* Deploys stateful smart contract.
* @approvalProgram approval program filename (must be present in assets folder)
* @creator is the signer of the transaction.
* @appDefinition is an object providing details about approval and clear program.
* @clearProgram clear program filename (must be present in assets folder)
* @flags AppDeploymentFlags
* @payFlags Transaction Parameters
Expand Down
3 changes: 2 additions & 1 deletion packages/web/src/lib/web-mode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,8 @@ export class WebMode {
/**
* Execute single transaction or group of transactions (atomic transaction)
* @param transactions transaction parameters, atomic transaction parameters
* or TransactionAndSign object(SDK transaction object and signer parameters)
* or TransactionAndSign object(SDK transaction object and signer parameters).
* When list of ExecParams is used, the function will request wallet to sign transactions.
*/
async executeTx(
transactions: ExecParams[] | TransactionAndSign[]
Expand Down