From cf4fcfff74a4d3210190fe164994974922fbc6aa Mon Sep 17 00:00:00 2001 From: mfbz Date: Tue, 3 Jun 2025 19:45:31 +0200 Subject: [PATCH] Update FCL JS documentation from fcl-js@3fe592e5 --- .../clients/fcl-js/packages-docs/index.md | 14 + .../fcl-js/packages-docs/sdk/account.md | 47 ++ .../clients/fcl-js/packages-docs/sdk/arg.md | 42 ++ .../clients/fcl-js/packages-docs/sdk/args.md | 42 ++ .../fcl-js/packages-docs/sdk/atBlockHeight.md | 36 ++ .../fcl-js/packages-docs/sdk/atBlockId.md | 34 ++ .../fcl-js/packages-docs/sdk/atLatestBlock.md | 36 ++ .../fcl-js/packages-docs/sdk/authorization.md | 46 ++ .../packages-docs/sdk/authorizations.md | 39 ++ .../packages-docs/sdk/authzDeepResolveMany.md | 41 ++ .../fcl-js/packages-docs/sdk/authzFn.md | 34 ++ .../fcl-js/packages-docs/sdk/authzResolve.md | 34 ++ .../packages-docs/sdk/authzResolveMany.md | 37 ++ .../clients/fcl-js/packages-docs/sdk/bad.md | 33 ++ .../clients/fcl-js/packages-docs/sdk/block.md | 42 ++ .../clients/fcl-js/packages-docs/sdk/build.md | 31 ++ .../packages-docs/sdk/buildPreSignable.md | 33 ++ .../fcl-js/packages-docs/sdk/buildSignable.md | 37 ++ .../fcl-js/packages-docs/sdk/cadence.md | 36 ++ .../clients/fcl-js/packages-docs/sdk/cdc.md | 36 ++ .../fcl-js/packages-docs/sdk/config.md | 31 ++ .../sdk/createSignableVoucher.md | 29 + .../fcl-js/packages-docs/sdk/decode.md | 29 + .../packages-docs/sdk/decodeResponse.md | 61 +++ .../fcl-js/packages-docs/sdk/decodeStream.md | 43 ++ .../fcl-js/packages-docs/sdk/destroy.md | 29 + .../sdk/encodeMessageFromSignable.md | 38 ++ .../sdk/encodeTransactionEnvelope.md | 29 + .../sdk/encodeTransactionPayload.md | 29 + .../sdk/encodeTxIdFromVoucher.md | 42 ++ .../packages-docs/sdk/findInsideSigners.md | 29 + .../packages-docs/sdk/findOutsideSigners.md | 29 + .../clients/fcl-js/packages-docs/sdk/get.md | 37 ++ .../fcl-js/packages-docs/sdk/getAccount.md | 36 ++ .../fcl-js/packages-docs/sdk/getBlock.md | 36 ++ .../packages-docs/sdk/getBlockHeader.md | 36 ++ .../fcl-js/packages-docs/sdk/getCollection.md | 36 ++ .../fcl-js/packages-docs/sdk/getEvents.md | 46 ++ .../sdk/getEventsAtBlockHeightRange.md | 46 ++ .../packages-docs/sdk/getEventsAtBlockIds.md | 41 ++ .../packages-docs/sdk/getLatestBlock.md | 36 ++ .../packages-docs/sdk/getNetworkParameters.md | 29 + .../packages-docs/sdk/getNodeVersionInfo.md | 29 + .../packages-docs/sdk/getTransaction.md | 36 ++ .../packages-docs/sdk/getTransactionStatus.md | 37 ++ .../fcl-js/packages-docs/sdk/getTransport.md | 30 ++ .../clients/fcl-js/packages-docs/sdk/idof.md | 29 + .../clients/fcl-js/packages-docs/sdk/index.md | 150 ++++++ .../fcl-js/packages-docs/sdk/initAccount.md | 23 + .../packages-docs/sdk/initInteraction.md | 23 + .../fcl-js/packages-docs/sdk/interaction.md | 23 + .../fcl-js/packages-docs/sdk/isAccount.md | 29 + .../fcl-js/packages-docs/sdk/isArgument.md | 29 + .../fcl-js/packages-docs/sdk/isArray.md | 29 + .../clients/fcl-js/packages-docs/sdk/isBad.md | 29 + .../clients/fcl-js/packages-docs/sdk/isFn.md | 29 + .../fcl-js/packages-docs/sdk/isInteraction.md | 29 + .../fcl-js/packages-docs/sdk/isNull.md | 29 + .../fcl-js/packages-docs/sdk/isNumber.md | 29 + .../clients/fcl-js/packages-docs/sdk/isObj.md | 29 + .../clients/fcl-js/packages-docs/sdk/isOk.md | 29 + .../clients/fcl-js/packages-docs/sdk/limit.md | 36 ++ .../fcl-js/packages-docs/sdk/makeArgument.md | 29 + .../packages-docs/sdk/nodeVersionInfo.md | 30 ++ .../clients/fcl-js/packages-docs/sdk/ok.md | 29 + .../clients/fcl-js/packages-docs/sdk/param.md | 29 + .../fcl-js/packages-docs/sdk/params.md | 29 + .../clients/fcl-js/packages-docs/sdk/payer.md | 41 ++ .../clients/fcl-js/packages-docs/sdk/ping.md | 29 + .../clients/fcl-js/packages-docs/sdk/pipe.md | 29 + .../fcl-js/packages-docs/sdk/prepAccount.md | 43 ++ .../fcl-js/packages-docs/sdk/proposer.md | 34 ++ .../clients/fcl-js/packages-docs/sdk/put.md | 33 ++ .../clients/fcl-js/packages-docs/sdk/ref.md | 36 ++ .../packages-docs/sdk/resolveAccounts.md | 33 ++ .../packages-docs/sdk/resolveArguments.md | 29 + .../packages-docs/sdk/resolveCadence.md | 29 + .../packages-docs/sdk/resolveComputeLimit.md | 29 + .../sdk/resolveFinalNormalization.md | 29 + .../sdk/resolveProposerSequenceNumber.md | 34 ++ .../packages-docs/sdk/resolveRefBlockId.md | 29 + .../packages-docs/sdk/resolveSignatures.md | 29 + .../packages-docs/sdk/resolveValidators.md | 29 + .../sdk/resolveVoucherIntercept.md | 29 + .../fcl-js/packages-docs/sdk/response.md | 23 + .../clients/fcl-js/packages-docs/sdk/run.md | 29 + .../fcl-js/packages-docs/sdk/script.md | 35 ++ .../clients/fcl-js/packages-docs/sdk/send.md | 33 ++ .../clients/fcl-js/packages-docs/sdk/sig.md | 29 + .../fcl-js/packages-docs/sdk/subscribe.md | 43 ++ .../packages-docs/sdk/subscribeEvents.md | 35 ++ .../fcl-js/packages-docs/sdk/subscribeRaw.md | 43 ++ .../fcl-js/packages-docs/sdk/transaction.md | 36 ++ .../fcl-js/packages-docs/sdk/update.md | 33 ++ .../sdk/validateSignableTransaction.md | 34 ++ .../fcl-js/packages-docs/sdk/validator.md | 36 ++ .../packages-docs/sdk/voucherIntercept.md | 39 ++ .../fcl-js/packages-docs/sdk/voucherToTxId.md | 42 ++ .../clients/fcl-js/packages-docs/sdk/why.md | 29 + .../fcl-js/packages-docs/types/index.md | 510 ++++++++++++++++++ 100 files changed, 3952 insertions(+) create mode 100644 docs/tools/clients/fcl-js/packages-docs/index.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/account.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/arg.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/args.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/atBlockHeight.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/atBlockId.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/atLatestBlock.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/authorization.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/authorizations.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/authzDeepResolveMany.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/authzFn.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/authzResolve.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/authzResolveMany.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/bad.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/block.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/build.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/buildPreSignable.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/buildSignable.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/cadence.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/cdc.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/config.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/createSignableVoucher.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/decode.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/decodeResponse.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/decodeStream.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/destroy.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/encodeMessageFromSignable.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionEnvelope.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionPayload.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/encodeTxIdFromVoucher.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/findInsideSigners.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/findOutsideSigners.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/get.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getAccount.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getBlock.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getBlockHeader.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getCollection.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getEvents.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockHeightRange.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockIds.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getLatestBlock.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getNetworkParameters.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getNodeVersionInfo.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getTransaction.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getTransactionStatus.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/getTransport.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/idof.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/index.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/initAccount.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/initInteraction.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/interaction.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isAccount.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isArgument.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isArray.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isBad.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isFn.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isInteraction.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isNull.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isNumber.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isObj.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/isOk.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/limit.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/makeArgument.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/nodeVersionInfo.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/ok.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/param.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/params.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/payer.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/ping.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/pipe.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/prepAccount.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/proposer.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/put.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/ref.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveAccounts.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveArguments.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveCadence.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveComputeLimit.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveFinalNormalization.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveProposerSequenceNumber.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveRefBlockId.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveSignatures.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveValidators.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/resolveVoucherIntercept.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/response.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/run.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/script.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/send.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/sig.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/subscribe.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/subscribeEvents.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/subscribeRaw.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/transaction.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/update.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/validateSignableTransaction.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/validator.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/voucherIntercept.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/voucherToTxId.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/sdk/why.md create mode 100644 docs/tools/clients/fcl-js/packages-docs/types/index.md diff --git a/docs/tools/clients/fcl-js/packages-docs/index.md b/docs/tools/clients/fcl-js/packages-docs/index.md new file mode 100644 index 0000000000..99bde13769 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/index.md @@ -0,0 +1,14 @@ +--- +title: Packages Docs +description: FCL packages documentation. +--- + +> _Doc autogenerated from [onflow/fcl-js](https://github.com/onflow/fcl-js)_ + +# Packages Docs + +A list of all packages available inside FCL library with functions and types documentation. + +- [@onflow/sdk](./sdk/index.md) + +--- diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/account.md b/docs/tools/clients/fcl-js/packages-docs/sdk/account.md new file mode 100644 index 0000000000..cc4c56b28d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/account.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/account/account.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/account/account.ts)_ + +# account + +Returns the details of an account from their public address + +## Import + +```typescript +import { account } from "@onflow/sdk" +``` + + +## Parameters + +### `address` +- Type: `string` +- Description: Address of the account + + +### `options` (optional) +- Type: `AccountQueryOptions` + +```typescript +interface AccountQueryOptions { + height?: number + id?: string + isSealed?: boolean +} +``` + +### `opts` (optional) +- Type: `object` +- Description: Optional parameters + + + +## Returns + +[`Promise`](../types#account) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/arg.md b/docs/tools/clients/fcl-js/packages-docs/sdk/arg.md new file mode 100644 index 0000000000..13b7bf173d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/arg.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-arguments.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-arguments.ts)_ + +# arg + +A utility builder to be used with fcl.args[...] to create FCL supported arguments for interactions + +## Import + +```typescript +import { arg } from "@onflow/sdk" +``` + + +## Parameters + +### `value` +- Type: `TypeDescriptorInput` +- Description: The value of the argument + + +### `xform` +- Type: `T` +- Description: A function to transform the value + + + +## Returns + +`CadenceArgument` + +```typescript +type CadenceArgument> = { + value: TypeDescriptorInput + xform: T +} +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/args.md b/docs/tools/clients/fcl-js/packages-docs/sdk/args.md new file mode 100644 index 0000000000..6231f0124f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/args.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-arguments.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-arguments.ts)_ + +# args + +A utility builder to be used with other builders to pass in arguments with a value and supported type + +## Import + +```typescript +import { args } from "@onflow/sdk" +``` + + +## Parameters + +### `ax` +- Type: `CadenceArgument` +- Description: An array of arguments + +```typescript +type CadenceArgument> = { + value: TypeDescriptorInput + xform: T +} +``` + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/atBlockHeight.md b/docs/tools/clients/fcl-js/packages-docs/sdk/atBlockHeight.md new file mode 100644 index 0000000000..d2556071de --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/atBlockHeight.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-at-block-height.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-at-block-height.ts)_ + +# atBlockHeight + +A builder function that returns a partial interaction to a block at a specific height + +## Import + +```typescript +import { atBlockHeight } from "@onflow/sdk" +``` + + +## Parameters + +### `height` +- Type: `number` +- Description: The height of the block to get + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/atBlockId.md b/docs/tools/clients/fcl-js/packages-docs/sdk/atBlockId.md new file mode 100644 index 0000000000..1b010d2d5f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/atBlockId.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-at-block-id.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-at-block-id.ts)_ + +# atBlockId + + +## Import + +```typescript +import { atBlockId } from "@onflow/sdk" +``` + + +## Parameters + +### `id` +- Type: `string` + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/atLatestBlock.md b/docs/tools/clients/fcl-js/packages-docs/sdk/atLatestBlock.md new file mode 100644 index 0000000000..21a5030fc0 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/atLatestBlock.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-at-latest-block.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-at-latest-block.ts)_ + +# atLatestBlock + +A builder function that returns a partial interaction to query the latest block with the given finality state + +## Import + +```typescript +import { atLatestBlock } from "@onflow/sdk" +``` + + +## Parameters + +### `isSealed` (optional) +- Type: `boolean` +- Description: Block finality state, defaults to latest executed block ("soft-finality"), set to true for sealed blocks ("hard-finality") + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/authorization.md b/docs/tools/clients/fcl-js/packages-docs/sdk/authorization.md new file mode 100644 index 0000000000..edaac43975 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/authorization.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-authorizations.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-authorizations.ts)_ + +# authorization + + +## Import + +```typescript +import { authorization } from "@onflow/sdk" +``` + + +## Parameters + +### `addr` +- Type: `string` + + +### `signingFunction` +- Type: `SigningFn` + +```typescript +type SigningFn = ( + signable?: SignableMessage +) => SigningResult | Promise +``` + +### `keyId` (optional) +- Type: `string | number` + + +### `sequenceNum` (optional) +- Type: `number` + + + +## Returns + +[`InteractionAccount`](../types#interactionaccount) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/authorizations.md b/docs/tools/clients/fcl-js/packages-docs/sdk/authorizations.md new file mode 100644 index 0000000000..d1a78e7644 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/authorizations.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-authorizations.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-authorizations.ts)_ + +# authorizations + + +## Import + +```typescript +import { authorizations } from "@onflow/sdk" +``` + + +## Parameters + +### `ax` (optional) +- Type: `AccountAuthorization[]` + +```typescript +export type AccountAuthorization = + | (AuthorizationFn & Partial) + | Partial +``` + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/authzDeepResolveMany.md b/docs/tools/clients/fcl-js/packages-docs/sdk/authzDeepResolveMany.md new file mode 100644 index 0000000000..47b56bf758 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/authzDeepResolveMany.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/index.ts)_ + +# authzDeepResolveMany + + +## Import + +```typescript +import { authzDeepResolveMany } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` (optional) +- Type: `IAuthzResolveMany` + +```typescript +interface IAuthzResolveMany { + tempId?: string + authorizations: any[] + proposer?: any + payer?: any +} +``` + +### `depth` (optional) +- Type: `number` + + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/authzFn.md b/docs/tools/clients/fcl-js/packages-docs/sdk/authzFn.md new file mode 100644 index 0000000000..2388222b1b --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/authzFn.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/index.ts)_ + +# authzFn + + +## Import + +```typescript +import { authzFn } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` (optional) +- Type: `IAuthzOpts` + +```typescript +interface IAuthzOpts { + signingFunction?: (signable: any) => any +} +``` + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/authzResolve.md b/docs/tools/clients/fcl-js/packages-docs/sdk/authzResolve.md new file mode 100644 index 0000000000..dc21ab476b --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/authzResolve.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/index.ts)_ + +# authzResolve + + +## Import + +```typescript +import { authzResolve } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` (optional) +- Type: `IAuthzResolveOpts` + +```typescript +interface IAuthzResolveOpts { + tempId?: string +} +``` + + +## Returns + +`(account: InteractionAccount) => { tempId: string; resolve: (account: Partial) => Partial; kind: InteractionResolverKind.ACCOUNT; addr: string; keyId: string | number; sequenceNum: number; signature: string; signingFunction: any; role: { proposer: boolean; authorizer: boolean; payer: boolean; param?: boolean; }; authorization: any; }` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/authzResolveMany.md b/docs/tools/clients/fcl-js/packages-docs/sdk/authzResolveMany.md new file mode 100644 index 0000000000..ff2e67951c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/authzResolveMany.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/index.ts)_ + +# authzResolveMany + + +## Import + +```typescript +import { authzResolveMany } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` (optional) +- Type: `IAuthzResolveMany` + +```typescript +interface IAuthzResolveMany { + tempId?: string + authorizations: any[] + proposer?: any + payer?: any +} +``` + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/bad.md b/docs/tools/clients/fcl-js/packages-docs/sdk/bad.md new file mode 100644 index 0000000000..e209f58b02 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/bad.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# Bad + + +## Import + +```typescript +import { Bad } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + +### `reason` +- Type: `string` + + + +## Returns + +[`Interaction`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/block.md b/docs/tools/clients/fcl-js/packages-docs/sdk/block.md new file mode 100644 index 0000000000..7a620b31d5 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/block.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/block/block.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/block/block.ts)_ + +# block + +Returns the latest block (optionally sealed or not), by id, or by height + +## Import + +```typescript +import { block } from "@onflow/sdk" +``` + + +## Parameters + +### `options` (optional) +- Type: `BlockQueryOptions` + +```typescript +interface BlockQueryOptions { + sealed?: boolean + height?: number + id?: string +} +``` + +### `opts` (optional) +- Type: `object` +- Description: Optional parameters + + + +## Returns + +[`Promise`](../types#block) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/build.md b/docs/tools/clients/fcl-js/packages-docs/sdk/build.md new file mode 100644 index 0000000000..6c10372b0f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/build.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build.ts)_ + +# build + +A builder function that creates an interaction + +## Import + +```typescript +import { build } from "@onflow/sdk" +``` + + +## Parameters + +### `fns` (optional) +- Type: `(false | InteractionBuilderFn)[]` +- Description: The functions to apply to the interaction + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/buildPreSignable.md b/docs/tools/clients/fcl-js/packages-docs/sdk/buildPreSignable.md new file mode 100644 index 0000000000..20aa4737dd --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/buildPreSignable.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-accounts.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-accounts.ts)_ + +# buildPreSignable + + +## Import + +```typescript +import { buildPreSignable } from "@onflow/sdk" +``` + + +## Parameters + +### `acct` +- Type: [`InteractionAccount`](../types#interactionaccount) + + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`{ f_type: string; f_vsn: string; roles: { proposer: boolean; authorizer: boolean; payer: boolean; param?: boolean; }; cadence: string; args: any[]; data: {}; interaction: Interaction; voucher: { cadence: string; refBlock: string; computeLimit: number; arguments: any[]; proposalKey: { address: string; keyId: string | number; sequenceNum: number; } | { address?: undefined; keyId?: undefined; sequenceNum?: undefined; }; payer: string; authorizers: string[]; payloadSigs: { address: string; keyId: string | number; sig: string; }[]; envelopeSigs: { address: string; keyId: string | number; sig: string; }[]; }; }` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/buildSignable.md b/docs/tools/clients/fcl-js/packages-docs/sdk/buildSignable.md new file mode 100644 index 0000000000..27563a6fe8 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/buildSignable.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-signatures.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-signatures.ts)_ + +# buildSignable + + +## Import + +```typescript +import { buildSignable } from "@onflow/sdk" +``` + + +## Parameters + +### `acct` +- Type: [`InteractionAccount`](../types#interactionaccount) + + +### `message` +- Type: `string` + + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`{ f_type: string; f_vsn: string; message: string; addr: string; keyId: string | number; roles: { proposer: boolean; authorizer: boolean; payer: boolean; param?: boolean; }; cadence: string; args: any[]; data: {}; interaction: Interaction; voucher: { cadence: string; refBlock: string; computeLimit: number; arguments: any[]; proposalKey: { address: string; keyId: string | number; sequenceNum: number; } | { address?: undefined; keyId?: undefined; sequenceNum?: undefined; }; payer: string; authorizers: string[]; payloadSigs: { address: string; keyId: string | number; sig: string; }[]; envelopeSigs: { address: string; keyId: string | number; sig: string; }[]; }; }` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/cadence.md b/docs/tools/clients/fcl-js/packages-docs/sdk/cadence.md new file mode 100644 index 0000000000..48e17709c8 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/cadence.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/sdk.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/sdk.ts)_ + +# cadence + +Creates a template function + +## Import + +```typescript +import { cadence } from "@onflow/sdk" +``` + + +## Parameters + +### `head` +- Type: `string | TemplateStringsArray | ((x?: unknown) => string)` +- Description: - A string, template string array, or template function + + +### `rest` (optional) +- Type: `unknown[]` +- Description: - The rest of the arguments + + + +## Returns + +`(x?: unknown) => string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/cdc.md b/docs/tools/clients/fcl-js/packages-docs/sdk/cdc.md new file mode 100644 index 0000000000..e8ab00d96b --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/cdc.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/sdk.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/sdk.ts)_ + +# cdc + +Creates a template function + +## Import + +```typescript +import { cdc } from "@onflow/sdk" +``` + + +## Parameters + +### `head` +- Type: `string | TemplateStringsArray | ((x?: unknown) => string)` +- Description: - A string, template string array, or template function + + +### `rest` (optional) +- Type: `unknown[]` +- Description: - The rest of the arguments + + + +## Returns + +`(x?: unknown) => string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/config.md b/docs/tools/clients/fcl-js/packages-docs/sdk/config.md new file mode 100644 index 0000000000..4989cbcf0d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/config.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/sdk.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/sdk.ts)_ + +# config + +Sets the config + +## Import + +```typescript +import { config } from "@onflow/sdk" +``` + + +## Parameters + +### `values` (optional) +- Type: `Record` +- Description: - The values to set + + + +## Returns + +`object` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/createSignableVoucher.md b/docs/tools/clients/fcl-js/packages-docs/sdk/createSignableVoucher.md new file mode 100644 index 0000000000..e69028de8c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/createSignableVoucher.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/voucher.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/voucher.ts)_ + +# createSignableVoucher + + +## Import + +```typescript +import { createSignableVoucher } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`{ cadence: string; refBlock: string; computeLimit: number; arguments: any[]; proposalKey: { address: string; keyId: string | number; sequenceNum: number; } | { address?: undefined; keyId?: undefined; sequenceNum?: undefined; }; payer: string; authorizers: string[]; payloadSigs: { address: string; keyId: string | number; sig: string; }[]; envelopeSigs: { address: string; keyId: string | number; sig: string; }[]; }` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/decode.md b/docs/tools/clients/fcl-js/packages-docs/sdk/decode.md new file mode 100644 index 0000000000..27cf2d0886 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/decode.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/decode/sdk-decode.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/decode/sdk-decode.ts)_ + +# decode + + +## Import + +```typescript +import { decode } from "@onflow/sdk" +``` + + +## Parameters + +### `response` +- Type: `any` + + + +## Returns + +`Promise` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/decodeResponse.md b/docs/tools/clients/fcl-js/packages-docs/sdk/decodeResponse.md new file mode 100644 index 0000000000..a6f5c84961 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/decodeResponse.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/decode/decode.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/decode/decode.ts)_ + +# decodeResponse + + +## Import + +```typescript +import { decodeResponse } from "@onflow/sdk" +``` + + +## Parameters + +### `response` +- Type: `FlowResponse` + +```typescript +interface FlowResponse { + encodedData?: DecodeInstructions + transactionStatus?: FlowTransactionStatus + transaction?: any + events?: FlowBlockEvent[] + account?: any + block?: any + blockHeader?: any + blockDigest?: any + event?: any + accountStatusEvent?: any + latestBlock?: any + transactionId?: string + collection?: any + networkParameters?: { + chainId: string + } + streamConnection?: any + heartbeat?: any + nodeVersionInfo?: any +} +``` + +### `customDecoders` (optional) +- Type: `DecoderMap` + +```typescript +interface DecoderMap { + [key: string]: DecoderFunction +} +``` + + +## Returns + +`Promise` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/decodeStream.md b/docs/tools/clients/fcl-js/packages-docs/sdk/decodeStream.md new file mode 100644 index 0000000000..abcba13249 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/decodeStream.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/decode/decode-stream.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/decode/decode-stream.ts)_ + +# decodeStream + + +## Import + +```typescript +import { decodeStream } from "@onflow/sdk" +``` + + +## Parameters + +### `stream` +- Type: [`StreamConnection`](../types#streamconnection) + + +### `decodeResponse` +- Type: `DecodeResponseFn` + +```typescript +type DecodeResponseFn = ( + response: Record, + customDecoders?: Record +) => Promise +``` + +### `customDecoders` (optional) +- Type: `Record` + + + +## Returns + +[`StreamConnection`](../types#streamconnection) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/destroy.md b/docs/tools/clients/fcl-js/packages-docs/sdk/destroy.md new file mode 100644 index 0000000000..a4616ef23e --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/destroy.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# destroy + + +## Import + +```typescript +import { destroy } from "@onflow/sdk" +``` + + +## Parameters + +### `key` +- Type: `string` + + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/encodeMessageFromSignable.md b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeMessageFromSignable.md new file mode 100644 index 0000000000..974c57a44c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeMessageFromSignable.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/wallet-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/wallet-utils/index.ts)_ + +# encodeMessageFromSignable + + +## Import + +```typescript +import { encodeMessageFromSignable } from "@onflow/sdk" +``` + + +## Parameters + +### `signable` +- Type: `Signable` + +```typescript +interface Signable { + voucher: Voucher +} +``` + +### `signerAddress` +- Type: `string` + + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionEnvelope.md b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionEnvelope.md new file mode 100644 index 0000000000..fa95512ac1 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionEnvelope.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/encode/encode.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/encode/encode.ts)_ + +# encodeTransactionEnvelope + + +## Import + +```typescript +import { encodeTransactionEnvelope } from "@onflow/sdk" +``` + + +## Parameters + +### `tx` +- Type: [`Transaction`](../types#transaction) + + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionPayload.md b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionPayload.md new file mode 100644 index 0000000000..08a5537c72 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTransactionPayload.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/encode/encode.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/encode/encode.ts)_ + +# encodeTransactionPayload + + +## Import + +```typescript +import { encodeTransactionPayload } from "@onflow/sdk" +``` + + +## Parameters + +### `tx` +- Type: [`Transaction`](../types#transaction) + + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTxIdFromVoucher.md b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTxIdFromVoucher.md new file mode 100644 index 0000000000..eda3e734b9 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/encodeTxIdFromVoucher.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/encode/encode.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/encode/encode.ts)_ + +# encodeTxIdFromVoucher + + +## Import + +```typescript +import { encodeTxIdFromVoucher } from "@onflow/sdk" +``` + + +## Parameters + +### `voucher` +- Type: `Voucher` + +```typescript +export interface Voucher { + cadence: string + refBlock: string + computeLimit: number + arguments: VoucherArgument[] + proposalKey: VoucherProposalKey + payer: string + authorizers: string[] + payloadSigs: Sig[] + envelopeSigs: Sig[] +} +``` + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/findInsideSigners.md b/docs/tools/clients/fcl-js/packages-docs/sdk/findInsideSigners.md new file mode 100644 index 0000000000..bfd93e048d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/findInsideSigners.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/voucher.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/voucher.ts)_ + +# findInsideSigners + + +## Import + +```typescript +import { findInsideSigners } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`string[]` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/findOutsideSigners.md b/docs/tools/clients/fcl-js/packages-docs/sdk/findOutsideSigners.md new file mode 100644 index 0000000000..ca20afdf71 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/findOutsideSigners.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/voucher.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/voucher.ts)_ + +# findOutsideSigners + + +## Import + +```typescript +import { findOutsideSigners } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`string[]` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/get.md b/docs/tools/clients/fcl-js/packages-docs/sdk/get.md new file mode 100644 index 0000000000..ec7b4cdb53 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/get.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# get + + +## Import + +```typescript +import { get } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + +### `key` +- Type: `string` + + +### `fallback` (optional) +- Type: `any` + + + +## Returns + +`any` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getAccount.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getAccount.md new file mode 100644 index 0000000000..8711f75ec9 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getAccount.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-account.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-account.ts)_ + +# getAccount + +A builder function that returns the interaction to get an account by address + +## Import + +```typescript +import { getAccount } from "@onflow/sdk" +``` + + +## Parameters + +### `addr` +- Type: `string` +- Description: The address of the account to get + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getBlock.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getBlock.md new file mode 100644 index 0000000000..15f1e2489d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getBlock.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-block.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-block.ts)_ + +# getBlock + +A builder function that returns the interaction to get the latest block + +## Import + +```typescript +import { getBlock } from "@onflow/sdk" +``` + + +## Parameters + +### `isSealed` (optional) +- Type: `boolean` +- Description: Whether or not the block should be sealed + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getBlockHeader.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getBlockHeader.md new file mode 100644 index 0000000000..abdfc8d22c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getBlockHeader.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-block-header.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-block-header.ts)_ + +# getBlockHeader + +A builder function that returns the interaction to get a block header + +## Import + +```typescript +import { getBlockHeader } from "@onflow/sdk" +``` + + +## Parameters + +### `isSealed` (optional) +- Type: `boolean` +- Description: Whether or not the block should be sealed + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getCollection.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getCollection.md new file mode 100644 index 0000000000..38f624fada --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getCollection.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-collection.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-collection.ts)_ + +# getCollection + +A builder function that returns the interaction to get a collection by ID + +## Import + +```typescript +import { getCollection } from "@onflow/sdk" +``` + + +## Parameters + +### `id` (optional) +- Type: `string` +- Description: The ID of the collection to get + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getEvents.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getEvents.md new file mode 100644 index 0000000000..0ac40203d2 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getEvents.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-events.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-events.ts)_ + +# getEvents + +A builder function that returns the interaction to get events + +## Import + +```typescript +import { getEvents } from "@onflow/sdk" +``` + + +## Parameters + +### `eventType` +- Type: `string` +- Description: The type of event to get + + +### `start` +- Type: `number` +- Description: The start block ID or height + + +### `end` +- Type: `number` +- Description: The end block ID or height + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockHeightRange.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockHeightRange.md new file mode 100644 index 0000000000..336f0252d8 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockHeightRange.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-events-at-block-height-range.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-events-at-block-height-range.ts)_ + +# getEventsAtBlockHeightRange + +A builder function that returns the interaction to get events at a block height range + +## Import + +```typescript +import { getEventsAtBlockHeightRange } from "@onflow/sdk" +``` + + +## Parameters + +### `eventType` +- Type: `string` +- Description: The type of event to get + + +### `startHeight` +- Type: `number` +- Description: The start height of the block range + + +### `endHeight` +- Type: `number` +- Description: The end height of the block range + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockIds.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockIds.md new file mode 100644 index 0000000000..bc4cb01cb5 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getEventsAtBlockIds.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-events-at-block-ids.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-events-at-block-ids.ts)_ + +# getEventsAtBlockIds + +A builder function that returns the interaction to get events at specific block IDs + +## Import + +```typescript +import { getEventsAtBlockIds } from "@onflow/sdk" +``` + + +## Parameters + +### `eventType` +- Type: `string` +- Description: The type of event to get + + +### `blockIds` +- Type: `string[]` +- Description: The block IDs to get events from + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getLatestBlock.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getLatestBlock.md new file mode 100644 index 0000000000..35458caf99 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getLatestBlock.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-latest-block.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-latest-block.ts)_ + +# getLatestBlock + +A builder function that returns the interaction to get the latest block + +## Import + +```typescript +import { getLatestBlock } from "@onflow/sdk" +``` + + +## Parameters + +### `isSealed` (optional) +- Type: `boolean` +- Description: Whether or not the block should be sealed + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getNetworkParameters.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getNetworkParameters.md new file mode 100644 index 0000000000..a0ce1d82de --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getNetworkParameters.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-network-parameters.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-network-parameters.ts)_ + +# getNetworkParameters + +A builder function that returns the interaction to get network parameters + +## Import + +```typescript +import { getNetworkParameters } from "@onflow/sdk" +``` + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getNodeVersionInfo.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getNodeVersionInfo.md new file mode 100644 index 0000000000..d11847031b --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getNodeVersionInfo.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-node-version-info.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-node-version-info.ts)_ + +# getNodeVersionInfo + +A builder function for the Get Node Version Info interaction + +## Import + +```typescript +import { getNodeVersionInfo } from "@onflow/sdk" +``` + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getTransaction.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getTransaction.md new file mode 100644 index 0000000000..38e13bfd51 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getTransaction.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-transaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-transaction.ts)_ + +# getTransaction + +A builder function that returns the interaction to get a transaction by ID + +## Import + +```typescript +import { getTransaction } from "@onflow/sdk" +``` + + +## Parameters + +### `id` +- Type: `string` +- Description: The ID of the transaction to get + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getTransactionStatus.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getTransactionStatus.md new file mode 100644 index 0000000000..051ee0fb40 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getTransactionStatus.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-get-transaction-status.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-get-transaction-status.ts)_ + +# getTransactionStatus + +A builder function that returns the status of transaction +NOTE: The transactionID provided must be from the current spork. + +## Import + +```typescript +import { getTransactionStatus } from "@onflow/sdk" +``` + + +## Parameters + +### `transactionId` +- Type: `string` +- Description: The id of the transaction to get status + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/getTransport.md b/docs/tools/clients/fcl-js/packages-docs/sdk/getTransport.md new file mode 100644 index 0000000000..2a1ca4800c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/getTransport.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/transport/get-transport.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/transport/get-transport.ts)_ + +# getTransport + +Get the SDK transport object, either from the provided override or from the global config. + +## Import + +```typescript +import { getTransport } from "@onflow/sdk" +``` + + +## Parameters + +### `override` (optional) +- Type: `SdkTransport;` + + + +## Returns + +[`Promise`](../types#sdktransport) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/idof.md b/docs/tools/clients/fcl-js/packages-docs/sdk/idof.md new file mode 100644 index 0000000000..5190713a53 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/idof.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/index.ts)_ + +# idof + + +## Import + +```typescript +import { idof } from "@onflow/sdk" +``` + + +## Parameters + +### `acct` +- Type: [`InteractionAccount`](../types#interactionaccount) + + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/index.md b/docs/tools/clients/fcl-js/packages-docs/sdk/index.md new file mode 100644 index 0000000000..16b9e8214f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/index.md @@ -0,0 +1,150 @@ +--- +sidebar_position: 1 +title: "@onflow/sdk" +--- + +> _Doc autogenerated from [onflow/sdk](https://github.com/onflow/fcl-js/tree/master/packages/sdk)_ + +# @onflow/sdk + +## Overview + +The Flow sdk provides a set of tools for developers to build applications on the Flow blockchain. + +## Installation + +You can install the @onflow/sdk package using npm or yarn: + +```bash +npm install @onflow/sdk +``` + +Or using yarn: + +```bash +yarn add @onflow/sdk +``` + +### Requirements + +- Node.js 14.x or later + +### Importing + +You can import the entire package: + +```typescript +import * as sdk from "@onflow/sdk" +``` + +Or import specific functions: + +```typescript +import { functionName } from "@onflow/sdk" +``` + + +## API Reference + +This section contains documentation for all of the functions in the sdk package. + +- [account](./account.md) - Returns the details of an account from their public address +- [arg](./arg.md) - A utility builder to be used with fcl.args[...] to create FCL supported arguments for interactions +- [args](./args.md) - A utility builder to be used with other builders to pass in arguments with a value and supported type +- [atBlockHeight](./atBlockHeight.md) - A builder function that returns a partial interaction to a block at a specific height +- [atBlockId](./atBlockId.md) +- [atLatestBlock](./atLatestBlock.md) - A builder function that returns a partial interaction to query the latest block with the given finality state +- [authorization](./authorization.md) +- [authorizations](./authorizations.md) +- [authzDeepResolveMany](./authzDeepResolveMany.md) +- [authzFn](./authzFn.md) +- [authzResolve](./authzResolve.md) +- [authzResolveMany](./authzResolveMany.md) +- [Bad](./bad.md) +- [block](./block.md) - Returns the latest block (optionally sealed or not), by id, or by height +- [build](./build.md) - A builder function that creates an interaction +- [buildPreSignable](./buildPreSignable.md) +- [buildSignable](./buildSignable.md) +- [cadence](./cadence.md) - Creates a template function +- [cdc](./cdc.md) - Creates a template function +- [config](./config.md) - Sets the config +- [createSignableVoucher](./createSignableVoucher.md) +- [decode](./decode.md) +- [decodeResponse](./decodeResponse.md) +- [decodeStream](./decodeStream.md) +- [destroy](./destroy.md) +- [encodeMessageFromSignable](./encodeMessageFromSignable.md) +- [encodeTransactionEnvelope](./encodeTransactionEnvelope.md) +- [encodeTransactionPayload](./encodeTransactionPayload.md) +- [encodeTxIdFromVoucher](./encodeTxIdFromVoucher.md) +- [findInsideSigners](./findInsideSigners.md) +- [findOutsideSigners](./findOutsideSigners.md) +- [get](./get.md) +- [getAccount](./getAccount.md) - A builder function that returns the interaction to get an account by address +- [getBlock](./getBlock.md) - A builder function that returns the interaction to get the latest block +- [getBlockHeader](./getBlockHeader.md) - A builder function that returns the interaction to get a block header +- [getCollection](./getCollection.md) - A builder function that returns the interaction to get a collection by ID +- [getEvents](./getEvents.md) - A builder function that returns the interaction to get events +- [getEventsAtBlockHeightRange](./getEventsAtBlockHeightRange.md) - A builder function that returns the interaction to get events at a block height range +- [getEventsAtBlockIds](./getEventsAtBlockIds.md) - A builder function that returns the interaction to get events at specific block IDs +- [getLatestBlock](./getLatestBlock.md) - A builder function that returns the interaction to get the latest block +- [getNetworkParameters](./getNetworkParameters.md) - A builder function that returns the interaction to get network parameters +- [getNodeVersionInfo](./getNodeVersionInfo.md) - A builder function for the Get Node Version Info interaction +- [getTransaction](./getTransaction.md) - A builder function that returns the interaction to get a transaction by ID +- [getTransactionStatus](./getTransactionStatus.md) - A builder function that returns the status of transaction +NOTE: The transactionID provided must be from the current spork. +- [getTransport](./getTransport.md) - Get the SDK transport object, either from the provided override or from the global config. +- [idof](./idof.md) +- [initAccount](./initAccount.md) +- [initInteraction](./initInteraction.md) +- [interaction](./interaction.md) +- [isAccount](./isAccount.md) +- [isArgument](./isArgument.md) +- [isArray](./isArray.md) +- [isBad](./isBad.md) +- [isFn](./isFn.md) +- [isInteraction](./isInteraction.md) +- [isNull](./isNull.md) +- [isNumber](./isNumber.md) +- [isObj](./isObj.md) +- [isOk](./isOk.md) +- [limit](./limit.md) - A builder function that sets the compute limit for a transaction +- [makeArgument](./makeArgument.md) +- [nodeVersionInfo](./nodeVersionInfo.md) - Returns the version information from to connected node +- [Ok](./ok.md) +- [param](./param.md) +- [params](./params.md) +- [payer](./payer.md) - A builder function that adds payer account(s) to a transaction +- [ping](./ping.md) - A builder function that creates a ping interaction +- [pipe](./pipe.md) - Async pipe function to compose interactions +- [prepAccount](./prepAccount.md) +- [proposer](./proposer.md) +- [put](./put.md) +- [ref](./ref.md) - A builder function that sets the reference block for a transaction +- [resolveAccounts](./resolveAccounts.md) +- [resolveArguments](./resolveArguments.md) +- [resolveCadence](./resolveCadence.md) +- [resolveComputeLimit](./resolveComputeLimit.md) +- [resolveFinalNormalization](./resolveFinalNormalization.md) +- [resolveProposerSequenceNumber](./resolveProposerSequenceNumber.md) +- [resolveRefBlockId](./resolveRefBlockId.md) +- [resolveSignatures](./resolveSignatures.md) +- [resolveValidators](./resolveValidators.md) +- [resolveVoucherIntercept](./resolveVoucherIntercept.md) +- [response](./response.md) +- [run](./run.md) +- [script](./script.md) - A builder function that creates a script interaction +- [send](./send.md) +- [sig](./sig.md) +- [subscribe](./subscribe.md) - Subscribe to a topic and decode the data. +- [subscribeEvents](./subscribeEvents.md) - Subscribe to events with the given filter & parameters +- [subscribeRaw](./subscribeRaw.md) - Subscribe to a topic without decoding the data. +- [transaction](./transaction.md) - A template builder to use a Cadence transaction for an interaction +- [update](./update.md) +- [validateSignableTransaction](./validateSignableTransaction.md) +- [validator](./validator.md) - A builder function that adds a validator to a transaction +- [voucherIntercept](./voucherIntercept.md) - A builder function that intercepts and modifies a voucher +- [voucherToTxId](./voucherToTxId.md) +- [why](./why.md) + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/initAccount.md b/docs/tools/clients/fcl-js/packages-docs/sdk/initAccount.md new file mode 100644 index 0000000000..de95042572 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/initAccount.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# initAccount + + +## Import + +```typescript +import { initAccount } from "@onflow/sdk" +``` + + + +## Returns + +[`InteractionAccount`](../types#interactionaccount) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/initInteraction.md b/docs/tools/clients/fcl-js/packages-docs/sdk/initInteraction.md new file mode 100644 index 0000000000..baa1641bbc --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/initInteraction.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# initInteraction + + +## Import + +```typescript +import { initInteraction } from "@onflow/sdk" +``` + + + +## Returns + +[`Interaction`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/interaction.md b/docs/tools/clients/fcl-js/packages-docs/sdk/interaction.md new file mode 100644 index 0000000000..61c986eee3 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/interaction.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# interaction + + +## Import + +```typescript +import { interaction } from "@onflow/sdk" +``` + + + +## Returns + +[`Interaction`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isAccount.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isAccount.md new file mode 100644 index 0000000000..d25f2dadc1 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isAccount.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isAccount + + +## Import + +```typescript +import { isAccount } from "@onflow/sdk" +``` + + +## Parameters + +### `account` +- Type: `Record` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isArgument.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isArgument.md new file mode 100644 index 0000000000..d004a76786 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isArgument.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isArgument + + +## Import + +```typescript +import { isArgument } from "@onflow/sdk" +``` + + +## Parameters + +### `argument` +- Type: `Record` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isArray.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isArray.md new file mode 100644 index 0000000000..353a9f3921 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isArray.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isArray + + +## Import + +```typescript +import { isArray } from "@onflow/sdk" +``` + + +## Parameters + +### `d` +- Type: `any` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isBad.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isBad.md new file mode 100644 index 0000000000..b0731d2602 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isBad.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isBad + + +## Import + +```typescript +import { isBad } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isFn.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isFn.md new file mode 100644 index 0000000000..5c161db2b1 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isFn.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isFn + + +## Import + +```typescript +import { isFn } from "@onflow/sdk" +``` + + +## Parameters + +### `d` +- Type: `any` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isInteraction.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isInteraction.md new file mode 100644 index 0000000000..a10382fe6e --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isInteraction.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isInteraction + + +## Import + +```typescript +import { isInteraction } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: `unknown` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isNull.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isNull.md new file mode 100644 index 0000000000..f419694d5f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isNull.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isNull + + +## Import + +```typescript +import { isNull } from "@onflow/sdk" +``` + + +## Parameters + +### `d` +- Type: `any` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isNumber.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isNumber.md new file mode 100644 index 0000000000..35a80caaed --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isNumber.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isNumber + + +## Import + +```typescript +import { isNumber } from "@onflow/sdk" +``` + + +## Parameters + +### `d` +- Type: `any` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isObj.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isObj.md new file mode 100644 index 0000000000..32f0897c4d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isObj.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isObj + + +## Import + +```typescript +import { isObj } from "@onflow/sdk" +``` + + +## Parameters + +### `d` +- Type: `any` + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/isOk.md b/docs/tools/clients/fcl-js/packages-docs/sdk/isOk.md new file mode 100644 index 0000000000..3fd355059a --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/isOk.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# isOk + + +## Import + +```typescript +import { isOk } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/limit.md b/docs/tools/clients/fcl-js/packages-docs/sdk/limit.md new file mode 100644 index 0000000000..e871ff7f38 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/limit.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-limit.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-limit.ts)_ + +# limit + +A builder function that sets the compute limit for a transaction + +## Import + +```typescript +import { limit } from "@onflow/sdk" +``` + + +## Parameters + +### `limit` +- Type: `number` +- Description: The compute limit to set + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/makeArgument.md b/docs/tools/clients/fcl-js/packages-docs/sdk/makeArgument.md new file mode 100644 index 0000000000..1280ce1098 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/makeArgument.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# makeArgument + + +## Import + +```typescript +import { makeArgument } from "@onflow/sdk" +``` + + +## Parameters + +### `arg` +- Type: `Record` + + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/nodeVersionInfo.md b/docs/tools/clients/fcl-js/packages-docs/sdk/nodeVersionInfo.md new file mode 100644 index 0000000000..c09e04bd81 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/nodeVersionInfo.md @@ -0,0 +1,30 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/node-version-info/node-version-info.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/node-version-info/node-version-info.ts)_ + +# nodeVersionInfo + +Returns the version information from to connected node + +## Import + +```typescript +import { nodeVersionInfo } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` (optional) +- Type: `any` + + + +## Returns + +[`Promise`](../types#nodeversioninfo) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/ok.md b/docs/tools/clients/fcl-js/packages-docs/sdk/ok.md new file mode 100644 index 0000000000..c24b86f215 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/ok.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# Ok + + +## Import + +```typescript +import { Ok } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Interaction`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/param.md b/docs/tools/clients/fcl-js/packages-docs/sdk/param.md new file mode 100644 index 0000000000..9a4b0650a2 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/param.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/sdk.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/sdk.ts)_ + +# param + + +## Import + +```typescript +import { param } from "@onflow/sdk" +``` + + +## Parameters + +### `params` +- Type: `never` + + + +## Returns + +`Promise | ((...args: unknown[]) => Promise)` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/params.md b/docs/tools/clients/fcl-js/packages-docs/sdk/params.md new file mode 100644 index 0000000000..f36c7ff674 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/params.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/sdk.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/sdk.ts)_ + +# params + + +## Import + +```typescript +import { params } from "@onflow/sdk" +``` + + +## Parameters + +### `params` +- Type: `never` + + + +## Returns + +`Promise | ((...args: unknown[]) => Promise)` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/payer.md b/docs/tools/clients/fcl-js/packages-docs/sdk/payer.md new file mode 100644 index 0000000000..f405eeacf2 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/payer.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-payer.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-payer.ts)_ + +# payer + +A builder function that adds payer account(s) to a transaction + +## Import + +```typescript +import { payer } from "@onflow/sdk" +``` + + +## Parameters + +### `ax` (optional) +- Type: `AccountAuthorization[]` +- Description: An account address or array of account addresses + +```typescript +export type AccountAuthorization = + | (AuthorizationFn & Partial) + | Partial +``` + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/ping.md b/docs/tools/clients/fcl-js/packages-docs/sdk/ping.md new file mode 100644 index 0000000000..0cee625608 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/ping.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-ping.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-ping.ts)_ + +# ping + +A builder function that creates a ping interaction + +## Import + +```typescript +import { ping } from "@onflow/sdk" +``` + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/pipe.md b/docs/tools/clients/fcl-js/packages-docs/sdk/pipe.md new file mode 100644 index 0000000000..a235ca2548 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/pipe.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# pipe + + +## Import + +```typescript +import { pipe } from "@onflow/sdk" +``` + + +## Parameters + +### `args` (optional) +- Type: `[(false | InteractionBuilderFn)[]] | [MaybePromise, (false | InteractionBuilderFn)[]]` + + + +## Returns + +`InteractionBuilderFn | Promise` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/prepAccount.md b/docs/tools/clients/fcl-js/packages-docs/sdk/prepAccount.md new file mode 100644 index 0000000000..1e4dedf63c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/prepAccount.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# prepAccount + + +## Import + +```typescript +import { prepAccount } from "@onflow/sdk" +``` + + +## Parameters + +### `acct` +- Type: `AccountAuthorization` + +```typescript +export type AccountAuthorization = + | (AuthorizationFn & Partial) + | Partial +``` + +### `opts` (optional) +- Type: `IPrepAccountOpts` + +```typescript +interface IPrepAccountOpts { + role?: TransactionRole | null +} +``` + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/proposer.md b/docs/tools/clients/fcl-js/packages-docs/sdk/proposer.md new file mode 100644 index 0000000000..eeecf5f4a1 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/proposer.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-proposer.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-proposer.ts)_ + +# proposer + + +## Import + +```typescript +import { proposer } from "@onflow/sdk" +``` + + +## Parameters + +### `authz` +- Type: `AccountAuthorization` + +```typescript +export type AccountAuthorization = + | (AuthorizationFn & Partial) + | Partial +``` + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/put.md b/docs/tools/clients/fcl-js/packages-docs/sdk/put.md new file mode 100644 index 0000000000..b77f038109 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/put.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# put + + +## Import + +```typescript +import { put } from "@onflow/sdk" +``` + + +## Parameters + +### `key` +- Type: `string` + + +### `value` +- Type: `any` + + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/ref.md b/docs/tools/clients/fcl-js/packages-docs/sdk/ref.md new file mode 100644 index 0000000000..02383f357f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/ref.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-ref.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-ref.ts)_ + +# ref + +A builder function that sets the reference block for a transaction + +## Import + +```typescript +import { ref } from "@onflow/sdk" +``` + + +## Parameters + +### `refBlock` +- Type: `string` +- Description: The reference block ID + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveAccounts.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveAccounts.md new file mode 100644 index 0000000000..77c676b63c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveAccounts.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-accounts.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-accounts.ts)_ + +# resolveAccounts + + +## Import + +```typescript +import { resolveAccounts } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + +### `opts` (optional) +- Type: `Record` + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveArguments.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveArguments.md new file mode 100644 index 0000000000..7ba1a0af1d --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveArguments.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-arguments.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-arguments.ts)_ + +# resolveArguments + + +## Import + +```typescript +import { resolveArguments } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveCadence.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveCadence.md new file mode 100644 index 0000000000..ee23505f61 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveCadence.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-cadence.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-cadence.ts)_ + +# resolveCadence + + +## Import + +```typescript +import { resolveCadence } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveComputeLimit.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveComputeLimit.md new file mode 100644 index 0000000000..8ec5963b19 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveComputeLimit.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-compute-limit.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-compute-limit.ts)_ + +# resolveComputeLimit + + +## Import + +```typescript +import { resolveComputeLimit } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveFinalNormalization.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveFinalNormalization.md new file mode 100644 index 0000000000..d3fdf5dbdc --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveFinalNormalization.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-final-normalization.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-final-normalization.ts)_ + +# resolveFinalNormalization + + +## Import + +```typescript +import { resolveFinalNormalization } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveProposerSequenceNumber.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveProposerSequenceNumber.md new file mode 100644 index 0000000000..a7cefac438 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveProposerSequenceNumber.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-proposer-sequence-number.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-proposer-sequence-number.ts)_ + +# resolveProposerSequenceNumber + + +## Import + +```typescript +import { resolveProposerSequenceNumber } from "@onflow/sdk" +``` + + +## Parameters + +### `options` +- Type: `NodeConfig` + +```typescript +interface NodeConfig { + node: string +} +``` + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveRefBlockId.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveRefBlockId.md new file mode 100644 index 0000000000..d02887c3e5 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveRefBlockId.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-ref-block-id.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-ref-block-id.ts)_ + +# resolveRefBlockId + + +## Import + +```typescript +import { resolveRefBlockId } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` (optional) +- Type: `object` + + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveSignatures.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveSignatures.md new file mode 100644 index 0000000000..7102744c6a --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveSignatures.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-signatures.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-signatures.ts)_ + +# resolveSignatures + + +## Import + +```typescript +import { resolveSignatures } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveValidators.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveValidators.md new file mode 100644 index 0000000000..ea262e36ac --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveValidators.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-validators.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-validators.ts)_ + +# resolveValidators + + +## Import + +```typescript +import { resolveValidators } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/resolveVoucherIntercept.md b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveVoucherIntercept.md new file mode 100644 index 0000000000..58881f967e --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/resolveVoucherIntercept.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/resolve-voucher-intercept.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/resolve-voucher-intercept.ts)_ + +# resolveVoucherIntercept + + +## Import + +```typescript +import { resolveVoucherIntercept } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/response.md b/docs/tools/clients/fcl-js/packages-docs/sdk/response.md new file mode 100644 index 0000000000..9e2b906ba7 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/response.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/response/response.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/response/response.ts)_ + +# response + + +## Import + +```typescript +import { response } from "@onflow/sdk" +``` + + + +## Returns + +`object` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/run.md b/docs/tools/clients/fcl-js/packages-docs/sdk/run.md new file mode 100644 index 0000000000..f525d11083 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/run.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/run.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/run.ts)_ + +# run + + +## Import + +```typescript +import { run } from "@onflow/sdk" +``` + + +## Parameters + +### `fns` (optional) +- Type: `((ix: Interaction) => Interaction | Promise)[]` + + + +## Returns + +[`Promise`](../types#interaction) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/script.md b/docs/tools/clients/fcl-js/packages-docs/sdk/script.md new file mode 100644 index 0000000000..b3ac1053fd --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/script.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-script.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-script.ts)_ + +# script + +A builder function that creates a script interaction + +## Import + +```typescript +import { script } from "@onflow/sdk" +``` + + +## Parameters + +### `args` (optional) +- Type: `[string | TemplateStringsArray | ((x?: unknown) => string), ...unknown[]]` + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/send.md b/docs/tools/clients/fcl-js/packages-docs/sdk/send.md new file mode 100644 index 0000000000..903d3be11a --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/send.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/transport/send/send.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/transport/send/send.ts)_ + +# send + + +## Import + +```typescript +import { send } from "@onflow/sdk" +``` + + +## Parameters + +### `args` (optional) +- Type: `false | Function | (false | Function)[]` + + +### `opts` (optional) +- Type: `any` + + + +## Returns + +`Promise` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/sig.md b/docs/tools/clients/fcl-js/packages-docs/sdk/sig.md new file mode 100644 index 0000000000..f0cfa4818c --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/sig.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/test-utils/index.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/test-utils/index.ts)_ + +# sig + + +## Import + +```typescript +import { sig } from "@onflow/sdk" +``` + + +## Parameters + +### `opts` +- Type: [`InteractionAccount`](../types#interactionaccount) + + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/subscribe.md b/docs/tools/clients/fcl-js/packages-docs/sdk/subscribe.md new file mode 100644 index 0000000000..ed581c367e --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/subscribe.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/transport/subscribe/subscribe.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/transport/subscribe/subscribe.ts)_ + +# subscribe + +Subscribe to a topic and decode the data. + +## Import + +```typescript +import { subscribe } from "@onflow/sdk" +``` + + +## Parameters + +### `options` +- Type: `SubscribeParams` + +```typescript +export type SubscribeParams = { + topic: T + args: SubscriptionArgs + onData: (data: SubscriptionData) => void + onError: (error: Error) => void +} +``` + +### `opts` (optional) +- Type: `SdkTransport;` +- Description: - Additional options for the subscription. + + + +## Returns + +[`Subscription`](../types#subscription) + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/subscribeEvents.md b/docs/tools/clients/fcl-js/packages-docs/sdk/subscribeEvents.md new file mode 100644 index 0000000000..d50405f9ae --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/subscribeEvents.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-subscribe-events.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-subscribe-events.ts)_ + +# subscribeEvents + +Subscribe to events with the given filter & parameters + +## Import + +```typescript +import { subscribeEvents } from "@onflow/sdk" +``` + + +## Parameters + +### `options` +- Type: [`EventFilter`](../types#eventfilter) + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/subscribeRaw.md b/docs/tools/clients/fcl-js/packages-docs/sdk/subscribeRaw.md new file mode 100644 index 0000000000..1e61b38656 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/subscribeRaw.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/transport/subscribe/subscribe-raw.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/transport/subscribe/subscribe-raw.ts)_ + +# subscribeRaw + +Subscribe to a topic without decoding the data. + +## Import + +```typescript +import { subscribeRaw } from "@onflow/sdk" +``` + + +## Parameters + +### `options` +- Type: `SubscribeRawParams` + +```typescript +export type SubscribeRawParams = { + topic: T + args: SubscriptionArgs + onData: (data: RawSubscriptionData) => void + onError: (error: Error) => void +} +``` + +### `opts` (optional) +- Type: `SdkTransport;` +- Description: - Additional options for the subscription. + + + +## Returns + +`object` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/transaction.md b/docs/tools/clients/fcl-js/packages-docs/sdk/transaction.md new file mode 100644 index 0000000000..d462830395 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/transaction.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-transaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-transaction.ts)_ + +# transaction + +A template builder to use a Cadence transaction for an interaction + +## Import + +```typescript +import { transaction } from "@onflow/sdk" +``` + + +## Parameters + +### `args` (optional) +- Type: `[string | TemplateStringsArray, ...any[]]` +- Description: The arguments to pass + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/update.md b/docs/tools/clients/fcl-js/packages-docs/sdk/update.md new file mode 100644 index 0000000000..669fad3b4b --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/update.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# update + + +## Import + +```typescript +import { update } from "@onflow/sdk" +``` + + +## Parameters + +### `key` +- Type: `string` + + +### `fn` (optional) +- Type: `(v: T | T[], ...args: any[]) => T | T[]` + + + +## Returns + +`function` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/validateSignableTransaction.md b/docs/tools/clients/fcl-js/packages-docs/sdk/validateSignableTransaction.md new file mode 100644 index 0000000000..9325088dea --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/validateSignableTransaction.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/wallet-utils/validate-tx.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/wallet-utils/validate-tx.ts)_ + +# validateSignableTransaction + + +## Import + +```typescript +import { validateSignableTransaction } from "@onflow/sdk" +``` + + +## Parameters + +### `signable` +- Type: `Signable` + +```typescript +interface Signable { + voucher: Voucher +} +``` + + +## Returns + +`boolean` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/validator.md b/docs/tools/clients/fcl-js/packages-docs/sdk/validator.md new file mode 100644 index 0000000000..7a77d0145f --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/validator.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-validator.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-validator.ts)_ + +# validator + +A builder function that adds a validator to a transaction + +## Import + +```typescript +import { validator } from "@onflow/sdk" +``` + + +## Parameters + +### `cb` +- Type: `Function` +- Description: The validator function + + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/voucherIntercept.md b/docs/tools/clients/fcl-js/packages-docs/sdk/voucherIntercept.md new file mode 100644 index 0000000000..72f624f9ed --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/voucherIntercept.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/build/build-voucher-intercept.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/build/build-voucher-intercept.ts)_ + +# voucherIntercept + +A builder function that intercepts and modifies a voucher + +## Import + +```typescript +import { voucherIntercept } from "@onflow/sdk" +``` + + +## Parameters + +### `fn` +- Type: `VoucherInterceptFn` +- Description: The function to intercept and modify the voucher + +```typescript +type VoucherInterceptFn = (voucher: Voucher) => any | Promise +``` + + +## Returns + +`InteractionBuilderFn` + +```typescript +export type InteractionBuilderFn = ( + ix: Interaction +) => Interaction | Promise +``` + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/voucherToTxId.md b/docs/tools/clients/fcl-js/packages-docs/sdk/voucherToTxId.md new file mode 100644 index 0000000000..56a82debed --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/voucherToTxId.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/resolve/voucher.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/resolve/voucher.ts)_ + +# voucherToTxId + + +## Import + +```typescript +import { voucherToTxId } from "@onflow/sdk" +``` + + +## Parameters + +### `voucher` +- Type: `Voucher` + +```typescript +export interface Voucher { + cadence: string + refBlock: string + computeLimit: number + arguments: VoucherArgument[] + proposalKey: VoucherProposalKey + payer: string + authorizers: string[] + payloadSigs: Sig[] + envelopeSigs: Sig[] +} +``` + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/sdk/why.md b/docs/tools/clients/fcl-js/packages-docs/sdk/why.md new file mode 100644 index 0000000000..2dde036a6e --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/sdk/why.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 1 +--- + +> _Doc autogenerated from [onflow/sdk/src/interaction/interaction.ts](https://github.com/onflow/fcl-js/tree/master/packages/sdk/src/interaction/interaction.ts)_ + +# why + + +## Import + +```typescript +import { why } from "@onflow/sdk" +``` + + +## Parameters + +### `ix` +- Type: [`Interaction`](../types#interaction) + + + +## Returns + +`string` + + +--- \ No newline at end of file diff --git a/docs/tools/clients/fcl-js/packages-docs/types/index.md b/docs/tools/clients/fcl-js/packages-docs/types/index.md new file mode 100644 index 0000000000..2cf78ad0b3 --- /dev/null +++ b/docs/tools/clients/fcl-js/packages-docs/types/index.md @@ -0,0 +1,510 @@ +--- +title: Type Definitions +description: Type definitions for the Flow Client Library (FCL). +--- + +> _Doc autogenerated from [onflow/typedefs](https://github.com/onflow/fcl-js/tree/master/packages/typedefs)_ + +# Type Definitions + +Documentation for core types used throughout the Flow Client Library (FCL). + +## Interfaces + +### Account + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `address` | `string` | The address of the account | +| `balance` | `number` | The FLOW balance of the account in 10^8 | +| `code` | `number` | The code of any Cadence contracts stored in the account | +| `contracts` | `Record` | Any contracts deployed to this account | +| `keys` | `AccountKey[]` | The keys associated with the account | + +### AccountKey + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `index` | `number` | The index of the key in the account | +| `publicKey` | `string` | The public key of the account key | +| `signAlgo` | `SignatureAlgorithm` | The signature algorithm used by the key | +| `signAlgoString` | `string` | The signature algorithm used by the key as a string | +| `hashAlgo` | `HashAlgorithm` | The hashing algorithm used by the key | +| `hashAlgoString` | `string` | The hashing algorithm used by the key as a string | +| `sequenceNumber` | `number` | The sequence number of the key | +| `weight` | `number` | The weight of the key | +| `revoked` | `boolean` | Whether or not the key has been revoked | + +### AccountStatusEvent + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `accountAddress` | `string` | The address of the account which the event is associated with. | + +### Block + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | `string` | The id of the block | +| `parentId` | `string` | The id of the parent block | +| `height` | `number` | The height of the block | +| `timestamp` | `string` | Time related fields | +| `parentVoterSignature` | `string` | The parent voter signature of the block | +| `collectionGuarantees` | `CollectionGuarantee[]` | Contains the ids of collections included in the block | +| `blockSeals` | `BlockSeal[]` | The details of which nodes executed and sealed the blocks | + +### BlockDigest +BlockDigest holds lightweight block information which includes only block id, block height and block timestamp. + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | `string` | The id of the block | +| `height` | `number` | The height of the block | +| `timestamp` | `string` | Timestamp of the block | + +### BlockHeader +Header contains all meta-data for a block, as well as a hash representing +the combined payload of the entire block. It is what consensus nodes agree +on after validating the contents against the payload hash. + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | `string` | The id of the block | +| `parentId` | `string` | The id of the parent block | +| `height` | `number` | The height of the block | +| `timestamp` | `string` | The timestamp of the block | +| `parentVoterSignature` | `string` | The parent voter signature of the block | + +### BlockHeartbeat + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `blockId` | `string` | | +| `blockHeight` | `number` | | +| `timestamp` | `string` | | + +### BlockSeal + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `blockId` | `string` | The id of the block | +| `executionReceiptId` | `string` | The execution receipt id of the block | + +### CollectionGuarantee + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `collectionId` | `string` | The id of the block | +| `signerIds` | `string[]` | The signer ids of the block | + +### CompositeSignature + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `f_type` | `string` | A type identifier used internally by FCL | +| `f_vsn` | `string` | FCL protocol version | +| `addr` | `string` | Flow Address (sans prefix) | +| `keyId` | `number` | Key ID | +| `signature` | `string` | Signature as a hex string | + +### CurrentUser + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `addr` | `string` | The public address of the current user | +| `cid` | `string` | A wallet specified content identifier for user metadata | +| `expiresAt` | `number` | A wallet specified time-frame for a valid session | +| `f_type` | `string` | A type identifier used internally by FCL | +| `f_vsn` | `string` | FCL protocol version | +| `loggedIn` | `boolean` | Whether or not the current user is logged in | +| `services` | `Service[]` | A list of trusted services that express ways of interacting with the current user's identity | + +### Event + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `blockId` | `string` | ID of the block that contains the event. | +| `blockHeight` | `number` | Height of the block that contains the event. | +| `blockTimestamp` | `string` | The timestamp of when the block was sealed in a DateString format. eg. '2021-06-25T13:42:04.227Z' | +| `type` | `string` | A string containing the event name. | +| `transactionId` | `string` | Can be used to query transaction information, eg. via a Flow block explorer. | +| `transactionIndex` | `number` | Used to prevent replay attacks. | +| `eventIndex` | `number` | Used to prevent replay attacks. | +| `data` | `any` | The data emitted from the event. | + +### EventFilter + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `eventTypes` | `string[]` | | +| `addresses` | `string[]` | | +| `contracts` | `string[]` | | +| `startBlockId` | `string` | | +| `startHeight` | `number` | | +| `heartbeatInterval` | `number` | | + +### Interaction + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `tag` | `InteractionTag` | | +| `assigns` | `Record` | | +| `status` | `InteractionStatus` | | +| `reason` | `string` | | +| `accounts` | `Record` | | +| `params` | `Record` | | +| `arguments` | `Record` | | +| `message` | `{ cadence: string; refBlock: string; computeLimit: number; proposer: string; payer: string; authorizations: string[]; params: Record[]; arguments: string[]; }` | | +| `proposer` | `string` | | +| `authorizations` | `string[]` | | +| `payer` | `string[]` | | +| `events` | `{ eventType: string; start: string \| number; end: string \| number; blockIds: string[]; }` | | +| `transaction` | `{ id: string; }` | | +| `block` | `{ id: string; height: string \| number; isSealed: boolean; }` | | +| `account` | `{ addr: string; }` | | +| `collection` | `{ id: string; }` | | +| `subscribeEvents` | `{ eventTypes: string[]; addresses: string[]; contracts: string[]; startBlockId: string; startHeight: number; heartbeatInterval: number; }` | | + +### InteractionAccount + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `kind` | `InteractionResolverKind.ACCOUNT` | | +| `tempId` | `string` | | +| `addr` | `string` | | +| `keyId` | `string \| number` | | +| `sequenceNum` | `number` | | +| `signature` | `string` | | +| `signingFunction` | `any` | | +| `resolve` | `any` | | +| `role` | `{ proposer: boolean; authorizer: boolean; payer: boolean; param?: boolean; }` | | +| `authorization` | `any` | | + +### Key + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `sequenceNumber` | `number` | Sequence number of key used by the proposer of this transaction | +| `keyId` | `number` | The ID of the key in the account used by the proposer of this transaction | +| `address` | `string` | The address of the proposer of this transaction | + +### NodeVersionInfo + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `semver` | `string` | The semver version of the node. | +| `commit` | `string` | The commit hash of the node. | +| `sporkId` | `string` | The spork id of the node. | +| `protocolVersion` | `number` | The protocol version of the node. | +| `sporkRootBlockHeight` | `number` | The spork root block height of the node. | +| `nodeRootBlockHeight` | `number` | The node root block height of the node. | + +### Provider + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `address` | `string` | The blockchain address of the Wallet provider. | +| `name` | `string` | The name of the Wallet provider. | +| `icon` | `string` | The icon of the Wallet provider (may be a URL or a data URI). | +| `description` | `string` | A brief description of the Wallet provider. | +| `color` | `string` | The preferred color to represent the Wallet provider (e.g., for UI styling). | +| `supportEmail` | `string` | The support email address of the Wallet provider. | +| `website` | `string` | The website URL of the Wallet provider. | +| `is_installed` | `boolean` | Indicates whether the Wallet provider is installed (if applicable). | + +### Service + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `f_type` | `string` | A type identifier used internally by FCL | +| `f_vsn` | `string` | FCL protocol version | +| `type` | `string` | Service type | +| `method` | `string` | Service method | +| `uid` | `string` | Service uid | +| `endpoint` | `string` | Service endpoint | +| `provider` | `Provider` | Service provider object | +| `params` | `Record` | | + +### Signature + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `sequenceNumber` | `string` | Sequence number of the key used to perform this signature. | +| `keyId` | `number` | ID of the key in the account used to perform this signature. | +| `signature` | `string` | The signature represented as a hex string. | + +### StreamConnection + + +### Transaction + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `script` | `string` | The Cadence code used to execute this transaction. | +| `args` | `string[]` | The JSON-CDC encoded arguments passed in to the transaction. | +| `referenceBlockId` | `string` | The reference block id for this transaction. | +| `gasLimit` | `number` | The gas limit for the transaction. | +| `proposalKey` | `Key` | The key used by the proposer of this transaction. | +| `sequenceNumber` | `string` | Sequence number of the key used by the proposer of this transaction. | +| `keyId` | `number` | The ID of the key in the account used by the proposer of this transaction. | +| `address` | `string` | The address of the proposer of this transaction. | +| `payer` | `string` | Address of the payer of the transaction. | +| `proposer` | `string` | Address of the proposer of this transaction. | +| `authorizers` | `string[]` | Array of addresses of authorizers of this transaction. | +| `payloadSignatures` | `Signature[]` | The payload signatures for the transaction. | +| `envelopeSignatures` | `Signature[]` | The envelope signatures for the transaction. | + +### TransactionStatus + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `blockId` | `string` | The ID of the Block the transaction is included in. | +| `status` | `TransactionExecutionStatus` | The execution status of the transaction | +| `statusString` | `string` | The status as as descriptive text (e.g. "FINALIZED"). | +| `statusCode` | `0 \| 1` | The result of the transaction, if executed (i.e. 0 for success, 1 for failure) | +| `errorMessage` | `string` | The error message of the transaction. | +| `events` | `Event[]` | The events for this result. | + + +## Types + +### EventStream + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `on` | `{ (channel: C, listener: (data: { events: Event[]; heartbeat: BlockHeartbeat; }[C]) => void): EventStream; (event: "close", listener: () => void): EventStream; (event: "error", listener: (err: any) => void): EventStream; }` | | +| `off` | `{ (event: C, listener: (data: { events: Event[]; heartbeat: BlockHeartbeat; }[C]) => void): EventStream; (event: "close", listener: () => void): EventStream; (event: "error", listener: (err: any) => void): EventStream; }` | | +| `close` | `() => void` | | + +### RawSubscriptionData + + +### SdkTransport + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `send` | `SendFn` | | +| `subscribe` | `SubscribeFn` | | + +### Subscription + +**Properties:** + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `unsubscribe` | `() => void` | | + +### SubscriptionArgs + + +### SubscriptionData + + + +## Enums + +### FvmErrorCode + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `UNKNOWN_ERROR` | -1 | | +| `TX_VALIDATION_ERROR` | 1000 | | +| `INVALID_TX_BYTE_SIZE_ERROR` | 1001 | | +| `INVALID_REFERENCE_BLOCK_ERROR` | 1002 | | +| `EXPIRED_TRANSACTION_ERROR` | 1003 | | +| `INVALID_SCRIPT_ERROR` | 1004 | | +| `INVALID_GAS_LIMIT_ERROR` | 1005 | | +| `INVALID_PROPOSAL_SIGNATURE_ERROR` | 1006 | | +| `INVALID_PROPOSAL_SEQ_NUMBER_ERROR` | 1007 | | +| `INVALID_PAYLOAD_SIGNATURE_ERROR` | 1008 | | +| `INVALID_ENVELOPE_SIGNATURE_ERROR` | 1009 | | +| `FVM_INTERNAL_ERROR` | 1050 | | +| `VALUE_ERROR` | 1051 | | +| `INVALID_ARGUMENT_ERROR` | 1052 | | +| `INVALID_ADDRESS_ERROR` | 1053 | | +| `INVALID_LOCATION_ERROR` | 1054 | | +| `ACCOUNT_AUTHORIZATION_ERROR` | 1055 | | +| `OPERATION_AUTHORIZATION_ERROR` | 1056 | | +| `OPERATION_NOT_SUPPORTED_ERROR` | 1057 | | +| `BLOCK_HEIGHT_OUT_OF_RANGE_ERROR` | 1058 | | +| `EXECUTION_ERROR` | 1100 | | +| `CADENCE_RUNTIME_ERROR` | 1101 | | +| `ENCODING_UNSUPPORTED_VALUE` | 1102 | | +| `STORAGE_CAPACITY_EXCEEDED` | 1103 | | +| `GAS_LIMIT_EXCEEDED_ERROR` | 1104 | | +| `EVENT_LIMIT_EXCEEDED_ERROR` | 1105 | | +| `LEDGER_INTERACTION_LIMIT_EXCEEDED_ERROR` | 1106 | | +| `STATE_KEY_SIZE_LIMIT_ERROR` | 1107 | | +| `STATE_VALUE_SIZE_LIMIT_ERROR` | 1108 | | +| `TRANSACTION_FEE_DEDUCTION_FAILED_ERROR` | 1109 | | +| `COMPUTATION_LIMIT_EXCEEDED_ERROR` | 1110 | | +| `MEMORY_LIMIT_EXCEEDED_ERROR` | 1111 | | +| `COULD_NOT_DECODE_EXECUTION_PARAMETER_FROM_STATE` | 1112 | | +| `SCRIPT_EXECUTION_TIMED_OUT_ERROR` | 1113 | | +| `SCRIPT_EXECUTION_CANCELLED_ERROR` | 1114 | | +| `EVENT_ENCODING_ERROR` | 1115 | | +| `INVALID_INTERNAL_STATE_ACCESS_ERROR` | 1116 | | +| `INSUFFICIENT_PAYER_BALANCE` | 1118 | | +| `ACCOUNT_ERROR` | 1200 | | +| `ACCOUNT_NOT_FOUND_ERROR` | 1201 | | +| `ACCOUNT_PUBLIC_KEY_NOT_FOUND_ERROR` | 1202 | | +| `ACCOUNT_ALREADY_EXISTS_ERROR` | 1203 | | +| `FROZEN_ACCOUNT_ERROR` | 1204 | | +| `ACCOUNT_STORAGE_NOT_INITIALIZED_ERROR` | 1205 | | +| `ACCOUNT_PUBLIC_KEY_LIMIT_ERROR` | 1206 | | +| `CONTRACT_ERROR` | 1250 | | +| `CONTRACT_NOT_FOUND_ERROR` | 1251 | | +| `CONTRACT_NAMES_NOT_FOUND_ERROR` | 1252 | | +| `EVM_EXECUTION_ERROR` | 1300 | | + +### HashAlgorithm + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `SHA2_256` | 1 | | +| `SHA2_384` | 2 | | +| `SHA3_256` | 3 | | +| `SHA3_384` | 4 | | +| `KMAC128_BLS_BLS12_381` | 5 | | + +### InteractionResolverKind + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `ARGUMENT` | "ARGUMENT" | | +| `ACCOUNT` | "ACCOUNT" | | + +### InteractionStatus + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `BAD` | "BAD" | | +| `OK` | "OK" | | + +### InteractionTag + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `UNKNOWN` | "UNKNOWN" | | +| `SCRIPT` | "SCRIPT" | | +| `TRANSACTION` | "TRANSACTION" | | +| `GET_TRANSACTION_STATUS` | "GET_TRANSACTION_STATUS" | | +| `GET_ACCOUNT` | "GET_ACCOUNT" | | +| `GET_EVENTS` | "GET_EVENTS" | | +| `PING` | "PING" | | +| `GET_TRANSACTION` | "GET_TRANSACTION" | | +| `GET_BLOCK` | "GET_BLOCK" | | +| `GET_BLOCK_HEADER` | "GET_BLOCK_HEADER" | | +| `GET_COLLECTION` | "GET_COLLECTION" | | +| `GET_NETWORK_PARAMETERS` | "GET_NETWORK_PARAMETERS" | | +| `SUBSCRIBE_EVENTS` | "SUBSCRIBE_EVENTS" | | +| `GET_NODE_VERSION_INFO` | "GET_NODE_VERSION_INFO" | | + +### SignatureAlgorithm + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `ECDSA_P256` | 1 | | +| `ECDSA_secp256k1` | 2 | | +| `BLS_BLS12_381` | 3 | | + +### SubscriptionTopic + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `BLOCKS` | "blocks" | | +| `BLOCK_HEADERS` | "block_headers" | | +| `BLOCK_DIGESTS` | "block_digests" | | +| `ACCOUNT_STATUSES` | "account_statuses" | | +| `TRANSACTION_STATUSES` | "transaction_statuses" | | +| `EVENTS` | "events" | | + +### TransactionExecutionStatus +The execution status of the transaction. + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `UNKNOWN` | 0 | | +| `PENDING` | 1 | | +| `FINALIZED` | 2 | | +| `EXECUTED` | 3 | | +| `SEALED` | 4 | | +| `EXPIRED` | 5 | | + +### TransactionRole + +**Members:** + +| Name | Value | Description | +| ---- | ----- | ----------- | +| `AUTHORIZER` | "authorizer" | | +| `PAYER` | "payer" | | +| `PROPOSER` | "proposer" | | + + +--- +_Doc autogenerated from [onflow/typedefs](https://github.com/onflow/fcl-js/tree/master/packages/typedefs)_ \ No newline at end of file