@solana/web3.js 2.0.0-experimental.cc1b7bb → 2.0.0-experimental.d6c5c0e

package/README.md

@@ -0,0 +1,98 @@
+[![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/web3.js/experimental.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/@solana/web3.js/experimental.svg?style=flat
+[npm-url]: https://www.npmjs.com/package/@solana/web3.js/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
+
+# Experimental Solana JavaScript SDK
+
+Use this to interact with accounts and programs on the Solana network through the Solana [JSON-RPC API](https://docs.solana.com/apps/jsonrpc-api).
+
+**This library is experimental**. It is unsuitable for production use, because the API is unstable and may change without warning. If you want to build a production Solana application, use the [1.x branch](https://www.npmjs.com/package/@solana/web3.js).
+
+## Installation
+
+### For use in Node.js, React Native, or a web application
+
+```shell
+npm install --save @solana/web3.js@experimental
+```
+
+### For use in a browser, without a build system
+
+```html
+<!-- Development (debug mode, unminified) -->
+<script src="https://unpkg.com/@solana/web3.js@experimental/dist/index.development.js"></script>
+
+<!-- Production (minified) -->
+<script src="https://unpkg.com/@solana/web3.js@experimental/dist/index.production.min.js"></script>
+```
+
+## Usage
+
+There are 3 main applications of this library.
+
+1. **RPC**. Solana apps interact with the network by calling methods on the Solana JSON-RPC.
+2. **Transactions**. Solana apps interact with Solana program by building and sending transactions.
+3. **Keys**. People use cryptographic keys to verify the provenance of messages and to attest to the ownership of their accounts.
+
+### RPC
+
+First, configure your connection to an RPC server. This might be a server that you host, one that you lease, or one of the limited-use [public RPC servers](https://docs.solana.com/cluster/rpc-endpoints).
+
+```ts
+import { createDefaultRpcTransport } from '@solana/web3.js';
+const devnetTransport = createDefaultRpcTransport({ url: 'https://api.devnet.solana.com' });
+```
+
+Second, construct an RPC instance that uses that transport.
+
+```ts
+const devnetRpc = createSolanaRpc({ transport: devnetTransport });
+```
+
+Now, you can use it to call methods on your RPC server. For instance, here is how you would fetch an account's balance.
+
+```ts
+const balanceInLamports = await devnetRpc.getBalance('11111111111111111111111111111111' as Base58EncodedAddress);
+console.log('Balance of account 11111111111111111111111111111111 in Lamports', balanceInLamports);
+```
+
+### Transactions
+
+Unimplemented.
+
+### Keys
+
+#### Addresses and public keys
+
+Client applications primarily deal with addresses and public keys in the form of base58-encoded strings. Addresses and public keys returned from the RPC API conform to the type `Base58EncodedAddress`. You can use a value of that type wherever a base58-encoded address or key is expected.
+
+From time to time you might acquire a string, that you expect to validate as an address, from an untrusted network API or user input. To assert that such an arbitrary string is a base58-encoded address, use the `assertIsBase58EncodedAddress` function.
+
+```ts
+import { assertIsBase58EncodedAddress } from '@solana/web3.js`;
+
+// Imagine a function that fetches an account's balance when a user submits a form.
+function handleSubmit() {
+  // We know only that what the user typed conforms to the `string` type.
+  const address: string = accountAddressInput.value;
+  try {
+    // If this type assertion function doesn't throw, then
+    // Typescript will upcast `address` to `Base58EncodedAddress`.
+    assertIsBase58EncodedAddress(address);
+    // At this point, `address` is a `Base58EncodedAddress` that can be used with the RPC.
+    const balanceInLamports = await rpc.getBalance(address);
+  } catch (e) {
+    // `address` turned out not to be a base58-encoded address
+  }
+}
+```

package/dist/index.browser.cjs

@@ -75,3 +75,5 @@ Object.keys(keys).forEach(function (k) {
     get: function () { return keys[k]; }
   });
 });
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.browser.cjs.map

package/dist/index.node.cjs

@@ -75,5 +75,3 @@ Object.keys(keys).forEach(function (k) {
     get: function () { return keys[k]; }
   });
 });
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.node.cjs.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,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC;AACtB,cAAc,iBAAiB,CAAC"}

package/dist/types/rpc-default-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-default-config.d.ts","sourceRoot":"","sources":["../../src/rpc-default-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAGtD,eAAO,MAAM,kBAAkB,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAIhF,CAAC"}

package/dist/types/rpc-integer-overflow-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-integer-overflow-error.d.ts","sourceRoot":"","sources":["../../src/rpc-integer-overflow-error.ts"],"names":[],"mappings":"AAAA,qBAAa,iCAAkC,SAAQ,KAAK;IACxD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;gBACX,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM;IA+B3E,IAAI,IAAI,WAEP;CACJ"}

package/dist/types/rpc-transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc-transport.d.ts","sourceRoot":"","sources":["../../src/rpc-transport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,6DAA6D,CAAC;AAe5F,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAAG,aAAa,CAW1G"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.d.ts","sourceRoot":"","sources":["../../src/rpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAsB,MAAM,kBAAkB,CAAC;AAGxE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iDAAiD,CAAC;AAE3E,wBAAgB,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,gBAAgB,CAAC,CAK/G"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/web3.js",
-  "version": "2.0.0-experimental.cc1b7bb",
+  "version": "2.0.0-experimental.d6c5c0e",
   "description": "Solana Javascript API",
   "exports": {
     "browser": {
@@ -49,9 +49,9 @@
     "maintained node versions"
   ],
   "dependencies": {
-    "@solana/keys": "2.0.0-experimental.cc1b7bb",
-    "@solana/rpc-core": "2.0.0-experimental.cc1b7bb",
-    "@solana/rpc-transport": "2.0.0-experimental.cc1b7bb"
+    "@solana/keys": "2.0.0-experimental.d6c5c0e",
+    "@solana/rpc-core": "2.0.0-development",
+    "@solana/rpc-transport": "2.0.0-experimental.d6c5c0e"
   },
   "devDependencies": {
     "@solana/eslint-config-solana": "^1.0.0",