diff --git a/src/pages/build-apps/guides/transaction-signing.md b/src/pages/build-apps/guides/transaction-signing.md index 7d5a3918..d63715db 100644 --- a/src/pages/build-apps/guides/transaction-signing.md +++ b/src/pages/build-apps/guides/transaction-signing.md @@ -90,7 +90,7 @@ interface STXTransferOptions { amount: string; memo?: string; network: StacksNetwork; - fee: number | string, + fee: number | string; appDetails: { name: string; icon: string; @@ -99,15 +99,15 @@ interface STXTransferOptions { } ``` -| parameter | type | required | description | -| ---------- | ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | -| recipient | string | true | STX address for recipient of transfer | -| amount | string | true | Amount of microstacks (1 STX = 1,000,000 microstacks) to be transferred provided as string to prevent floating point errors. | -| appDetails | object | true | Dictionary that requires `name` and `icon` for app | -| onFinish | function | true | Callback executed by app when transaction has been signed and broadcasted. [Read more](#onFinish-option) | -| memo | string | false | Optional memo for inclusion with transaction | -| network | StacksNetwork | false | Specify the network that this transaction should be completed on. [Read more](#network-option) | -| fee | number \| string | false | Optional fee amount in microstacks (1 STX = 1,000,000 microstacks) for overwriting the wallet's default fee value. [Read more](https://forum.stacks.org/t/mempool-congestion-on-stacks-observations-and-next-steps-from-hiro/12325/5) | +| parameter | type | required | description | +| ---------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| recipient | string | true | STX address for recipient of transfer | +| amount | string | true | Amount of microstacks (1 STX = 1,000,000 microstacks) to be transferred provided as string to prevent floating point errors. | +| appDetails | object | true | Dictionary that requires `name` and `icon` for app | +| onFinish | function | true | Callback executed by app when transaction has been signed and broadcasted. [Read more](#onFinish-option) | +| memo | string | false | Optional memo for inclusion with transaction | +| network | StacksNetwork | false | Specify the network that this transaction should be completed on. [Read more](#network-option) | +| fee | number \| string | false | Optional fee amount in microstacks (1 STX = 1,000,000 microstacks) for overwriting the wallet's default fee value. [Read more](https://forum.stacks.org/t/mempool-congestion-on-stacks-observations-and-next-steps-from-hiro/12325/5) | ## Prompt to deploy smart contract @@ -140,7 +140,7 @@ interface ContractDeployOptions { codeBody: string; contractName: string; network: StacksNetwork; - fee: number | string, + fee: number | string; appDetails: { name: string; icon: string; @@ -149,14 +149,14 @@ interface ContractDeployOptions { } ``` -| parameter | type | required | description | -| ------------ | ------------- | -------- | -------------------------------------------------------------------------------------------------------- | -| codeBody | string | true | Clarity source code for contract | -| contractName | string | true | Name for contract | -| appDetails | object | true | Dictionary that requires `name` and `icon` for app | -| onFinish | function | true | Callback executed by app when transaction has been signed and broadcasted. [Read more](#onFinish-option) | -| network | StacksNetwork | false | Specify the network that this transaction should be completed on. [Read more](#network-option) | -| fee | number \| string | false | Optional fee amount in microstacks (1 STX = 1,000,000 microstacks) for overwriting the wallet's default fee value. [Read more](https://forum.stacks.org/t/mempool-congestion-on-stacks-observations-and-next-steps-from-hiro/12325/5) | +| parameter | type | required | description | +| ------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| codeBody | string | true | Clarity source code for contract | +| contractName | string | true | Name for contract | +| appDetails | object | true | Dictionary that requires `name` and `icon` for app | +| onFinish | function | true | Callback executed by app when transaction has been signed and broadcasted. [Read more](#onFinish-option) | +| network | StacksNetwork | false | Specify the network that this transaction should be completed on. [Read more](#network-option) | +| fee | number \| string | false | Optional fee amount in microstacks (1 STX = 1,000,000 microstacks) for overwriting the wallet's default fee value. [Read more](https://forum.stacks.org/t/mempool-congestion-on-stacks-observations-and-next-steps-from-hiro/12325/5) | -> Contracts will deploy to the Stacks address of the authenticated user. @@ -233,7 +233,7 @@ interface ContractCallOptions { contractName: string; functionArgs?: ClarityValue[]; network: StacksNetwork; - fee: number | string, + fee: number | string; appDetails: { name: string; icon: string; @@ -242,16 +242,16 @@ interface ContractCallOptions { } ``` -| parameter | type | required | description | -| ------------ | ------------- | -------- | -------------------------------------------------------------------------------------------------------- | -| contractAddress | string | true | Stacks address to which contract is deployed | -| contractName | string | true | Name of contract to sign | -| functionName | string | true | Name of function for signing / execution, which needs to be a [public function](/references/language-functions#define-public). | -| functionArgs | `ClarityValue[]` | true | Arguments for calling the function. [Learn more about constructing clarity values](https://github.com/blockstack/stacks.js/tree/master/packages/transactions#constructing-clarity-values). Defaults to `[]`. | -| appDetails | object | true | Dictionary that requires `name` and `icon` for app | -| onFinish | function | true | Callback executed by app when transaction has been signed and broadcasted. [Read more](#onFinish-option) | | -| network | StacksNetwork | false | Specify the network that this transaction should be completed on. [Read more](#network-option) | -| fee | number \| string | false | Optional fee amount in microstacks (1 STX = 1,000,000 microstacks) for overwriting the wallet's default fee value. [Read more](https://forum.stacks.org/t/mempool-congestion-on-stacks-observations-and-next-steps-from-hiro/12325/5) | +| parameter | type | required | description | +| --------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | +| contractAddress | string | true | Stacks address to which contract is deployed | +| contractName | string | true | Name of contract to sign | +| functionName | string | true | Name of function for signing / execution, which needs to be a [public function](/references/language-functions#define-public). | +| functionArgs | `ClarityValue[]` | true | Arguments for calling the function. [Learn more about constructing clarity values](https://github.com/blockstack/stacks.js/tree/master/packages/transactions#constructing-clarity-values). Defaults to `[]`. | +| appDetails | object | true | Dictionary that requires `name` and `icon` for app | +| onFinish | function | true | Callback executed by app when transaction has been signed and broadcasted. [Read more](#onFinish-option) | | +| network | StacksNetwork | false | Specify the network that this transaction should be completed on. [Read more](#network-option) | +| fee | number \| string | false | Optional fee amount in microstacks (1 STX = 1,000,000 microstacks) for overwriting the wallet's default fee value. [Read more](https://forum.stacks.org/t/mempool-congestion-on-stacks-observations-and-next-steps-from-hiro/12325/5) | ## Getting the signed transaction back after completion {#onFinish-option}