@solana/instructions 2.0.0-experimental.b8df7b4

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Solana Labs, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+[![npm][npm-image]][npm-url]
+[![npm-downloads][npm-downloads-image]][npm-url]
+[![semantic-release][semantic-release-image]][semantic-release-url]
+<br />
+[![code-style-prettier][code-style-prettier-image]][code-style-prettier-url]
+
+[code-style-prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
+[code-style-prettier-url]: https://github.com/prettier/prettier
+[npm-downloads-image]: https://img.shields.io/npm/dm/@solana/instructions/experimental.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/@solana/instructions/experimental.svg?style=flat
+[npm-url]: https://www.npmjs.com/package/@solana/instructions/v/experimental
+[semantic-release-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
+[semantic-release-url]: https://github.com/semantic-release/semantic-release
+
+# @solana/instructions
+
+This package contains types for creating transaction instructions. It can be used standalone, but it is also exported as part of the Solana JavaScript SDK [`@solana/web3.js@experimental`](https://github.com/solana-labs/solana-web3.js/tree/master/packages/library).
+
+## Types
+
+### `IAccountMeta<TAddress>`
+
+This type represents an account's address and metadata about its mutability and whether it must be a signer of the transaction.
+
+Typically, you will use one of its subtypes.
+
+|                                   | `isSigner` | `isWritable` |
+| --------------------------------- | ---------- | ------------ |
+| `ReadonlyAccount<TAddress>`       | &#x274c;   | &#x274c;     |
+| `WritableAccount<TAddress>`       | &#x274c;   | &#x2705;     |
+| `ReadonlySignerAccount<TAddress>` | &#x2705;   | &#x274c;     |
+| `WritableSignerAccount<TAddress>` | &#x2705;   | &#x2705;     |
+
+For example, you could type the rent sysvar account like this:
+
+```ts
+type RentSysvar = ReadonlyAccount<'SysvarRent111111111111111111111111111111111'>;
+```
+
+### `Instruction<TProgramAddress, TAccounts, TData>`
+
+Use this to define the structure of a transaction instruction.
+
+```ts
+type InitializeStakeInstruction = Instruction<
+    // Program address
+    'StakeConfig11111111111111111111111111111111',
+    // Accounts
+    [
+        WritableAccount, // Stake account
+        RentSysvar
+    ],
+    // Data
+    InitializeStakeInstructionData
+>;
+```
+
+Instructions that do not require data may omit the `TData` type parameter.

package/dist/index.browser.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.browser.cjs.map

package/dist/index.browser.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/index.browser.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/index.development.js

@@ -0,0 +1,8 @@
+(function () {
+	'use strict';
+
+
+
+})();
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.development.js.map

package/dist/index.development.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/index.native.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.native.js.map

package/dist/index.native.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/index.node.cjs

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.node.cjs.map

package/dist/index.node.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/index.node.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.node.js.map

package/dist/index.node.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/dist/index.production.min.js

@@ -0,0 +1,6 @@
+(function () {
+	'use strict';
+
+
+
+})();

package/dist/types/accounts.d.ts

@@ -0,0 +1,35 @@
+import { Base58EncodedAddress } from '@solana/keys';
+export interface IAccountMeta<TAddress extends string = string> {
+    readonly address: Base58EncodedAddress<TAddress>;
+    readonly isSigner: boolean;
+    readonly isWritable: boolean;
+}
+export type ReadonlyAccount<TAddress extends string = string> = IAccountMeta<TAddress> & Readonly<{
+    isSigner: false;
+    isWritable: false;
+}>;
+export type WritableAccount<TAddress extends string = string> = IAccountMeta<TAddress> & Readonly<{
+    isSigner: false;
+    isWritable: true;
+}>;
+export type ReadonlySignerAccount<TAddress extends string = string> = IAccountMeta<TAddress> & Readonly<{
+    isSigner: true;
+    isWritable: false;
+}>;
+export type WritableSignerAccount<TAddress extends string = string> = IAccountMeta<TAddress> & Readonly<{
+    isSigner: true;
+    isWritable: true;
+}>;
+export interface IAccountLookupMeta<TAddress extends string = string, TLookupTableAddress extends string = string> {
+    readonly address: Base58EncodedAddress<TAddress>;
+    readonly addressIndex: number;
+    readonly lookupTableAddress: Base58EncodedAddress<TLookupTableAddress>;
+    readonly isWritable: boolean;
+}
+export type ReadonlyAccountLookup<TAddress extends string = string, TLookupTableAddress extends string = string> = IAccountLookupMeta<TAddress, TLookupTableAddress> & Readonly<{
+    isWritable: false;
+}>;
+export type WritableAccountLookup<TAddress extends string = string, TLookupTableAddress extends string = string> = IAccountLookupMeta<TAddress, TLookupTableAddress> & Readonly<{
+    isWritable: true;
+}>;
+//# sourceMappingURL=accounts.d.ts.map

package/dist/types/accounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/accounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,WAAW,YAAY,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM;IAC1D,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACjD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,GAClF,QAAQ,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AACrD,MAAM,MAAM,eAAe,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,GAClF,QAAQ,CAAC;IAAE,QAAQ,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC;AACpD,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,GACxF,QAAQ,CAAC;IAAE,QAAQ,EAAE,IAAI,CAAC;IAAC,UAAU,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AACpD,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,GACxF,QAAQ,CAAC;IAAE,QAAQ,EAAE,IAAI,CAAC;IAAC,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC;AAEnD,MAAM,WAAW,kBAAkB,CAAC,QAAQ,SAAS,MAAM,GAAG,MAAM,EAAE,mBAAmB,SAAS,MAAM,GAAG,MAAM;IAC7G,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACjD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IACvE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,qBAAqB,CAC7B,QAAQ,SAAS,MAAM,GAAG,MAAM,EAChC,mBAAmB,SAAS,MAAM,GAAG,MAAM,IAC3C,kBAAkB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CAAC;IAAE,UAAU,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AACxF,MAAM,MAAM,qBAAqB,CAC7B,QAAQ,SAAS,MAAM,GAAG,MAAM,EAChC,mBAAmB,SAAS,MAAM,GAAG,MAAM,IAC3C,kBAAkB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CAAC;IAAE,UAAU,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './accounts';
+export * from './instruction';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC"}

package/dist/types/instruction.d.ts

@@ -0,0 +1,14 @@
+import { Base58EncodedAddress } from '@solana/keys';
+import { IAccountLookupMeta, IAccountMeta } from './accounts';
+export interface IInstruction<TProgramAddress extends string = string> {
+    readonly accounts?: readonly (IAccountMeta | IAccountLookupMeta)[];
+    readonly data?: Uint8Array;
+    readonly programAddress: Base58EncodedAddress<TProgramAddress>;
+}
+export interface IInstructionWithAccounts<TAccounts extends readonly (IAccountMeta | IAccountLookupMeta)[]> extends IInstruction {
+    readonly accounts: TAccounts;
+}
+export interface IInstructionWithData<TData extends Uint8Array> extends IInstruction {
+    readonly data: TData;
+}
+//# sourceMappingURL=instruction.d.ts.map

package/dist/types/instruction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instruction.d.ts","sourceRoot":"","sources":["../../src/instruction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE9D,MAAM,WAAW,YAAY,CAAC,eAAe,SAAS,MAAM,GAAG,MAAM;IACjE,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,YAAY,GAAG,kBAAkB,CAAC,EAAE,CAAC;IACnE,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,cAAc,EAAE,oBAAoB,CAAC,eAAe,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,wBAAwB,CAAC,SAAS,SAAS,SAAS,CAAC,YAAY,GAAG,kBAAkB,CAAC,EAAE,CACtG,SAAQ,YAAY;IACpB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB,CAAC,KAAK,SAAS,UAAU,CAAE,SAAQ,YAAY;IAChF,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;CACxB"}

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@solana/instructions",
+  "version": "2.0.0-experimental.b8df7b4",
+  "description": "Helpers for creating transaction instructions",
+  "exports": {
+    "browser": {
+      "import": "./dist/index.browser.js",
+      "require": "./dist/index.browser.cjs"
+    },
+    "node": {
+      "import": "./dist/index.node.js",
+      "require": "./dist/index.node.cjs"
+    },
+    "react-native": "./dist/index.native.js",
+    "types": "./dist/types/index.d.ts"
+  },
+  "browser": {
+    "./dist/index.node.cjs": "./dist/index.browser.cjs",
+    "./dist/index.node.js": "./dist/index.browser.js"
+  },
+  "main": "./dist/index.node.cjs",
+  "module": "./dist/index.node.js",
+  "react-native": "./dist/index.native.js",
+  "types": "./dist/types/index.d.ts",
+  "type": "module",
+  "files": [
+    "./dist/"
+  ],
+  "sideEffects": false,
+  "keywords": [
+    "blockchain",
+    "solana",
+    "web3"
+  ],
+  "author": "Solana Labs Maintainers <maintainers@solanalabs.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/solana-labs/solana-web3.js"
+  },
+  "bugs": {
+    "url": "http://github.com/solana-labs/solana-web3.js/issues"
+  },
+  "browserslist": [
+    "supports bigint and not dead",
+    "maintained node versions"
+  ],
+  "devDependencies": {
+    "@solana/eslint-config-solana": "^1.0.0",
+    "@swc/core": "^1.3.18",
+    "@swc/jest": "^0.2.23",
+    "@types/jest": "^29.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.1",
+    "@typescript-eslint/parser": "^5.57.1",
+    "agadoo": "^3.0.0",
+    "eslint": "^8.37.0",
+    "eslint-plugin-sort-keys-fix": "^1.1.2",
+    "jest": "^29.5.0",
+    "jest-runner-eslint": "^2.0.0",
+    "jest-runner-prettier": "^1.0.0",
+    "postcss": "^8.4.12",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.9.1",
+    "tsup": "6.7.0",
+    "typescript": "^5.0.3",
+    "version-from-git": "^1.1.1",
+    "@solana/keys": "2.0.0-development",
+    "build-scripts": "0.0.0",
+    "test-config": "0.0.0",
+    "tsconfig": "0.0.0"
+  },
+  "bundlewatch": {
+    "defaultCompression": "gzip",
+    "files": [
+      {
+        "path": "./dist/index*.js"
+      }
+    ]
+  },
+  "scripts": {
+    "compile:js": "tsup --config build-scripts/tsup.config.library.ts",
+    "compile:typedefs": "tsc -p ./tsconfig.declarations.json",
+    "dev": "jest -c node_modules/test-config/jest-dev.config.ts --rootDir . --watch",
+    "publish-packages": "pnpm publish --tag experimental --access public --no-git-checks",
+    "test:lint": "jest -c node_modules/test-config/jest-lint.config.ts --rootDir . --silent",
+    "test:prettier": "jest -c node_modules/test-config/jest-prettier.config.ts --rootDir . --silent",
+    "test:treeshakability:browser": "agadoo dist/index.browser.js",
+    "test:treeshakability:native": "agadoo dist/index.node.js",
+    "test:treeshakability:node": "agadoo dist/index.native.js",
+    "test:typecheck": "tsc --noEmit"
+  }
+}